@@ -311,11 +311,32 @@ type Schema struct {
311
311
// "parent_block_name.0.child_attribute_name".
312
312
RequiredWith []string
313
313
314
- // Deprecated indicates the message to include in a warning diagnostic to
315
- // practitioners when this attribute is configured. Typically this is used
316
- // to signal that this attribute will be removed in the future and provide
317
- // next steps to the practitioner, such as using a different attribute,
318
- // different resource, or if it should just be removed.
314
+ // Deprecated defines warning diagnostic details to display to
315
+ // practitioners configuring this attribute or block. The warning
316
+ // diagnostic summary is automatically set to "Argument is deprecated"
317
+ // along with configuration source file and line information.
318
+ //
319
+ // This warning diagnostic is only displayed during Terraform's validation
320
+ // phase when this field is a non-empty string, when the attribute is
321
+ // Required or Optional, and if the practitioner configuration attempts to
322
+ // set the attribute value to a known value. It cannot detect practitioner
323
+ // configuration values that are unknown ("known after apply").
324
+ //
325
+ // This field has no effect when the attribute is Computed-only (read-only;
326
+ // not Required or Optional) and a practitioner attempts to reference
327
+ // this attribute value in their configuration. There is a Terraform
328
+ // feature request to support this type of functionality:
329
+ //
330
+ // https://github.com/hashicorp/terraform/issues/7569
331
+ //
332
+ // Set this field to a practitioner actionable message such as:
333
+ //
334
+ // - "Configure other_attribute instead. This attribute will be removed
335
+ // in the next major version of the provider."
336
+ // - "Remove this attribute's configuration as it no longer is used and
337
+ // the attribute will be removed in the next major version of the
338
+ // provider."
339
+ //
319
340
Deprecated string
320
341
321
342
// ValidateFunc allows individual fields to define arbitrary validation
0 commit comments