Skip to content

Commit e210315

Browse files
SBGoodsSBGoods
committed
Add website documentation
1 parent 2b72dc0 commit e210315

File tree

19 files changed

+316
-0
lines changed

19 files changed

+316
-0
lines changed

‎website/data/plugin-framework-nav-data.json‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,10 @@
9898
{
9999
"title": "Timeouts",
100100
"path": "resources/timeouts"
101+
},
102+
{
103+
"title": "Write-only Arguments",
104+
"path": "resources/write-only-arguments"
101105
}
102106
]
103107
},

‎website/docs/plugin/framework/handling-data/attributes/bool.mdx‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,18 @@ The [`boolplanmodifier`](https://pkg.go.dev/github.com/hashicorp/terraform-plugi
104104

105105
Set the `Sensitive` field if the attribute value should always be considered [sensitive data](/terraform/language/state/sensitive-data). In Terraform, this will generally mask the value in practitioner output. This setting cannot be conditionally set and does not impact how data is stored in the state.
106106

107+
### WriteOnly
108+
109+
<Highlight>
110+
111+
Only managed resources implement this concept.
112+
113+
</Highlight>
114+
115+
Set the `WriteOnly` field to define a [write-only argument](/terraform/plugin/framework/resources/write-only-arguments).
116+
Write-only arguments can accept [ephemeral values](/terraform/language/resources/ephemeral)
117+
and are not persisted in the Terraform plan or state artifacts. Write-only arguments are supported in Terraform 1.11 and later.
118+
107119
### Validation
108120

109121
Set the `Validators` field to define [validation](/terraform/plugin/framework/validation#attribute-validation). This validation logic is ran in addition to any validation contained within a [custom type](#custom-types).

‎website/docs/plugin/framework/handling-data/attributes/dynamic.mdx‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,18 @@ The [`dynamicplanmodifier`](https://pkg.go.dev/github.com/hashicorp/terraform-pl
134134

135135
Set the `Sensitive` field if the attribute value should always be considered [sensitive data](/terraform/language/state/sensitive-data). In Terraform, this will generally mask the value in practitioner output. This setting cannot be conditionally set and does not impact how data is stored in the state.
136136

137+
### WriteOnly
138+
139+
<Highlight>
140+
141+
Only managed resources implement this concept.
142+
143+
</Highlight>
144+
145+
Set the `WriteOnly` field to define a [write-only argument](/terraform/plugin/framework/resources/write-only-arguments).
146+
Write-only arguments can accept [ephemeral values](/terraform/language/resources/ephemeral)
147+
and are not persisted in the Terraform plan or state artifacts. Write-only arguments are supported in Terraform 1.11 and later.
148+
137149
### Validation
138150

139151
Set the `Validators` field to define [validation](/terraform/plugin/framework/validation#attribute-validation). This validation logic is ran in addition to any validation contained within a [custom type](#custom-types).

‎website/docs/plugin/framework/handling-data/attributes/float32.mdx‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,18 @@ The [`float32planmodifier`](https://pkg.go.dev/github.com/hashicorp/terraform-pl
110110

111111
Set the `Sensitive` field if the attribute value should always be considered [sensitive data](/terraform/language/state/sensitive-data). In Terraform, this will generally mask the value in practitioner output. This setting cannot be conditionally set and does not impact how data is stored in the state.
112112

113+
### WriteOnly
114+
115+
<Highlight>
116+
117+
Only managed resources implement this concept.
118+
119+
</Highlight>
120+
121+
Set the `WriteOnly` field to define a [write-only argument](/terraform/plugin/framework/resources/write-only-arguments).
122+
Write-only arguments can accept [ephemeral values](/terraform/language/resources/ephemeral)
123+
and are not persisted in the Terraform plan or state artifacts. Write-only arguments are supported in Terraform 1.11 and later.
124+
113125
### Validation
114126

115127
Set the `Validators` field to define [validation](/terraform/plugin/framework/validation#attribute-validation). This validation logic is ran in addition to any validation contained within a [custom type](#custom-types).

‎website/docs/plugin/framework/handling-data/attributes/float64.mdx‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,18 @@ The [`float64planmodifier`](https://pkg.go.dev/github.com/hashicorp/terraform-pl
110110

111111
Set the `Sensitive` field if the attribute value should always be considered [sensitive data](/terraform/language/state/sensitive-data). In Terraform, this will generally mask the value in practitioner output. This setting cannot be conditionally set and does not impact how data is stored in the state.
112112

113+
### WriteOnly
114+
115+
<Highlight>
116+
117+
Only managed resources implement this concept.
118+
119+
</Highlight>
120+
121+
Set the `WriteOnly` field to define a [write-only argument](/terraform/plugin/framework/resources/write-only-arguments).
122+
Write-only arguments can accept [ephemeral values](/terraform/language/resources/ephemeral)
123+
and are not persisted in the Terraform plan or state artifacts. Write-only arguments are supported in Terraform 1.11 and later.
124+
113125
### Validation
114126

115127
Set the `Validators` field to define [validation](/terraform/plugin/framework/validation#attribute-validation). This validation logic is ran in addition to any validation contained within a [custom type](#custom-types).

‎website/docs/plugin/framework/handling-data/attributes/int32.mdx‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,18 @@ The [`int32planmodifier`](https://pkg.go.dev/github.com/hashicorp/terraform-plug
110110

111111
Set the `Sensitive` field if the attribute value should always be considered [sensitive data](/terraform/language/state/sensitive-data). In Terraform, this will generally mask the value in practitioner output. This setting cannot be conditionally set and does not impact how data is stored in the state.
112112

113+
### WriteOnly
114+
115+
<Highlight>
116+
117+
Only managed resources implement this concept.
118+
119+
</Highlight>
120+
121+
Set the `WriteOnly` field to define a [write-only argument](/terraform/plugin/framework/resources/write-only-arguments).
122+
Write-only arguments can accept [ephemeral values](/terraform/language/resources/ephemeral)
123+
and are not persisted in the Terraform plan or state artifacts. Write-only arguments are supported in Terraform 1.11 and later.
124+
113125
### Validation
114126

115127
Set the `Validators` field to define [validation](/terraform/plugin/framework/validation#attribute-validation). This validation logic is ran in addition to any validation contained within a [custom type](#custom-types).

‎website/docs/plugin/framework/handling-data/attributes/int64.mdx‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,18 @@ The [`int64planmodifier`](https://pkg.go.dev/github.com/hashicorp/terraform-plug
110110

111111
Set the `Sensitive` field if the attribute value should always be considered [sensitive data](/terraform/language/state/sensitive-data). In Terraform, this will generally mask the value in practitioner output. This setting cannot be conditionally set and does not impact how data is stored in the state.
112112

113+
### WriteOnly
114+
115+
<Highlight>
116+
117+
Only managed resources implement this concept.
118+
119+
</Highlight>
120+
121+
Set the `WriteOnly` field to define a [write-only argument](/terraform/plugin/framework/resources/write-only-arguments).
122+
Write-only arguments can accept [ephemeral values](/terraform/language/resources/ephemeral)
123+
and are not persisted in the Terraform plan or state artifacts. Write-only arguments are supported in Terraform 1.11 and later.
124+
113125
### Validation
114126

115127
Set the `Validators` field to define [validation](/terraform/plugin/framework/validation#attribute-validation). This validation logic is ran in addition to any validation contained within a [custom type](#custom-types).

‎website/docs/plugin/framework/handling-data/attributes/list-nested.mdx‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -159,6 +159,20 @@ The [`listplanmodifier`](https://pkg.go.dev/github.com/hashicorp/terraform-plugi
159159

160160
Set the `Sensitive` field if the attribute value should always be considered [sensitive data](/terraform/language/state/sensitive-data). In Terraform, this will generally mask the value in practitioner output. This setting cannot be conditionally set and does not impact how data is stored in the state.
161161

162+
### WriteOnly
163+
164+
<Highlight>
165+
166+
Only managed resources implement this concept.
167+
168+
</Highlight>
169+
170+
Set the `WriteOnly` field to define a [write-only argument](/terraform/plugin/framework/resources/write-only-arguments).
171+
Write-only arguments can accept [ephemeral values](/terraform/language/resources/ephemeral)
172+
and are not persisted in the Terraform plan or state artifacts. Write-only arguments are supported in Terraform 1.11 and later.
173+
174+
If a nested attribute has the `WriteOnly` field set, all child attributes must also have `WriteOnly` set.
175+
162176
### Validation
163177

164178
Set the `Validators` field to define [validation](/terraform/plugin/framework/validation#attribute-validation). This validation logic is ran in addition to any validation contained within a [custom type](#custom-types).

‎website/docs/plugin/framework/handling-data/attributes/list.mdx‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,18 @@ The [`listplanmodifier`](https://pkg.go.dev/github.com/hashicorp/terraform-plugi
128128

129129
Set the `Sensitive` field if the attribute value should always be considered [sensitive data](/terraform/language/state/sensitive-data). In Terraform, this will generally mask the value in practitioner output. This setting cannot be conditionally set and does not impact how data is stored in the state.
130130

131+
### WriteOnly
132+
133+
<Highlight>
134+
135+
Only managed resources implement this concept.
136+
137+
</Highlight>
138+
139+
Set the `WriteOnly` field to define a [write-only argument](/terraform/plugin/framework/resources/write-only-arguments).
140+
Write-only arguments can accept [ephemeral values](/terraform/language/resources/ephemeral)
141+
and are not persisted in the Terraform plan or state artifacts. Write-only arguments are supported in Terraform 1.11 and later.
142+
131143
### Validation
132144

133145
Set the `Validators` field to define [validation](/terraform/plugin/framework/validation#attribute-validation). This validation logic is ran in addition to any validation contained within a [custom type](#custom-types).

‎website/docs/plugin/framework/handling-data/attributes/map-nested.mdx‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -159,6 +159,20 @@ The [`mapplanmodifier`](https://pkg.go.dev/github.com/hashicorp/terraform-plugin
159159

160160
Set the `Sensitive` field if the attribute value should always be considered [sensitive data](/terraform/language/state/sensitive-data). In Terraform, this will generally mask the value in practitioner output. This setting cannot be conditionally set and does not impact how data is stored in the state.
161161

162+
### WriteOnly
163+
164+
<Highlight>
165+
166+
Only managed resources implement this concept.
167+
168+
</Highlight>
169+
170+
Set the `WriteOnly` field to define a [write-only argument](/terraform/plugin/framework/resources/write-only-arguments).
171+
Write-only arguments can accept [ephemeral values](/terraform/language/resources/ephemeral)
172+
and are not persisted in the Terraform plan or state artifacts. Write-only arguments are supported in Terraform 1.11 and later.
173+
174+
If a nested attribute has the `WriteOnly` field set, all child attributes must also have `WriteOnly` set.
175+
162176
### Validation
163177

164178
Set the `Validators` field to define [validation](/terraform/plugin/framework/validation#attribute-validation). This validation logic is ran in addition to any validation contained within a [custom type](#custom-types).

0 commit comments

Comments
 (0)