EphemeralWriteOnly
: Initial support for MMv1 Generation in schema & docs
#12550
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Goal of this PR is to include
WriteOnly
property as part of generation to support the upcoming Ephemeral WriteOnly Attributes in Terraform 1.11We add a new field titled
write_only
that includesWriteOnly
in the schema of any field withwrite_only: true
Some things to know:
The generation will fail when
write_only: true
is set with any of the following:sensitive
(write_only attributes are meant to replace sensitive values in the future)default_from_api
/output
set properties to be Computed + Optional which we do not support for ephemeral write-only attributesIt's also worth noting that
flatteners
are not needed as write-onlys will not be saved to state.This PR also introduces
WriteOnlyProperties
that's needed to separate the Ephemeral Write-Only Attributes from a resource into it's own section when generation documentation (similar to how we have arguments and attributes. A new section will be introduced under the nameEphemeral Attributes Reference