You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/terraform/customize/property-customization.mdx
+21Lines changed: 21 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -153,6 +153,27 @@ components:
153
153
x-speakeasy-param-sensitive: true
154
154
```
155
155
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
+
156
177
## Deprecation
157
178
158
179
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