Skip to content

Commit

Permalink
add dev doc for tf:"suppress_diff", tf:"force_new" and `tf:"sensi…
Browse files Browse the repository at this point in the history
…tive"` tags (#1465)
  • Loading branch information
nkvuong committed Jul 15, 2022
1 parent 8064876 commit f5badab
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,9 @@ Some interesting points to note here:
* `default:X` to set a default value for a field
* `max_items:N` to set the maximum number of items for a multi-valued parameter
* `slice_set` to indicate that a the parameter should accept a set instead of a list
* `sensitive` to mark a field as sensitive and prevent Terraform from showing its value in the plan or apply output
* `force_new` to indicate a change in this value requires the replacement (destroy and create) of the resource
* `suppress_diff` to allow comparison based on something other than primitive, list or map equality, either via a `CustomizeDiffFunc`, or the default diff for the type of the schema
* Do not use bare references to structs in the model; rather, use pointers to structs. Maps and slices are permitted, as well as the following primitive types: int, int32, int64, float64, bool, string.
See `typeToSchema` in `common/reflect_resource.go` for the up-to-date list of all supported field types and values for the `tf` tag.

Expand Down

0 comments on commit f5badab

Please sign in to comment.