Skip to content

Commit eda0d2d

Browse files
committed
Sync open source content 🐝 (from 94e1c29afb509d5abbd809501a75b3ad2334742d)
1 parent 901b121 commit eda0d2d

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

β€Ždocs/terraform/customize/property-customization.mdxβ€Ž

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,27 @@ components:
153153
x-speakeasy-param-sensitive: true
154154
```
155155

156+
## Write only
157+
158+
Mark a schema attribute as a [write only argument](https://developer.hashicorp.com/terraform/plugin/framework/resources/write-only-arguments) (`WriteOnly: true` in the schema definition) with the `x-speakeasy-terraform-write-only` extension. Write only functionality prevents values from ever being exposed in plan or state data as a more complete secret value solution over sensitive attributes.
159+
160+
<Callout title="Warning" type="warning">
161+
Write only functionality is only supported in Terraform/OpenTofu 1.11 and later. Using it on earlier versions of Terraform/OpenTofu will result in a configuration error.
162+
</Callout>
163+
164+
```yaml
165+
components:
166+
schemas:
167+
Pet:
168+
type: object
169+
properties:
170+
name:
171+
type: string
172+
secret:
173+
type: string
174+
x-speakeasy-terraform-write-only: true
175+
```
176+
156177
## Deprecation
157178

158179
Add OAS `deprecated: true` within a property to automatically return a warning diagnostic with a generic deprecation message when the property is configured in Terraform. Customize the messaging with the OAS `x-speakeasy-deprecation-message` extension.

0 commit comments

Comments
Β (0)