Skip to content

Commit 132c771

Browse files
authored
Add Callout for PreferWriteOnlyAttribute() validator in documentation (#1105)
* Add callout for PreferWriteOnlyAttribute validators in the documentation * Update wording
1 parent 1d90a21 commit 132c771

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

website/docs/plugin/framework/resources/write-only-arguments.mdx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,13 @@ retrieving values from configuration.
5353

5454
## PreferWriteOnlyAttribute Validators
5555

56+
<Note>
57+
58+
These validators will produce persistent warnings for practitioners on every Terraform run as long as the specified non-write-only attribute
59+
has a value in the configuration. The validators will also produce warnings for users of shared modules who cannot immediately take action on the warning.
60+
61+
</Note>
62+
5663
The `PreferWriteOnlyAttribute()` validators available in the [`terraform-plugin-framework-validators` Go module](https://pkg.go.dev/github.com/hashicorp/terraform-plugin-framework-validators)
5764
can be used when you have a write-only version of an existing attribute, and you want to encourage practitioners to use the write-only version whenever possible.
5865

0 commit comments

Comments
 (0)