type Attribute interface {fwschema.Attribute}

type Block interface {fwschema.Block}

type BoolAttribute struct {// CustomType enables the use of a custom attribute type in place of the// default basetypes.BoolType. When retrieving data, the basetypes.BoolValuable// associated with this custom type must be used in place of types.Bool.CustomTypebasetypes.BoolTypable// Required indicates whether the practitioner must enter a value for// this attribute or not. Required and Optional cannot both be true,// and Required and Computed cannot both be true.Requiredbool// Optional indicates whether the practitioner can choose to enter a value// for this attribute or not. Optional and Required cannot both be true.Optionalbool// Computed indicates whether the provider may return its own value for// this Attribute or not. Required and Computed cannot both be true. If// Required and Optional are both false, Computed must be true, and the// attribute will be considered "read only" for the practitioner, with// only the provider able to set its value.Computedbool// Sensitive indicates whether the value of this attribute should be// considered sensitive data. Setting it to true will obscure the value// in CLI output. Sensitive does not impact how values are stored, and// practitioners are encouraged to store their state as if the entire// file is sensitive.Sensitivebool// Description is used in various tooling, like the language server, to// give practitioners more information about what this attribute is,// what it's for, and how it should be used. It should be written as// plain text, with no special formatting.Descriptionstring// MarkdownDescription is used in various tooling, like the// documentation generator, to give practitioners more information// about what this attribute is, what it's for, and how it should be// used. It should be formatted using Markdown.MarkdownDescriptionstring// DeprecationMessage defines warning diagnostic details to display when// practitioner configurations use this Attribute. The warning diagnostic// summary is automatically set to "Attribute Deprecated" along with// configuration source file and line information.//// Set this field to a practitioner actionable message such as:////  - "Configure other_attribute instead. This attribute will be removed//    in the next major version of the provider."//  - "Remove this attribute's configuration as it no longer is used and//    the attribute will be removed in the next major version of the//    provider."//// In Terraform 1.2.7 and later, this warning diagnostic is displayed any// time a practitioner attempts to configure a value for this attribute and// certain scenarios where this attribute is referenced.//// In Terraform 1.2.6 and earlier, this warning diagnostic is only// displayed when the Attribute is Required or Optional, and if the// practitioner configuration sets the value to a known or unknown value// (which may eventually be null). It has no effect when the Attribute is// Computed-only (read-only; not Required or Optional).//// Across any Terraform version, there are no warnings raised for// practitioner configuration values set directly to null, as there is no// way for the framework to differentiate between an unset and null// configuration due to how Terraform sends configuration information// across the protocol.//// Additional information about deprecation enhancements for read-only// attributes can be found in:////  -https://github.com/hashicorp/terraform/issues/7569//DeprecationMessagestring// Validators define value validation functionality for the attribute. All// elements of the slice of AttributeValidator are run, regardless of any// previous error diagnostics.//// Many common use case validators can be found in the// github.com/hashicorp/terraform-plugin-framework-validators Go module.//// If the Type field points to a custom type that implements the// xattr.TypeWithValidate interface, the validators defined in this field// are run in addition to the validation defined by the type.Validators []validator.Bool// PlanModifiers defines a sequence of modifiers for this attribute at// plan time. Schema-based plan modifications occur before any// resource-level plan modifications.//// Schema-based plan modifications can adjust Terraform's plan by:////  - Requiring resource recreation. Typically used for configuration//    updates which cannot be done in-place.//  - Setting the planned value. Typically used for enhancing the plan//    to replace unknown values. Computed must be true or Terraform will//    return an error. If the plan value is known due to a known//    configuration value, the plan value cannot be changed or Terraform//    will return an error.//// Any errors will prevent further execution of this sequence or modifiers.PlanModifiers []planmodifier.Bool// Default defines a proposed new state (plan) value for the attribute// if the configuration value is null. Default prevents the framework// from automatically marking the value as unknown during planning when// other proposed new state changes are detected. If the attribute is// computed and the value could be altered by other changes then a default// should be avoided and a plan modifier should be used instead.Defaultdefaults.Bool// WriteOnly indicates that Terraform will not store this attribute value// in the plan or state artifacts.// If WriteOnly is true, either Optional or Required must also be true.// WriteOnly cannot be set with Computed.//// This functionality is only supported in Terraform 1.11 and later.// Practitioners that choose a value for this attribute with older// versions of Terraform will receive an error.WriteOnlybool}

func (BoolAttribute)ApplyTerraform5AttributePathStep¶

func (aBoolAttribute) ApplyTerraform5AttributePathStep(steptftypes.AttributePathStep) (interface{},error)

ApplyTerraform5AttributePathStep always returns an error as it is notpossible to step further into a BoolAttribute.

func (BoolAttribute)BoolDefaultValue¶added inv1.2.0

func (aBoolAttribute) BoolDefaultValue()defaults.Bool

BoolDefaultValue returns the Default field value.

func (BoolAttribute)BoolPlanModifiers¶

func (aBoolAttribute) BoolPlanModifiers() []planmodifier.Bool

BoolPlanModifiers returns the PlanModifiers field value.

func (BoolAttribute)BoolValidators¶

func (aBoolAttribute) BoolValidators() []validator.Bool

BoolValidators returns the Validators field value.

func (BoolAttribute)Equal¶

func (aBoolAttribute) Equal(ofwschema.Attribute)bool

Equal returns true if the given Attribute is a BoolAttributeand all fields are equal.

func (BoolAttribute)GetDeprecationMessage¶

func (aBoolAttribute) GetDeprecationMessage()string

GetDeprecationMessage returns the DeprecationMessage field value.

func (BoolAttribute)GetDescription¶

func (aBoolAttribute) GetDescription()string

GetDescription returns the Description field value.

func (BoolAttribute)GetMarkdownDescription¶

func (aBoolAttribute) GetMarkdownDescription()string

GetMarkdownDescription returns the MarkdownDescription field value.

func (BoolAttribute)GetType¶

func (aBoolAttribute) GetType()attr.Type

GetType returns types.StringType or the CustomType field value if defined.

func (BoolAttribute)IsComputed¶

func (aBoolAttribute) IsComputed()bool

IsComputed returns the Computed field value.

func (BoolAttribute)IsOptional¶

func (aBoolAttribute) IsOptional()bool

IsOptional returns the Optional field value.

func (BoolAttribute)IsOptionalForImport¶added inv1.15.0

func (aBoolAttribute) IsOptionalForImport()bool

IsOptionalForImport returns false as this behavior is only relevantfor managed resource identity schema attributes.

func (BoolAttribute)IsRequired¶

func (aBoolAttribute) IsRequired()bool

IsRequired returns the Required field value.

func (BoolAttribute)IsRequiredForImport¶added inv1.15.0

func (aBoolAttribute) IsRequiredForImport()bool

IsRequiredForImport returns false as this behavior is only relevantfor managed resource identity schema attributes.

func (BoolAttribute)IsSensitive¶

func (aBoolAttribute) IsSensitive()bool

IsSensitive returns the Sensitive field value.

func (BoolAttribute)IsWriteOnly¶added inv1.14.0

func (aBoolAttribute) IsWriteOnly()bool

IsWriteOnly returns the WriteOnly field value.

func (BoolAttribute)ValidateImplementation¶added inv1.3.0

func (aBoolAttribute) ValidateImplementation(ctxcontext.Context, reqfwschema.ValidateImplementationRequest, resp *fwschema.ValidateImplementationResponse)

ValidateImplementation contains logic for validating theprovider-defined implementation of the attribute to prevent unexpectederrors or panics. This logic runs during the GetProviderSchema RPC andshould never include false positives.

type DynamicAttribute struct {// CustomType enables the use of a custom attribute type in place of the// default basetypes.DynamicType. When retrieving data, the basetypes.DynamicValuable// associated with this custom type must be used in place of types.Dynamic.CustomTypebasetypes.DynamicTypable// Required indicates whether the practitioner must enter a value for// this attribute or not. Required and Optional cannot both be true,// and Required and Computed cannot both be true.Requiredbool// Optional indicates whether the practitioner can choose to enter a value// for this attribute or not. Optional and Required cannot both be true.Optionalbool// Computed indicates whether the provider may return its own value for// this Attribute or not. Required and Computed cannot both be true. If// Required and Optional are both false, Computed must be true, and the// attribute will be considered "read only" for the practitioner, with// only the provider able to set its value.Computedbool// Sensitive indicates whether the value of this attribute should be// considered sensitive data. Setting it to true will obscure the value// in CLI output. Sensitive does not impact how values are stored, and// practitioners are encouraged to store their state as if the entire// file is sensitive.Sensitivebool// Description is used in various tooling, like the language server, to// give practitioners more information about what this attribute is,// what it's for, and how it should be used. It should be written as// plain text, with no special formatting.Descriptionstring// MarkdownDescription is used in various tooling, like the// documentation generator, to give practitioners more information// about what this attribute is, what it's for, and how it should be// used. It should be formatted using Markdown.MarkdownDescriptionstring// DeprecationMessage defines warning diagnostic details to display when// practitioner configurations use this Attribute. The warning diagnostic// summary is automatically set to "Attribute Deprecated" along with// configuration source file and line information.//// Set this field to a practitioner actionable message such as:////  - "Configure other_attribute instead. This attribute will be removed//    in the next major version of the provider."//  - "Remove this attribute's configuration as it no longer is used and//    the attribute will be removed in the next major version of the//    provider."//// In Terraform 1.2.7 and later, this warning diagnostic is displayed any// time a practitioner attempts to configure a value for this attribute and// certain scenarios where this attribute is referenced.//// In Terraform 1.2.6 and earlier, this warning diagnostic is only// displayed when the Attribute is Required or Optional, and if the// practitioner configuration sets the value to a known or unknown value// (which may eventually be null). It has no effect when the Attribute is// Computed-only (read-only; not Required or Optional).//// Across any Terraform version, there are no warnings raised for// practitioner configuration values set directly to null, as there is no// way for the framework to differentiate between an unset and null// configuration due to how Terraform sends configuration information// across the protocol.//// Additional information about deprecation enhancements for read-only// attributes can be found in:////  -https://github.com/hashicorp/terraform/issues/7569//DeprecationMessagestring// Validators define value validation functionality for the attribute. All// elements of the slice of AttributeValidator are run, regardless of any// previous error diagnostics.//// Many common use case validators can be found in the// github.com/hashicorp/terraform-plugin-framework-validators Go module.//// If the Type field points to a custom type that implements the// xattr.TypeWithValidate interface, the validators defined in this field// are run in addition to the validation defined by the type.Validators []validator.Dynamic// PlanModifiers defines a sequence of modifiers for this attribute at// plan time. Schema-based plan modifications occur before any// resource-level plan modifications.//// Schema-based plan modifications can adjust Terraform's plan by:////  - Requiring resource recreation. Typically used for configuration//    updates which cannot be done in-place.//  - Setting the planned value. Typically used for enhancing the plan//    to replace unknown values. Computed must be true or Terraform will//    return an error. If the plan value is known due to a known//    configuration value, the plan value cannot be changed or Terraform//    will return an error.//// Any errors will prevent further execution of this sequence or modifiers.PlanModifiers []planmodifier.Dynamic// Default defines a proposed new state (plan) value for the attribute// if the configuration value is null. Default prevents the framework// from automatically marking the value as unknown during planning when// other proposed new state changes are detected. If the attribute is// computed and the value could be altered by other changes then a default// should be avoided and a plan modifier should be used instead.Defaultdefaults.Dynamic// WriteOnly indicates that Terraform will not store this attribute value// in the plan or state artifacts.// If WriteOnly is true, either Optional or Required must also be true.// WriteOnly cannot be set with Computed.//// This functionality is only supported in Terraform 1.11 and later.// Practitioners that choose a value for this attribute with older// versions of Terraform will receive an error.WriteOnlybool}

func (DynamicAttribute)ApplyTerraform5AttributePathStep¶added inv1.7.0

func (aDynamicAttribute) ApplyTerraform5AttributePathStep(steptftypes.AttributePathStep) (interface{},error)

ApplyTerraform5AttributePathStep always returns an error as it is notpossible to step further into a DynamicAttribute.

func (DynamicAttribute)DynamicDefaultValue¶added inv1.7.0

func (aDynamicAttribute) DynamicDefaultValue()defaults.Dynamic

DynamicDefaultValue returns the Default field value.

func (DynamicAttribute)DynamicPlanModifiers¶added inv1.7.0

func (aDynamicAttribute) DynamicPlanModifiers() []planmodifier.Dynamic

DynamicPlanModifiers returns the PlanModifiers field value.

func (DynamicAttribute)DynamicValidators¶added inv1.7.0

func (aDynamicAttribute) DynamicValidators() []validator.Dynamic

DynamicValidators returns the Validators field value.

func (DynamicAttribute)Equal¶added inv1.7.0

func (aDynamicAttribute) Equal(ofwschema.Attribute)bool

Equal returns true if the given Attribute is a DynamicAttributeand all fields are equal.

func (DynamicAttribute)GetDeprecationMessage¶added inv1.7.0

func (aDynamicAttribute) GetDeprecationMessage()string

GetDeprecationMessage returns the DeprecationMessage field value.

func (DynamicAttribute)GetDescription¶added inv1.7.0

func (aDynamicAttribute) GetDescription()string

GetDescription returns the Description field value.

func (DynamicAttribute)GetMarkdownDescription¶added inv1.7.0

func (aDynamicAttribute) GetMarkdownDescription()string

GetMarkdownDescription returns the MarkdownDescription field value.

func (DynamicAttribute)GetType¶added inv1.7.0

func (aDynamicAttribute) GetType()attr.Type

GetType returns types.DynamicType or the CustomType field value if defined.

func (DynamicAttribute)IsComputed¶added inv1.7.0

func (aDynamicAttribute) IsComputed()bool

IsComputed returns the Computed field value.

func (DynamicAttribute)IsOptional¶added inv1.7.0

func (aDynamicAttribute) IsOptional()bool

IsOptional returns the Optional field value.

func (DynamicAttribute)IsOptionalForImport¶added inv1.15.0

func (aDynamicAttribute) IsOptionalForImport()bool

IsOptionalForImport returns false as this behavior is only relevantfor managed resource identity schema attributes.

func (DynamicAttribute)IsRequired¶added inv1.7.0

func (aDynamicAttribute) IsRequired()bool

IsRequired returns the Required field value.

func (DynamicAttribute)IsRequiredForImport¶added inv1.15.0

func (aDynamicAttribute) IsRequiredForImport()bool

IsRequiredForImport returns false as this behavior is only relevantfor managed resource identity schema attributes.

func (DynamicAttribute)IsSensitive¶added inv1.7.0

func (aDynamicAttribute) IsSensitive()bool

IsSensitive returns the Sensitive field value.

func (DynamicAttribute)IsWriteOnly¶added inv1.14.0

func (aDynamicAttribute) IsWriteOnly()bool

IsWriteOnly returns the WriteOnly field value.

func (DynamicAttribute)ValidateImplementation¶added inv1.7.0

func (aDynamicAttribute) ValidateImplementation(ctxcontext.Context, reqfwschema.ValidateImplementationRequest, resp *fwschema.ValidateImplementationResponse)

ValidateImplementation contains logic for validating theprovider-defined implementation of the attribute to prevent unexpectederrors or panics. This logic runs during the GetProviderSchema RPC andshould never include false positives.

type Float32Attribute struct {// CustomType enables the use of a custom attribute type in place of the// default basetypes.Float32Type. When retrieving data, the basetypes.Float32Valuable// associated with this custom type must be used in place of types.Float32.CustomTypebasetypes.Float32Typable// Required indicates whether the practitioner must enter a value for// this attribute or not. Required and Optional cannot both be true,// and Required and Computed cannot both be true.Requiredbool// Optional indicates whether the practitioner can choose to enter a value// for this attribute or not. Optional and Required cannot both be true.Optionalbool// Computed indicates whether the provider may return its own value for// this Attribute or not. Required and Computed cannot both be true. If// Required and Optional are both false, Computed must be true, and the// attribute will be considered "read only" for the practitioner, with// only the provider able to set its value.Computedbool// Sensitive indicates whether the value of this attribute should be// considered sensitive data. Setting it to true will obscure the value// in CLI output. Sensitive does not impact how values are stored, and// practitioners are encouraged to store their state as if the entire// file is sensitive.Sensitivebool// Description is used in various tooling, like the language server, to// give practitioners more information about what this attribute is,// what it's for, and how it should be used. It should be written as// plain text, with no special formatting.Descriptionstring// MarkdownDescription is used in various tooling, like the// documentation generator, to give practitioners more information// about what this attribute is, what it's for, and how it should be// used. It should be formatted using Markdown.MarkdownDescriptionstring// DeprecationMessage defines warning diagnostic details to display when// practitioner configurations use this Attribute. The warning diagnostic// summary is automatically set to "Attribute Deprecated" along with// configuration source file and line information.//// Set this field to a practitioner actionable message such as:////  - "Configure other_attribute instead. This attribute will be removed//    in the next major version of the provider."//  - "Remove this attribute's configuration as it no longer is used and//    the attribute will be removed in the next major version of the//    provider."//// In Terraform 1.2.7 and later, this warning diagnostic is displayed any// time a practitioner attempts to configure a value for this attribute and// certain scenarios where this attribute is referenced.//// In Terraform 1.2.6 and earlier, this warning diagnostic is only// displayed when the Attribute is Required or Optional, and if the// practitioner configuration sets the value to a known or unknown value// (which may eventually be null). It has no effect when the Attribute is// Computed-only (read-only; not Required or Optional).//// Across any Terraform version, there are no warnings raised for// practitioner configuration values set directly to null, as there is no// way for the framework to differentiate between an unset and null// configuration due to how Terraform sends configuration information// across the protocol.//// Additional information about deprecation enhancements for read-only// attributes can be found in:////  -https://github.com/hashicorp/terraform/issues/7569//DeprecationMessagestring// Validators define value validation functionality for the attribute. All// elements of the slice of AttributeValidator are run, regardless of any// previous error diagnostics.//// Many common use case validators can be found in the// github.com/hashicorp/terraform-plugin-framework-validators Go module.//// If the Type field points to a custom type that implements the// xattr.TypeWithValidate interface, the validators defined in this field// are run in addition to the validation defined by the type.Validators []validator.Float32// PlanModifiers defines a sequence of modifiers for this attribute at// plan time. Schema-based plan modifications occur before any// resource-level plan modifications.//// Schema-based plan modifications can adjust Terraform's plan by:////  - Requiring resource recreation. Typically used for configuration//    updates which cannot be done in-place.//  - Setting the planned value. Typically used for enhancing the plan//    to replace unknown values. Computed must be true or Terraform will//    return an error. If the plan value is known due to a known//    configuration value, the plan value cannot be changed or Terraform//    will return an error.//// Any errors will prevent further execution of this sequence or modifiers.PlanModifiers []planmodifier.Float32// Default defines a proposed new state (plan) value for the attribute// if the configuration value is null. Default prevents the framework// from automatically marking the value as unknown during planning when// other proposed new state changes are detected. If the attribute is// computed and the value could be altered by other changes then a default// should be avoided and a plan modifier should be used instead.Defaultdefaults.Float32// WriteOnly indicates that Terraform will not store this attribute value// in the plan or state artifacts.// If WriteOnly is true, either Optional or Required must also be true.// WriteOnly cannot be set with Computed.//// This functionality is only supported in Terraform 1.11 and later.// Practitioners that choose a value for this attribute with older// versions of Terraform will receive an error.WriteOnlybool}

func (Float32Attribute)ApplyTerraform5AttributePathStep¶added inv1.10.0

func (aFloat32Attribute) ApplyTerraform5AttributePathStep(steptftypes.AttributePathStep) (interface{},error)

ApplyTerraform5AttributePathStep always returns an error as it is notpossible to step further into a Float32Attribute.

func (Float32Attribute)Equal¶added inv1.10.0

func (aFloat32Attribute) Equal(ofwschema.Attribute)bool

Equal returns true if the given Attribute is a Float32Attributeand all fields are equal.

func (Float32Attribute)Float32DefaultValue¶added inv1.10.0

func (aFloat32Attribute) Float32DefaultValue()defaults.Float32

Float32DefaultValue returns the Default field value.

func (Float32Attribute)Float32PlanModifiers¶added inv1.10.0

func (aFloat32Attribute) Float32PlanModifiers() []planmodifier.Float32

Float32PlanModifiers returns the PlanModifiers field value.

func (Float32Attribute)Float32Validators¶added inv1.10.0

func (aFloat32Attribute) Float32Validators() []validator.Float32

Float32Validators returns the Validators field value.

func (Float32Attribute)GetDeprecationMessage¶added inv1.10.0

func (aFloat32Attribute) GetDeprecationMessage()string

GetDeprecationMessage returns the DeprecationMessage field value.

func (Float32Attribute)GetDescription¶added inv1.10.0

func (aFloat32Attribute) GetDescription()string

GetDescription returns the Description field value.

func (Float32Attribute)GetMarkdownDescription¶added inv1.10.0

func (aFloat32Attribute) GetMarkdownDescription()string

GetMarkdownDescription returns the MarkdownDescription field value.

func (Float32Attribute)GetType¶added inv1.10.0

func (aFloat32Attribute) GetType()attr.Type

GetType returns types.Float32Type or the CustomType field value if defined.

func (Float32Attribute)IsComputed¶added inv1.10.0

func (aFloat32Attribute) IsComputed()bool

IsComputed returns the Computed field value.

func (Float32Attribute)IsOptional¶added inv1.10.0

func (aFloat32Attribute) IsOptional()bool

IsOptional returns the Optional field value.

func (Float32Attribute)IsOptionalForImport¶added inv1.15.0

func (aFloat32Attribute) IsOptionalForImport()bool

IsOptionalForImport returns false as this behavior is only relevantfor managed resource identity schema attributes.

func (Float32Attribute)IsRequired¶added inv1.10.0

func (aFloat32Attribute) IsRequired()bool

IsRequired returns the Required field value.

func (Float32Attribute)IsRequiredForImport¶added inv1.15.0

func (aFloat32Attribute) IsRequiredForImport()bool

IsRequiredForImport returns false as this behavior is only relevantfor managed resource identity schema attributes.

func (Float32Attribute)IsSensitive¶added inv1.10.0

func (aFloat32Attribute) IsSensitive()bool

IsSensitive returns the Sensitive field value.

func (Float32Attribute)IsWriteOnly¶added inv1.14.0

func (aFloat32Attribute) IsWriteOnly()bool

IsWriteOnly returns the WriteOnly field value.

func (Float32Attribute)ValidateImplementation¶added inv1.10.0

func (aFloat32Attribute) ValidateImplementation(ctxcontext.Context, reqfwschema.ValidateImplementationRequest, resp *fwschema.ValidateImplementationResponse)

ValidateImplementation contains logic for validating theprovider-defined implementation of the attribute to prevent unexpectederrors or panics. This logic runs during the GetProviderSchema RPC andshould never include false positives.

type Float64Attribute struct {// CustomType enables the use of a custom attribute type in place of the// default basetypes.Float64Type. When retrieving data, the basetypes.Float64Valuable// associated with this custom type must be used in place of types.Float64.CustomTypebasetypes.Float64Typable// Required indicates whether the practitioner must enter a value for// this attribute or not. Required and Optional cannot both be true,// and Required and Computed cannot both be true.Requiredbool// Optional indicates whether the practitioner can choose to enter a value// for this attribute or not. Optional and Required cannot both be true.Optionalbool// Computed indicates whether the provider may return its own value for// this Attribute or not. Required and Computed cannot both be true. If// Required and Optional are both false, Computed must be true, and the// attribute will be considered "read only" for the practitioner, with// only the provider able to set its value.Computedbool// Sensitive indicates whether the value of this attribute should be// considered sensitive data. Setting it to true will obscure the value// in CLI output. Sensitive does not impact how values are stored, and// practitioners are encouraged to store their state as if the entire// file is sensitive.Sensitivebool// Description is used in various tooling, like the language server, to// give practitioners more information about what this attribute is,// what it's for, and how it should be used. It should be written as// plain text, with no special formatting.Descriptionstring// MarkdownDescription is used in various tooling, like the// documentation generator, to give practitioners more information// about what this attribute is, what it's for, and how it should be// used. It should be formatted using Markdown.MarkdownDescriptionstring// DeprecationMessage defines warning diagnostic details to display when// practitioner configurations use this Attribute. The warning diagnostic// summary is automatically set to "Attribute Deprecated" along with// configuration source file and line information.//// Set this field to a practitioner actionable message such as:////  - "Configure other_attribute instead. This attribute will be removed//    in the next major version of the provider."//  - "Remove this attribute's configuration as it no longer is used and//    the attribute will be removed in the next major version of the//    provider."//// In Terraform 1.2.7 and later, this warning diagnostic is displayed any// time a practitioner attempts to configure a value for this attribute and// certain scenarios where this attribute is referenced.//// In Terraform 1.2.6 and earlier, this warning diagnostic is only// displayed when the Attribute is Required or Optional, and if the// practitioner configuration sets the value to a known or unknown value// (which may eventually be null). It has no effect when the Attribute is// Computed-only (read-only; not Required or Optional).//// Across any Terraform version, there are no warnings raised for// practitioner configuration values set directly to null, as there is no// way for the framework to differentiate between an unset and null// configuration due to how Terraform sends configuration information// across the protocol.//// Additional information about deprecation enhancements for read-only// attributes can be found in:////  -https://github.com/hashicorp/terraform/issues/7569//DeprecationMessagestring// Validators define value validation functionality for the attribute. All// elements of the slice of AttributeValidator are run, regardless of any// previous error diagnostics.//// Many common use case validators can be found in the// github.com/hashicorp/terraform-plugin-framework-validators Go module.//// If the Type field points to a custom type that implements the// xattr.TypeWithValidate interface, the validators defined in this field// are run in addition to the validation defined by the type.Validators []validator.Float64// PlanModifiers defines a sequence of modifiers for this attribute at// plan time. Schema-based plan modifications occur before any// resource-level plan modifications.//// Schema-based plan modifications can adjust Terraform's plan by:////  - Requiring resource recreation. Typically used for configuration//    updates which cannot be done in-place.//  - Setting the planned value. Typically used for enhancing the plan//    to replace unknown values. Computed must be true or Terraform will//    return an error. If the plan value is known due to a known//    configuration value, the plan value cannot be changed or Terraform//    will return an error.//// Any errors will prevent further execution of this sequence or modifiers.PlanModifiers []planmodifier.Float64// Default defines a proposed new state (plan) value for the attribute// if the configuration value is null. Default prevents the framework// from automatically marking the value as unknown during planning when// other proposed new state changes are detected. If the attribute is// computed and the value could be altered by other changes then a default// should be avoided and a plan modifier should be used instead.Defaultdefaults.Float64// WriteOnly indicates that Terraform will not store this attribute value// in the plan or state artifacts.// If WriteOnly is true, either Optional or Required must also be true.// WriteOnly cannot be set with Computed.//// This functionality is only supported in Terraform 1.11 and later.// Practitioners that choose a value for this attribute with older// versions of Terraform will receive an error.WriteOnlybool}

func (Float64Attribute)ApplyTerraform5AttributePathStep¶

func (aFloat64Attribute) ApplyTerraform5AttributePathStep(steptftypes.AttributePathStep) (interface{},error)

ApplyTerraform5AttributePathStep always returns an error as it is notpossible to step further into a Float64Attribute.

func (Float64Attribute)Equal¶

func (aFloat64Attribute) Equal(ofwschema.Attribute)bool

Equal returns true if the given Attribute is a Float64Attributeand all fields are equal.

func (Float64Attribute)Float64DefaultValue¶added inv1.2.0

func (aFloat64Attribute) Float64DefaultValue()defaults.Float64

Float64DefaultValue returns the Default field value.

func (Float64Attribute)Float64PlanModifiers¶

func (aFloat64Attribute) Float64PlanModifiers() []planmodifier.Float64

Float64PlanModifiers returns the PlanModifiers field value.

func (Float64Attribute)Float64Validators¶

func (aFloat64Attribute) Float64Validators() []validator.Float64

Float64Validators returns the Validators field value.

func (Float64Attribute)GetDeprecationMessage¶

func (aFloat64Attribute) GetDeprecationMessage()string

GetDeprecationMessage returns the DeprecationMessage field value.

func (Float64Attribute)GetDescription¶

func (aFloat64Attribute) GetDescription()string

GetDescription returns the Description field value.

func (Float64Attribute)GetMarkdownDescription¶

func (aFloat64Attribute) GetMarkdownDescription()string

GetMarkdownDescription returns the MarkdownDescription field value.

func (Float64Attribute)GetType¶

func (aFloat64Attribute) GetType()attr.Type

GetType returns types.Float64Type or the CustomType field value if defined.

func (Float64Attribute)IsComputed¶

func (aFloat64Attribute) IsComputed()bool

IsComputed returns the Computed field value.

func (Float64Attribute)IsOptional¶

func (aFloat64Attribute) IsOptional()bool

IsOptional returns the Optional field value.

func (Float64Attribute)IsOptionalForImport¶added inv1.15.0

func (aFloat64Attribute) IsOptionalForImport()bool

IsOptionalForImport returns false as this behavior is only relevantfor managed resource identity schema attributes.

func (Float64Attribute)IsRequired¶

func (aFloat64Attribute) IsRequired()bool

IsRequired returns the Required field value.

func (Float64Attribute)IsRequiredForImport¶added inv1.15.0

func (aFloat64Attribute) IsRequiredForImport()bool

IsRequiredForImport returns false as this behavior is only relevantfor managed resource identity schema attributes.

func (Float64Attribute)IsSensitive¶

func (aFloat64Attribute) IsSensitive()bool

IsSensitive returns the Sensitive field value.

func (Float64Attribute)IsWriteOnly¶added inv1.14.0

func (aFloat64Attribute) IsWriteOnly()bool

IsWriteOnly returns the WriteOnly field value.

func (Float64Attribute)ValidateImplementation¶added inv1.3.0

func (aFloat64Attribute) ValidateImplementation(ctxcontext.Context, reqfwschema.ValidateImplementationRequest, resp *fwschema.ValidateImplementationResponse)

ValidateImplementation contains logic for validating theprovider-defined implementation of the attribute to prevent unexpectederrors or panics. This logic runs during the GetProviderSchema RPC andshould never include false positives.

type Int32Attribute struct {// CustomType enables the use of a custom attribute type in place of the// default basetypes.Int32Type. When retrieving data, the basetypes.Int32Valuable// associated with this custom type must be used in place of types.Int32.CustomTypebasetypes.Int32Typable// Required indicates whether the practitioner must enter a value for// this attribute or not. Required and Optional cannot both be true,// and Required and Computed cannot both be true.Requiredbool// Optional indicates whether the practitioner can choose to enter a value// for this attribute or not. Optional and Required cannot both be true.Optionalbool// Computed indicates whether the provider may return its own value for// this Attribute or not. Required and Computed cannot both be true. If// Required and Optional are both false, Computed must be true, and the// attribute will be considered "read only" for the practitioner, with// only the provider able to set its value.Computedbool// Sensitive indicates whether the value of this attribute should be// considered sensitive data. Setting it to true will obscure the value// in CLI output. Sensitive does not impact how values are stored, and// practitioners are encouraged to store their state as if the entire// file is sensitive.Sensitivebool// Description is used in various tooling, like the language server, to// give practitioners more information about what this attribute is,// what it's for, and how it should be used. It should be written as// plain text, with no special formatting.Descriptionstring// MarkdownDescription is used in various tooling, like the// documentation generator, to give practitioners more information// about what this attribute is, what it's for, and how it should be// used. It should be formatted using Markdown.MarkdownDescriptionstring// DeprecationMessage defines warning diagnostic details to display when// practitioner configurations use this Attribute. The warning diagnostic// summary is automatically set to "Attribute Deprecated" along with// configuration source file and line information.//// Set this field to a practitioner actionable message such as:////  - "Configure other_attribute instead. This attribute will be removed//    in the next major version of the provider."//  - "Remove this attribute's configuration as it no longer is used and//    the attribute will be removed in the next major version of the//    provider."//// In Terraform 1.2.7 and later, this warning diagnostic is displayed any// time a practitioner attempts to configure a value for this attribute and// certain scenarios where this attribute is referenced.//// In Terraform 1.2.6 and earlier, this warning diagnostic is only// displayed when the Attribute is Required or Optional, and if the// practitioner configuration sets the value to a known or unknown value// (which may eventually be null). It has no effect when the Attribute is// Computed-only (read-only; not Required or Optional).//// Across any Terraform version, there are no warnings raised for// practitioner configuration values set directly to null, as there is no// way for the framework to differentiate between an unset and null// configuration due to how Terraform sends configuration information// across the protocol.//// Additional information about deprecation enhancements for read-only// attributes can be found in:////  -https://github.com/hashicorp/terraform/issues/7569//DeprecationMessagestring// Validators define value validation functionality for the attribute. All// elements of the slice of AttributeValidator are run, regardless of any// previous error diagnostics.//// Many common use case validators can be found in the// github.com/hashicorp/terraform-plugin-framework-validators Go module.//// If the Type field points to a custom type that implements the// xattr.TypeWithValidate interface, the validators defined in this field// are run in addition to the validation defined by the type.Validators []validator.Int32// PlanModifiers defines a sequence of modifiers for this attribute at// plan time. Schema-based plan modifications occur before any// resource-level plan modifications.//// Schema-based plan modifications can adjust Terraform's plan by:////  - Requiring resource recreation. Typically used for configuration//    updates which cannot be done in-place.//  - Setting the planned value. Typically used for enhancing the plan//    to replace unknown values. Computed must be true or Terraform will//    return an error. If the plan value is known due to a known//    configuration value, the plan value cannot be changed or Terraform//    will return an error.//// Any errors will prevent further execution of this sequence or modifiers.PlanModifiers []planmodifier.Int32// Default defines a proposed new state (plan) value for the attribute// if the configuration value is null. Default prevents the framework// from automatically marking the value as unknown during planning when// other proposed new state changes are detected. If the attribute is// computed and the value could be altered by other changes then a default// should be avoided and a plan modifier should be used instead.Defaultdefaults.Int32// WriteOnly indicates that Terraform will not store this attribute value// in the plan or state artifacts.// If WriteOnly is true, either Optional or Required must also be true.// WriteOnly cannot be set with Computed.//// This functionality is only supported in Terraform 1.11 and later.// Practitioners that choose a value for this attribute with older// versions of Terraform will receive an error.WriteOnlybool}

func (Int32Attribute)ApplyTerraform5AttributePathStep¶added inv1.10.0

func (aInt32Attribute) ApplyTerraform5AttributePathStep(steptftypes.AttributePathStep) (interface{},error)

ApplyTerraform5AttributePathStep always returns an error as it is notpossible to step further into a Int32Attribute.

func (Int32Attribute)Equal¶added inv1.10.0

func (aInt32Attribute) Equal(ofwschema.Attribute)bool

Equal returns true if the given Attribute is a Int32Attributeand all fields are equal.

func (Int32Attribute)GetDeprecationMessage¶added inv1.10.0

func (aInt32Attribute) GetDeprecationMessage()string

GetDeprecationMessage returns the DeprecationMessage field value.

func (Int32Attribute)GetDescription¶added inv1.10.0

func (aInt32Attribute) GetDescription()string

GetDescription returns the Description field value.

func (Int32Attribute)GetMarkdownDescription¶added inv1.10.0

func (aInt32Attribute) GetMarkdownDescription()string

GetMarkdownDescription returns the MarkdownDescription field value.

func (Int32Attribute)GetType¶added inv1.10.0

func (aInt32Attribute) GetType()attr.Type

GetType returns types.Int32Type or the CustomType field value if defined.

func (Int32Attribute)Int32DefaultValue¶added inv1.10.0

func (aInt32Attribute) Int32DefaultValue()defaults.Int32

Int32DefaultValue returns the Default field value.

func (Int32Attribute)Int32PlanModifiers¶added inv1.10.0

func (aInt32Attribute) Int32PlanModifiers() []planmodifier.Int32

Int32PlanModifiers returns the PlanModifiers field value.

func (Int32Attribute)Int32Validators¶added inv1.10.0

func (aInt32Attribute) Int32Validators() []validator.Int32

Int32Validators returns the Validators field value.

func (Int32Attribute)IsComputed¶added inv1.10.0

func (aInt32Attribute) IsComputed()bool

IsComputed returns the Computed field value.

func (Int32Attribute)IsOptional¶added inv1.10.0

func (aInt32Attribute) IsOptional()bool

IsOptional returns the Optional field value.

func (Int32Attribute)IsOptionalForImport¶added inv1.15.0

func (aInt32Attribute) IsOptionalForImport()bool

IsOptionalForImport returns false as this behavior is only relevantfor managed resource identity schema attributes.

func (Int32Attribute)IsRequired¶added inv1.10.0

func (aInt32Attribute) IsRequired()bool

IsRequired returns the Required field value.

func (Int32Attribute)IsRequiredForImport¶added inv1.15.0

func (aInt32Attribute) IsRequiredForImport()bool

IsRequiredForImport returns false as this behavior is only relevantfor managed resource identity schema attributes.

func (Int32Attribute)IsSensitive¶added inv1.10.0

func (aInt32Attribute) IsSensitive()bool

IsSensitive returns the Sensitive field value.

func (Int32Attribute)IsWriteOnly¶added inv1.14.0

func (aInt32Attribute) IsWriteOnly()bool

IsWriteOnly returns the WriteOnly field value.

func (Int32Attribute)ValidateImplementation¶added inv1.10.0

func (aInt32Attribute) ValidateImplementation(ctxcontext.Context, reqfwschema.ValidateImplementationRequest, resp *fwschema.ValidateImplementationResponse)

ValidateImplementation contains logic for validating theprovider-defined implementation of the attribute to prevent unexpectederrors or panics. This logic runs during the GetProviderSchema RPC andshould never include false positives.

type Int64Attribute struct {// CustomType enables the use of a custom attribute type in place of the// default basetypes.Int64Type. When retrieving data, the basetypes.Int64Valuable// associated with this custom type must be used in place of types.Int64.CustomTypebasetypes.Int64Typable// Required indicates whether the practitioner must enter a value for// this attribute or not. Required and Optional cannot both be true,// and Required and Computed cannot both be true.Requiredbool// Optional indicates whether the practitioner can choose to enter a value// for this attribute or not. Optional and Required cannot both be true.Optionalbool// Computed indicates whether the provider may return its own value for// this Attribute or not. Required and Computed cannot both be true. If// Required and Optional are both false, Computed must be true, and the// attribute will be considered "read only" for the practitioner, with// only the provider able to set its value.Computedbool// Sensitive indicates whether the value of this attribute should be// considered sensitive data. Setting it to true will obscure the value// in CLI output. Sensitive does not impact how values are stored, and// practitioners are encouraged to store their state as if the entire// file is sensitive.Sensitivebool// Description is used in various tooling, like the language server, to// give practitioners more information about what this attribute is,// what it's for, and how it should be used. It should be written as// plain text, with no special formatting.Descriptionstring// MarkdownDescription is used in various tooling, like the// documentation generator, to give practitioners more information// about what this attribute is, what it's for, and how it should be// used. It should be formatted using Markdown.MarkdownDescriptionstring// DeprecationMessage defines warning diagnostic details to display when// practitioner configurations use this Attribute. The warning diagnostic// summary is automatically set to "Attribute Deprecated" along with// configuration source file and line information.//// Set this field to a practitioner actionable message such as:////  - "Configure other_attribute instead. This attribute will be removed//    in the next major version of the provider."//  - "Remove this attribute's configuration as it no longer is used and//    the attribute will be removed in the next major version of the//    provider."//// In Terraform 1.2.7 and later, this warning diagnostic is displayed any// time a practitioner attempts to configure a value for this attribute and// certain scenarios where this attribute is referenced.//// In Terraform 1.2.6 and earlier, this warning diagnostic is only// displayed when the Attribute is Required or Optional, and if the// practitioner configuration sets the value to a known or unknown value// (which may eventually be null). It has no effect when the Attribute is// Computed-only (read-only; not Required or Optional).//// Across any Terraform version, there are no warnings raised for// practitioner configuration values set directly to null, as there is no// way for the framework to differentiate between an unset and null// configuration due to how Terraform sends configuration information// across the protocol.//// Additional information about deprecation enhancements for read-only// attributes can be found in:////  -https://github.com/hashicorp/terraform/issues/7569//DeprecationMessagestring// Validators define value validation functionality for the attribute. All// elements of the slice of AttributeValidator are run, regardless of any// previous error diagnostics.//// Many common use case validators can be found in the// github.com/hashicorp/terraform-plugin-framework-validators Go module.//// If the Type field points to a custom type that implements the// xattr.TypeWithValidate interface, the validators defined in this field// are run in addition to the validation defined by the type.Validators []validator.Int64// PlanModifiers defines a sequence of modifiers for this attribute at// plan time. Schema-based plan modifications occur before any// resource-level plan modifications.//// Schema-based plan modifications can adjust Terraform's plan by:////  - Requiring resource recreation. Typically used for configuration//    updates which cannot be done in-place.//  - Setting the planned value. Typically used for enhancing the plan//    to replace unknown values. Computed must be true or Terraform will//    return an error. If the plan value is known due to a known//    configuration value, the plan value cannot be changed or Terraform//    will return an error.//// Any errors will prevent further execution of this sequence or modifiers.PlanModifiers []planmodifier.Int64// Default defines a proposed new state (plan) value for the attribute// if the configuration value is null. Default prevents the framework// from automatically marking the value as unknown during planning when// other proposed new state changes are detected. If the attribute is// computed and the value could be altered by other changes then a default// should be avoided and a plan modifier should be used instead.Defaultdefaults.Int64// WriteOnly indicates that Terraform will not store this attribute value// in the plan or state artifacts.// If WriteOnly is true, either Optional or Required must also be true.// WriteOnly cannot be set with Computed.//// This functionality is only supported in Terraform 1.11 and later.// Practitioners that choose a value for this attribute with older// versions of Terraform will receive an error.WriteOnlybool}

func (Int64Attribute)ApplyTerraform5AttributePathStep¶

func (aInt64Attribute) ApplyTerraform5AttributePathStep(steptftypes.AttributePathStep) (interface{},error)

ApplyTerraform5AttributePathStep always returns an error as it is notpossible to step further into a Int64Attribute.

func (Int64Attribute)Equal¶

func (aInt64Attribute) Equal(ofwschema.Attribute)bool

Equal returns true if the given Attribute is a Int64Attributeand all fields are equal.

func (Int64Attribute)GetDeprecationMessage¶

func (aInt64Attribute) GetDeprecationMessage()string

GetDeprecationMessage returns the DeprecationMessage field value.

func (Int64Attribute)GetDescription¶

func (aInt64Attribute) GetDescription()string

GetDescription returns the Description field value.

func (Int64Attribute)GetMarkdownDescription¶

func (aInt64Attribute) GetMarkdownDescription()string

GetMarkdownDescription returns the MarkdownDescription field value.

func (Int64Attribute)GetType¶

func (aInt64Attribute) GetType()attr.Type

GetType returns types.Int64Type or the CustomType field value if defined.

func (Int64Attribute)Int64DefaultValue¶added inv1.2.0

func (aInt64Attribute) Int64DefaultValue()defaults.Int64

Int64DefaultValue returns the Default field value.

func (Int64Attribute)Int64PlanModifiers¶

func (aInt64Attribute) Int64PlanModifiers() []planmodifier.Int64

Int64PlanModifiers returns the PlanModifiers field value.

func (Int64Attribute)Int64Validators¶

func (aInt64Attribute) Int64Validators() []validator.Int64

Int64Validators returns the Validators field value.

func (Int64Attribute)IsComputed¶

func (aInt64Attribute) IsComputed()bool

IsComputed returns the Computed field value.

func (Int64Attribute)IsOptional¶

func (aInt64Attribute) IsOptional()bool

IsOptional returns the Optional field value.

func (Int64Attribute)IsOptionalForImport¶added inv1.15.0

func (aInt64Attribute) IsOptionalForImport()bool

IsOptionalForImport returns false as this behavior is only relevantfor managed resource identity schema attributes.

func (Int64Attribute)IsRequired¶

func (aInt64Attribute) IsRequired()bool

IsRequired returns the Required field value.

func (Int64Attribute)IsRequiredForImport¶added inv1.15.0

func (aInt64Attribute) IsRequiredForImport()bool

IsRequiredForImport returns false as this behavior is only relevantfor managed resource identity schema attributes.

func (Int64Attribute)IsSensitive¶

func (aInt64Attribute) IsSensitive()bool

IsSensitive returns the Sensitive field value.

func (Int64Attribute)IsWriteOnly¶added inv1.14.0

func (aInt64Attribute) IsWriteOnly()bool

IsWriteOnly returns the WriteOnly field value.

func (Int64Attribute)ValidateImplementation¶added inv1.3.0

func (aInt64Attribute) ValidateImplementation(ctxcontext.Context, reqfwschema.ValidateImplementationRequest, resp *fwschema.ValidateImplementationResponse)

ValidateImplementation contains logic for validating theprovider-defined implementation of the attribute to prevent unexpectederrors or panics. This logic runs during the GetProviderSchema RPC andshould never include false positives.

type ListAttribute struct {// ElementType is the type for all elements of the list. This field must be// set.//// Element types that contain a dynamic type (i.e. types.Dynamic) are not supported.// If underlying dynamic values are required, replace this attribute definition with// DynamicAttribute instead.ElementTypeattr.Type// CustomType enables the use of a custom attribute type in place of the// default basetypes.ListType. When retrieving data, the basetypes.ListValuable// associated with this custom type must be used in place of types.List.CustomTypebasetypes.ListTypable// Required indicates whether the practitioner must enter a value for// this attribute or not. Required and Optional cannot both be true,// and Required and Computed cannot both be true.Requiredbool// Optional indicates whether the practitioner can choose to enter a value// for this attribute or not. Optional and Required cannot both be true.Optionalbool// Computed indicates whether the provider may return its own value for// this Attribute or not. Required and Computed cannot both be true. If// Required and Optional are both false, Computed must be true, and the// attribute will be considered "read only" for the practitioner, with// only the provider able to set its value.Computedbool// Sensitive indicates whether the value of this attribute should be// considered sensitive data. Setting it to true will obscure the value// in CLI output. Sensitive does not impact how values are stored, and// practitioners are encouraged to store their state as if the entire// file is sensitive.Sensitivebool// Description is used in various tooling, like the language server, to// give practitioners more information about what this attribute is,// what it's for, and how it should be used. It should be written as// plain text, with no special formatting.Descriptionstring// MarkdownDescription is used in various tooling, like the// documentation generator, to give practitioners more information// about what this attribute is, what it's for, and how it should be// used. It should be formatted using Markdown.MarkdownDescriptionstring// DeprecationMessage defines warning diagnostic details to display when// practitioner configurations use this Attribute. The warning diagnostic// summary is automatically set to "Attribute Deprecated" along with// configuration source file and line information.//// Set this field to a practitioner actionable message such as:////  - "Configure other_attribute instead. This attribute will be removed//    in the next major version of the provider."//  - "Remove this attribute's configuration as it no longer is used and//    the attribute will be removed in the next major version of the//    provider."//// In Terraform 1.2.7 and later, this warning diagnostic is displayed any// time a practitioner attempts to configure a value for this attribute and// certain scenarios where this attribute is referenced.//// In Terraform 1.2.6 and earlier, this warning diagnostic is only// displayed when the Attribute is Required or Optional, and if the// practitioner configuration sets the value to a known or unknown value// (which may eventually be null). It has no effect when the Attribute is// Computed-only (read-only; not Required or Optional).//// Across any Terraform version, there are no warnings raised for// practitioner configuration values set directly to null, as there is no// way for the framework to differentiate between an unset and null// configuration due to how Terraform sends configuration information// across the protocol.//// Additional information about deprecation enhancements for read-only// attributes can be found in:////  -https://github.com/hashicorp/terraform/issues/7569//DeprecationMessagestring// Validators define value validation functionality for the attribute. All// elements of the slice of AttributeValidator are run, regardless of any// previous error diagnostics.//// Many common use case validators can be found in the// github.com/hashicorp/terraform-plugin-framework-validators Go module.//// If the Type field points to a custom type that implements the// xattr.TypeWithValidate interface, the validators defined in this field// are run in addition to the validation defined by the type.Validators []validator.List// PlanModifiers defines a sequence of modifiers for this attribute at// plan time. Schema-based plan modifications occur before any// resource-level plan modifications.//// Schema-based plan modifications can adjust Terraform's plan by:////  - Requiring resource recreation. Typically used for configuration//    updates which cannot be done in-place.//  - Setting the planned value. Typically used for enhancing the plan//    to replace unknown values. Computed must be true or Terraform will//    return an error. If the plan value is known due to a known//    configuration value, the plan value cannot be changed or Terraform//    will return an error.//// Any errors will prevent further execution of this sequence or modifiers.PlanModifiers []planmodifier.List// Default defines a proposed new state (plan) value for the attribute// if the configuration value is null. Default prevents the framework// from automatically marking the value as unknown during planning when// other proposed new state changes are detected. If the attribute is// computed and the value could be altered by other changes then a default// should be avoided and a plan modifier should be used instead.Defaultdefaults.List// WriteOnly indicates that Terraform will not store this attribute value// in the plan or state artifacts.// If WriteOnly is true, either Optional or Required must also be true.// WriteOnly cannot be set with Computed.//// This functionality is only supported in Terraform 1.11 and later.// Practitioners that choose a value for this attribute with older// versions of Terraform will receive an error.WriteOnlybool}

func (ListAttribute)ApplyTerraform5AttributePathStep¶

func (aListAttribute) ApplyTerraform5AttributePathStep(steptftypes.AttributePathStep) (interface{},error)

ApplyTerraform5AttributePathStep returns the result of stepping into a listindex or an error.

func (ListAttribute)Equal¶

func (aListAttribute) Equal(ofwschema.Attribute)bool

Equal returns true if the given Attribute is a ListAttributeand all fields are equal.

func (ListAttribute)GetDeprecationMessage¶

func (aListAttribute) GetDeprecationMessage()string

GetDeprecationMessage returns the DeprecationMessage field value.

func (ListAttribute)GetDescription¶

func (aListAttribute) GetDescription()string

GetDescription returns the Description field value.

func (ListAttribute)GetMarkdownDescription¶

func (aListAttribute) GetMarkdownDescription()string

GetMarkdownDescription returns the MarkdownDescription field value.

func (ListAttribute)GetType¶

func (aListAttribute) GetType()attr.Type

GetType returns types.ListType or the CustomType field value if defined.

func (ListAttribute)IsComputed¶

func (aListAttribute) IsComputed()bool

IsComputed returns the Computed field value.

func (ListAttribute)IsOptional¶

func (aListAttribute) IsOptional()bool

IsOptional returns the Optional field value.

func (ListAttribute)IsOptionalForImport¶added inv1.15.0

func (aListAttribute) IsOptionalForImport()bool

IsOptionalForImport returns false as this behavior is only relevantfor managed resource identity schema attributes.

func (ListAttribute)IsRequired¶

func (aListAttribute) IsRequired()bool

IsRequired returns the Required field value.

func (ListAttribute)IsRequiredForImport¶added inv1.15.0

func (aListAttribute) IsRequiredForImport()bool

IsRequiredForImport returns false as this behavior is only relevantfor managed resource identity schema attributes.

func (ListAttribute)IsSensitive¶

func (aListAttribute) IsSensitive()bool

IsSensitive returns the Sensitive field value.

func (ListAttribute)IsWriteOnly¶added inv1.14.0

func (aListAttribute) IsWriteOnly()bool

IsWriteOnly returns the WriteOnly field value.

func (ListAttribute)ListDefaultValue¶added inv1.2.0

func (aListAttribute) ListDefaultValue()defaults.List

ListDefaultValue returns the Default field value.

func (ListAttribute)ListPlanModifiers¶

func (aListAttribute) ListPlanModifiers() []planmodifier.List

ListPlanModifiers returns the PlanModifiers field value.

func (ListAttribute)ListValidators¶

func (aListAttribute) ListValidators() []validator.List

ListValidators returns the Validators field value.

func (ListAttribute)ValidateImplementation¶added inv1.3.0

func (aListAttribute) ValidateImplementation(ctxcontext.Context, reqfwschema.ValidateImplementationRequest, resp *fwschema.ValidateImplementationResponse)

ValidateImplementation contains logic for validating theprovider-defined implementation of the attribute to prevent unexpectederrors or panics. This logic runs during the GetProviderSchema RPC andshould never include false positives.

type ListNestedAttribute struct {// NestedObject is the underlying object that contains nested attributes.// This field must be set.//// Nested attributes that contain a dynamic type (i.e. DynamicAttribute) are not supported.// If underlying dynamic values are required, replace this attribute definition with// DynamicAttribute instead.NestedObjectNestedAttributeObject// CustomType enables the use of a custom attribute type in place of the// default types.ListType of types.ObjectType. When retrieving data, the// basetypes.ListValuable associated with this custom type must be used in// place of types.List.CustomTypebasetypes.ListTypable// Required indicates whether the practitioner must enter a value for// this attribute or not. Required and Optional cannot both be true,// and Required and Computed cannot both be true.Requiredbool// Optional indicates whether the practitioner can choose to enter a value// for this attribute or not. Optional and Required cannot both be true.Optionalbool// Computed indicates whether the provider may return its own value for// this Attribute or not. Required and Computed cannot both be true. If// Required and Optional are both false, Computed must be true, and the// attribute will be considered "read only" for the practitioner, with// only the provider able to set its value.Computedbool// Sensitive indicates whether the value of this attribute should be// considered sensitive data. Setting it to true will obscure the value// in CLI output. Sensitive does not impact how values are stored, and// practitioners are encouraged to store their state as if the entire// file is sensitive.Sensitivebool// Description is used in various tooling, like the language server, to// give practitioners more information about what this attribute is,// what it's for, and how it should be used. It should be written as// plain text, with no special formatting.Descriptionstring// MarkdownDescription is used in various tooling, like the// documentation generator, to give practitioners more information// about what this attribute is, what it's for, and how it should be// used. It should be formatted using Markdown.MarkdownDescriptionstring// DeprecationMessage defines warning diagnostic details to display when// practitioner configurations use this Attribute. The warning diagnostic// summary is automatically set to "Attribute Deprecated" along with// configuration source file and line information.//// Set this field to a practitioner actionable message such as:////  - "Configure other_attribute instead. This attribute will be removed//    in the next major version of the provider."//  - "Remove this attribute's configuration as it no longer is used and//    the attribute will be removed in the next major version of the//    provider."//// In Terraform 1.2.7 and later, this warning diagnostic is displayed any// time a practitioner attempts to configure a value for this attribute and// certain scenarios where this attribute is referenced.//// In Terraform 1.2.6 and earlier, this warning diagnostic is only// displayed when the Attribute is Required or Optional, and if the// practitioner configuration sets the value to a known or unknown value// (which may eventually be null). It has no effect when the Attribute is// Computed-only (read-only; not Required or Optional).//// Across any Terraform version, there are no warnings raised for// practitioner configuration values set directly to null, as there is no// way for the framework to differentiate between an unset and null// configuration due to how Terraform sends configuration information// across the protocol.//// Additional information about deprecation enhancements for read-only// attributes can be found in:////  -https://github.com/hashicorp/terraform/issues/7569//DeprecationMessagestring// Validators define value validation functionality for the attribute. All// elements of the slice of AttributeValidator are run, regardless of any// previous error diagnostics.//// Many common use case validators can be found in the// github.com/hashicorp/terraform-plugin-framework-validators Go module.//// If the Type field points to a custom type that implements the// xattr.TypeWithValidate interface, the validators defined in this field// are run in addition to the validation defined by the type.Validators []validator.List// PlanModifiers defines a sequence of modifiers for this attribute at// plan time. Schema-based plan modifications occur before any// resource-level plan modifications.//// Schema-based plan modifications can adjust Terraform's plan by:////  - Requiring resource recreation. Typically used for configuration//    updates which cannot be done in-place.//  - Setting the planned value. Typically used for enhancing the plan//    to replace unknown values. Computed must be true or Terraform will//    return an error. If the plan value is known due to a known//    configuration value, the plan value cannot be changed or Terraform//    will return an error.//// Any errors will prevent further execution of this sequence or modifiers.PlanModifiers []planmodifier.List// Default defines a proposed new state (plan) value for the attribute// if the configuration value is null. Default prevents the framework// from automatically marking the value as unknown during planning when// other proposed new state changes are detected. If the attribute is// computed and the value could be altered by other changes then a default// should be avoided and a plan modifier should be used instead.Defaultdefaults.List// WriteOnly indicates that Terraform will not store this attribute value// in the plan or state artifacts.// If WriteOnly is true, either Optional or Required must also be true.// WriteOnly cannot be set with Computed.//// If WriteOnly is true for a nested attribute, all of its child attributes// must also set WriteOnly to true and no child attribute can be Computed.//// This functionality is only supported in Terraform 1.11 and later.// Practitioners that choose a value for this attribute with older// versions of Terraform will receive an error.WriteOnlybool}

func (ListNestedAttribute)ApplyTerraform5AttributePathStep¶

func (aListNestedAttribute) ApplyTerraform5AttributePathStep(steptftypes.AttributePathStep) (interface{},error)

ApplyTerraform5AttributePathStep returns the Attributes field value if stepis ElementKeyInt, otherwise returns an error.

func (ListNestedAttribute)Equal¶

func (aListNestedAttribute) Equal(ofwschema.Attribute)bool

Equal returns true if the given Attribute is a ListNestedAttributeand all fields are equal.

func (ListNestedAttribute)GetDeprecationMessage¶

func (aListNestedAttribute) GetDeprecationMessage()string

GetDeprecationMessage returns the DeprecationMessage field value.

func (ListNestedAttribute)GetDescription¶

func (aListNestedAttribute) GetDescription()string

GetDescription returns the Description field value.

func (ListNestedAttribute)GetMarkdownDescription¶

func (aListNestedAttribute) GetMarkdownDescription()string

GetMarkdownDescription returns the MarkdownDescription field value.

func (ListNestedAttribute)GetNestedObject¶

func (aListNestedAttribute) GetNestedObject()fwschema.NestedAttributeObject

GetNestedObject returns the NestedObject field value.

func (ListNestedAttribute)GetNestingMode¶

func (aListNestedAttribute) GetNestingMode()fwschema.NestingMode

GetNestingMode always returns NestingModeList.

func (ListNestedAttribute)GetType¶

func (aListNestedAttribute) GetType()attr.Type

GetType returns ListType of ObjectType or CustomType.

func (ListNestedAttribute)IsComputed¶

func (aListNestedAttribute) IsComputed()bool

IsComputed returns the Computed field value.

func (ListNestedAttribute)IsOptional¶

func (aListNestedAttribute) IsOptional()bool

IsOptional returns the Optional field value.

func (ListNestedAttribute)IsOptionalForImport¶added inv1.15.0

func (aListNestedAttribute) IsOptionalForImport()bool

IsOptionalForImport returns false as this behavior is only relevantfor managed resource identity schema attributes.

func (ListNestedAttribute)IsRequired¶

func (aListNestedAttribute) IsRequired()bool

IsRequired returns the Required field value.

func (ListNestedAttribute)IsRequiredForImport¶added inv1.15.0

func (aListNestedAttribute) IsRequiredForImport()bool

IsRequiredForImport returns false as this behavior is only relevantfor managed resource identity schema attributes.

func (ListNestedAttribute)IsSensitive¶

func (aListNestedAttribute) IsSensitive()bool

IsSensitive returns the Sensitive field value.

func (ListNestedAttribute)IsWriteOnly¶added inv1.14.0

func (aListNestedAttribute) IsWriteOnly()bool

IsWriteOnly returns the WriteOnly field value.

func (ListNestedAttribute)ListDefaultValue¶added inv1.2.0

func (aListNestedAttribute) ListDefaultValue()defaults.List

ListDefaultValue returns the Default field value.

func (ListNestedAttribute)ListPlanModifiers¶

func (aListNestedAttribute) ListPlanModifiers() []planmodifier.List

ListPlanModifiers returns the PlanModifiers field value.

func (ListNestedAttribute)ListValidators¶

func (aListNestedAttribute) ListValidators() []validator.List

ListValidators returns the Validators field value.

func (ListNestedAttribute)ValidateImplementation¶added inv1.3.0

func (aListNestedAttribute) ValidateImplementation(ctxcontext.Context, reqfwschema.ValidateImplementationRequest, resp *fwschema.ValidateImplementationResponse)

ValidateImplementation contains logic for validating theprovider-defined implementation of the attribute to prevent unexpectederrors or panics. This logic runs during the GetProviderSchema RPC andshould never include false positives.

type ListNestedBlock struct {// NestedObject is the underlying object that contains nested attributes or// blocks. This field must be set.//// Nested attributes that contain a dynamic type (i.e. DynamicAttribute) are not supported.// If underlying dynamic values are required, replace this block definition with// a DynamicAttribute.NestedObjectNestedBlockObject// CustomType enables the use of a custom attribute type in place of the// default types.ListType of types.ObjectType. When retrieving data, the// basetypes.ListValuable associated with this custom type must be used in// place of types.List.CustomTypebasetypes.ListTypable// Description is used in various tooling, like the language server, to// give practitioners more information about what this attribute is,// what it's for, and how it should be used. It should be written as// plain text, with no special formatting.Descriptionstring// MarkdownDescription is used in various tooling, like the// documentation generator, to give practitioners more information// about what this attribute is, what it's for, and how it should be// used. It should be formatted using Markdown.MarkdownDescriptionstring// DeprecationMessage defines warning diagnostic details to display when// practitioner configurations use this Attribute. The warning diagnostic// summary is automatically set to "Attribute Deprecated" along with// configuration source file and line information.//// Set this field to a practitioner actionable message such as:////  - "Configure other_attribute instead. This attribute will be removed//    in the next major version of the provider."//  - "Remove this attribute's configuration as it no longer is used and//    the attribute will be removed in the next major version of the//    provider."//// In Terraform 1.2.7 and later, this warning diagnostic is displayed any// time a practitioner attempts to configure a value for this attribute and// certain scenarios where this attribute is referenced.//// In Terraform 1.2.6 and earlier, this warning diagnostic is only// displayed when the Attribute is Required or Optional, and if the// practitioner configuration sets the value to a known or unknown value// (which may eventually be null). It has no effect when the Attribute is// Computed-only (read-only; not Required or Optional).//// Across any Terraform version, there are no warnings raised for// practitioner configuration values set directly to null, as there is no// way for the framework to differentiate between an unset and null// configuration due to how Terraform sends configuration information// across the protocol.//// Additional information about deprecation enhancements for read-only// attributes can be found in:////  -https://github.com/hashicorp/terraform/issues/7569//DeprecationMessagestring// Validators define value validation functionality for the attribute. All// elements of the slice of AttributeValidator are run, regardless of any// previous error diagnostics.//// Many common use case validators can be found in the// github.com/hashicorp/terraform-plugin-framework-validators Go module.//// If the Type field points to a custom type that implements the// xattr.TypeWithValidate interface, the validators defined in this field// are run in addition to the validation defined by the type.Validators []validator.List// PlanModifiers defines a sequence of modifiers for this attribute at// plan time. Schema-based plan modifications occur before any// resource-level plan modifications.//// Schema-based plan modifications can adjust Terraform's plan by:////  - Requiring resource recreation. Typically used for configuration//    updates which cannot be done in-place.//  - Setting the planned value. Typically used for enhancing the plan//    to replace unknown values. Computed must be true or Terraform will//    return an error. If the plan value is known due to a known//    configuration value, the plan value cannot be changed or Terraform//    will return an error.//// Any errors will prevent further execution of this sequence or modifiers.PlanModifiers []planmodifier.List}

func (ListNestedBlock)ApplyTerraform5AttributePathStep¶

func (bListNestedBlock) ApplyTerraform5AttributePathStep(steptftypes.AttributePathStep) (interface{},error)

ApplyTerraform5AttributePathStep returns the NestedObject field value if stepis ElementKeyInt, otherwise returns an error.

func (ListNestedBlock)Equal¶

func (bListNestedBlock) Equal(ofwschema.Block)bool

Equal returns true if the given Block is ListNestedBlockand all fields are equal.

func (ListNestedBlock)GetDeprecationMessage¶

func (bListNestedBlock) GetDeprecationMessage()string

GetDeprecationMessage returns the DeprecationMessage field value.

func (ListNestedBlock)GetDescription¶

func (bListNestedBlock) GetDescription()string

GetDescription returns the Description field value.

func (ListNestedBlock)GetMarkdownDescription¶

func (bListNestedBlock) GetMarkdownDescription()string

GetMarkdownDescription returns the MarkdownDescription field value.

func (ListNestedBlock)GetNestedObject¶

func (bListNestedBlock) GetNestedObject()fwschema.NestedBlockObject

GetNestedObject returns the NestedObject field value.

func (ListNestedBlock)GetNestingMode¶

func (bListNestedBlock) GetNestingMode()fwschema.BlockNestingMode

GetNestingMode always returns BlockNestingModeList.

func (ListNestedBlock)ListPlanModifiers¶

func (bListNestedBlock) ListPlanModifiers() []planmodifier.List

ListPlanModifiers returns the PlanModifiers field value.

func (ListNestedBlock)ListValidators¶

func (bListNestedBlock) ListValidators() []validator.List

ListValidators returns the Validators field value.

func (ListNestedBlock)Type¶

func (bListNestedBlock) Type()attr.Type

Type returns ListType of ObjectType or CustomType.

func (ListNestedBlock)ValidateImplementation¶added inv1.7.0

func (bListNestedBlock) ValidateImplementation(ctxcontext.Context, reqfwschema.ValidateImplementationRequest, resp *fwschema.ValidateImplementationResponse)

ValidateImplementation contains logic for validating theprovider-defined implementation of the block to prevent unexpectederrors or panics. This logic runs during the GetProviderSchema RPC andshould never include false positives.

type MapAttribute struct {// ElementType is the type for all elements of the map. This field must be// set.//// Element types that contain a dynamic type (i.e. types.Dynamic) are not supported.// If underlying dynamic values are required, replace this attribute definition with// DynamicAttribute instead.ElementTypeattr.Type// CustomType enables the use of a custom attribute type in place of the// default basetypes.MapType. When retrieving data, the basetypes.MapValuable// associated with this custom type must be used in place of types.Map.CustomTypebasetypes.MapTypable// Required indicates whether the practitioner must enter a value for// this attribute or not. Required and Optional cannot both be true,// and Required and Computed cannot both be true.Requiredbool// Optional indicates whether the practitioner can choose to enter a value// for this attribute or not. Optional and Required cannot both be true.Optionalbool// Computed indicates whether the provider may return its own value for// this Attribute or not. Required and Computed cannot both be true. If// Required and Optional are both false, Computed must be true, and the// attribute will be considered "read only" for the practitioner, with// only the provider able to set its value.Computedbool// Sensitive indicates whether the value of this attribute should be// considered sensitive data. Setting it to true will obscure the value// in CLI output. Sensitive does not impact how values are stored, and// practitioners are encouraged to store their state as if the entire// file is sensitive.Sensitivebool// Description is used in various tooling, like the language server, to// give practitioners more information about what this attribute is,// what it's for, and how it should be used. It should be written as// plain text, with no special formatting.Descriptionstring// MarkdownDescription is used in various tooling, like the// documentation generator, to give practitioners more information// about what this attribute is, what it's for, and how it should be// used. It should be formatted using Markdown.MarkdownDescriptionstring// DeprecationMessage defines warning diagnostic details to display when// practitioner configurations use this Attribute. The warning diagnostic// summary is automatically set to "Attribute Deprecated" along with// configuration source file and line information.//// Set this field to a practitioner actionable message such as:////  - "Configure other_attribute instead. This attribute will be removed//    in the next major version of the provider."//  - "Remove this attribute's configuration as it no longer is used and//    the attribute will be removed in the next major version of the//    provider."//// In Terraform 1.2.7 and later, this warning diagnostic is displayed any// time a practitioner attempts to configure a value for this attribute and// certain scenarios where this attribute is referenced.//// In Terraform 1.2.6 and earlier, this warning diagnostic is only// displayed when the Attribute is Required or Optional, and if the// practitioner configuration sets the value to a known or unknown value// (which may eventually be null). It has no effect when the Attribute is// Computed-only (read-only; not Required or Optional).//// Across any Terraform version, there are no warnings raised for// practitioner configuration values set directly to null, as there is no// way for the framework to differentiate between an unset and null// configuration due to how Terraform sends configuration information// across the protocol.//// Additional information about deprecation enhancements for read-only// attributes can be found in:////  -https://github.com/hashicorp/terraform/issues/7569//DeprecationMessagestring// Validators define value validation functionality for the attribute. All// elements of the slice of AttributeValidator are run, regardless of any// previous error diagnostics.//// Many common use case validators can be found in the// github.com/hashicorp/terraform-plugin-framework-validators Go module.//// If the Type field points to a custom type that implements the// xattr.TypeWithValidate interface, the validators defined in this field// are run in addition to the validation defined by the type.Validators []validator.Map// PlanModifiers defines a sequence of modifiers for this attribute at// plan time. Schema-based plan modifications occur before any// resource-level plan modifications.//// Schema-based plan modifications can adjust Terraform's plan by:////  - Requiring resource recreation. Typically used for configuration//    updates which cannot be done in-place.//  - Setting the planned value. Typically used for enhancing the plan//    to replace unknown values. Computed must be true or Terraform will//    return an error. If the plan value is known due to a known//    configuration value, the plan value cannot be changed or Terraform//    will return an error.//// Any errors will prevent further execution of this sequence or modifiers.PlanModifiers []planmodifier.Map// Default defines a proposed new state (plan) value for the attribute// if the configuration value is null. Default prevents the framework// from automatically marking the value as unknown during planning when// other proposed new state changes are detected. If the attribute is// computed and the value could be altered by other changes then a default// should be avoided and a plan modifier should be used instead.Defaultdefaults.Map// WriteOnly indicates that Terraform will not store this attribute value// in the plan or state artifacts.// If WriteOnly is true, either Optional or Required must also be true.// WriteOnly cannot be set with Computed.//// This functionality is only supported in Terraform 1.11 and later.// Practitioners that choose a value for this attribute with older// versions of Terraform will receive an error.WriteOnlybool}

func (MapAttribute)ApplyTerraform5AttributePathStep¶

func (aMapAttribute) ApplyTerraform5AttributePathStep(steptftypes.AttributePathStep) (interface{},error)

ApplyTerraform5AttributePathStep returns the result of stepping into a mapindex or an error.

func (MapAttribute)Equal¶

func (aMapAttribute) Equal(ofwschema.Attribute)bool

Equal returns true if the given Attribute is a MapAttributeand all fields are equal.

func (MapAttribute)GetDeprecationMessage¶

func (aMapAttribute) GetDeprecationMessage()string

GetDeprecationMessage returns the DeprecationMessage field value.

func (MapAttribute)GetDescription¶

func (aMapAttribute) GetDescription()string

GetDescription returns the Description field value.

func (MapAttribute)GetMarkdownDescription¶

func (aMapAttribute) GetMarkdownDescription()string

GetMarkdownDescription returns the MarkdownDescription field value.

func (MapAttribute)GetType¶

func (aMapAttribute) GetType()attr.Type

GetType returns types.MapType or the CustomType field value if defined.

func (MapAttribute)IsComputed¶

func (aMapAttribute) IsComputed()bool

IsComputed returns the Computed field value.

func (MapAttribute)IsOptional¶

func (aMapAttribute) IsOptional()bool

IsOptional returns the Optional field value.

func (MapAttribute)IsOptionalForImport¶added inv1.15.0

func (aMapAttribute) IsOptionalForImport()bool

IsOptionalForImport returns false as this behavior is only relevantfor managed resource identity schema attributes.

func (MapAttribute)IsRequired¶

func (aMapAttribute) IsRequired()bool

IsRequired returns the Required field value.

func (MapAttribute)IsRequiredForImport¶added inv1.15.0

func (aMapAttribute) IsRequiredForImport()bool

IsRequiredForImport returns false as this behavior is only relevantfor managed resource identity schema attributes.

func (MapAttribute)IsSensitive¶

func (aMapAttribute) IsSensitive()bool

IsSensitive returns the Sensitive field value.

func (MapAttribute)IsWriteOnly¶added inv1.14.0

func (aMapAttribute) IsWriteOnly()bool

IsWriteOnly returns the WriteOnly field value.

func (MapAttribute)MapDefaultValue¶added inv1.2.0

func (aMapAttribute) MapDefaultValue()defaults.Map

MapDefaultValue returns the Default field value.

func (MapAttribute)MapPlanModifiers¶

func (aMapAttribute) MapPlanModifiers() []planmodifier.Map

MapPlanModifiers returns the PlanModifiers field value.

func (MapAttribute)MapValidators¶

func (aMapAttribute) MapValidators() []validator.Map

MapValidators returns the Validators field value.

func (MapAttribute)ValidateImplementation¶added inv1.3.0

func (aMapAttribute) ValidateImplementation(ctxcontext.Context, reqfwschema.ValidateImplementationRequest, resp *fwschema.ValidateImplementationResponse)

ValidateImplementation contains logic for validating theprovider-defined implementation of the attribute to prevent unexpectederrors or panics. This logic runs during the GetProviderSchema RPC andshould never include false positives.

type MapNestedAttribute struct {// NestedObject is the underlying object that contains nested attributes.// This field must be set.//// Nested attributes that contain a dynamic type (i.e. DynamicAttribute) are not supported.// If underlying dynamic values are required, replace this attribute definition with// DynamicAttribute instead.NestedObjectNestedAttributeObject// CustomType enables the use of a custom attribute type in place of the// default types.MapType of types.ObjectType. When retrieving data, the// basetypes.MapValuable associated with this custom type must be used in// place of types.Map.CustomTypebasetypes.MapTypable// Required indicates whether the practitioner must enter a value for// this attribute or not. Required and Optional cannot both be true,// and Required and Computed cannot both be true.Requiredbool// Optional indicates whether the practitioner can choose to enter a value// for this attribute or not. Optional and Required cannot both be true.Optionalbool// Computed indicates whether the provider may return its own value for// this Attribute or not. Required and Computed cannot both be true. If// Required and Optional are both false, Computed must be true, and the// attribute will be considered "read only" for the practitioner, with// only the provider able to set its value.Computedbool// Sensitive indicates whether the value of this attribute should be// considered sensitive data. Setting it to true will obscure the value// in CLI output. Sensitive does not impact how values are stored, and// practitioners are encouraged to store their state as if the entire// file is sensitive.Sensitivebool// Description is used in various tooling, like the language server, to// give practitioners more information about what this attribute is,// what it's for, and how it should be used. It should be written as// plain text, with no special formatting.Descriptionstring// MarkdownDescription is used in various tooling, like the// documentation generator, to give practitioners more information// about what this attribute is, what it's for, and how it should be// used. It should be formatted using Markdown.MarkdownDescriptionstring// DeprecationMessage defines warning diagnostic details to display when// practitioner configurations use this Attribute. The warning diagnostic// summary is automatically set to "Attribute Deprecated" along with// configuration source file and line information.//// Set this field to a practitioner actionable message such as:////  - "Configure other_attribute instead. This attribute will be removed//    in the next major version of the provider."//  - "Remove this attribute's configuration as it no longer is used and//    the attribute will be removed in the next major version of the//    provider."//// In Terraform 1.2.7 and later, this warning diagnostic is displayed any// time a practitioner attempts to configure a value for this attribute and// certain scenarios where this attribute is referenced.//// In Terraform 1.2.6 and earlier, this warning diagnostic is only// displayed when the Attribute is Required or Optional, and if the// practitioner configuration sets the value to a known or unknown value// (which may eventually be null). It has no effect when the Attribute is// Computed-only (read-only; not Required or Optional).//// Across any Terraform version, there are no warnings raised for// practitioner configuration values set directly to null, as there is no// way for the framework to differentiate between an unset and null// configuration due to how Terraform sends configuration information// across the protocol.//// Additional information about deprecation enhancements for read-only// attributes can be found in:////  -https://github.com/hashicorp/terraform/issues/7569//DeprecationMessagestring// Validators define value validation functionality for the attribute. All// elements of the slice of AttributeValidator are run, regardless of any// previous error diagnostics.//// Many common use case validators can be found in the// github.com/hashicorp/terraform-plugin-framework-validators Go module.//// If the Type field points to a custom type that implements the// xattr.TypeWithValidate interface, the validators defined in this field// are run in addition to the validation defined by the type.Validators []validator.Map// PlanModifiers defines a sequence of modifiers for this attribute at// plan time. Schema-based plan modifications occur before any// resource-level plan modifications.//// Schema-based plan modifications can adjust Terraform's plan by:////  - Requiring resource recreation. Typically used for configuration//    updates which cannot be done in-place.//  - Setting the planned value. Typically used for enhancing the plan//    to replace unknown values. Computed must be true or Terraform will//    return an error. If the plan value is known due to a known//    configuration value, the plan value cannot be changed or Terraform//    will return an error.//// Any errors will prevent further execution of this sequence or modifiers.PlanModifiers []planmodifier.Map// Default defines a proposed new state (plan) value for the attribute// if the configuration value is null. Default prevents the framework// from automatically marking the value as unknown during planning when// other proposed new state changes are detected. If the attribute is// computed and the value could be altered by other changes then a default// should be avoided and a plan modifier should be used instead.Defaultdefaults.Map// WriteOnly indicates that Terraform will not store this attribute value// in the plan or state artifacts.// If WriteOnly is true, either Optional or Required must also be true.// WriteOnly cannot be set with Computed.//// If WriteOnly is true for a nested attribute, all of its child attributes// must also set WriteOnly to true and no child attribute can be Computed.//// This functionality is only supported in Terraform 1.11 and later.// Practitioners that choose a value for this attribute with older// versions of Terraform will receive an error.WriteOnlybool}

func (MapNestedAttribute)ApplyTerraform5AttributePathStep¶

func (aMapNestedAttribute) ApplyTerraform5AttributePathStep(steptftypes.AttributePathStep) (interface{},error)

ApplyTerraform5AttributePathStep returns the Attributes field value if stepis ElementKeyString, otherwise returns an error.

func (MapNestedAttribute)Equal¶

func (aMapNestedAttribute) Equal(ofwschema.Attribute)bool

Equal returns true if the given Attribute is a MapNestedAttributeand all fields are equal.

func (MapNestedAttribute)GetDeprecationMessage¶

func (aMapNestedAttribute) GetDeprecationMessage()string

GetDeprecationMessage returns the DeprecationMessage field value.

func (MapNestedAttribute)GetDescription¶

func (aMapNestedAttribute) GetDescription()string

GetDescription returns the Description field value.

func (MapNestedAttribute)GetMarkdownDescription¶

func (aMapNestedAttribute) GetMarkdownDescription()string

GetMarkdownDescription returns the MarkdownDescription field value.

func (MapNestedAttribute)GetNestedObject¶

func (aMapNestedAttribute) GetNestedObject()fwschema.NestedAttributeObject

GetNestedObject returns the NestedObject field value.

func (MapNestedAttribute)GetNestingMode¶

func (aMapNestedAttribute) GetNestingMode()fwschema.NestingMode

GetNestingMode always returns NestingModeMap.

func (MapNestedAttribute)GetType¶

func (aMapNestedAttribute) GetType()attr.Type

GetType returns MapType of ObjectType or CustomType.

func (MapNestedAttribute)IsComputed¶

func (aMapNestedAttribute) IsComputed()bool

IsComputed returns the Computed field value.

func (MapNestedAttribute)IsOptional¶

func (aMapNestedAttribute) IsOptional()bool

IsOptional returns the Optional field value.

func (MapNestedAttribute)IsOptionalForImport¶added inv1.15.0

func (aMapNestedAttribute) IsOptionalForImport()bool

IsOptionalForImport returns false as this behavior is only relevantfor managed resource identity schema attributes.

func (MapNestedAttribute)IsRequired¶

func (aMapNestedAttribute) IsRequired()bool

IsRequired returns the Required field value.

func (MapNestedAttribute)IsRequiredForImport¶added inv1.15.0

func (aMapNestedAttribute) IsRequiredForImport()bool

IsRequiredForImport returns false as this behavior is only relevantfor managed resource identity schema attributes.

func (MapNestedAttribute)IsSensitive¶

func (aMapNestedAttribute) IsSensitive()bool

IsSensitive returns the Sensitive field value.

func (MapNestedAttribute)IsWriteOnly¶added inv1.14.0

func (aMapNestedAttribute) IsWriteOnly()bool

IsWriteOnly returns the WriteOnly field value.

func (MapNestedAttribute)MapDefaultValue¶added inv1.2.0

func (aMapNestedAttribute) MapDefaultValue()defaults.Map

MapDefaultValue returns the Default field value.

func (MapNestedAttribute)MapPlanModifiers¶

func (aMapNestedAttribute) MapPlanModifiers() []planmodifier.Map

MapPlanModifiers returns the PlanModifiers field value.

func (MapNestedAttribute)MapValidators¶

func (aMapNestedAttribute) MapValidators() []validator.Map

MapValidators returns the Validators field value.

func (MapNestedAttribute)ValidateImplementation¶added inv1.3.0

func (aMapNestedAttribute) ValidateImplementation(ctxcontext.Context, reqfwschema.ValidateImplementationRequest, resp *fwschema.ValidateImplementationResponse)

ValidateImplementation contains logic for validating theprovider-defined implementation of the attribute to prevent unexpectederrors or panics. This logic runs during the GetProviderSchema RPC andshould never include false positives.

type NestedAttribute interface {Attributefwschema.NestedAttribute}

type NestedAttributeObject struct {// Attributes is the mapping of underlying attribute names to attribute// definitions. This field must be set.Attributes map[string]Attribute// CustomType enables the use of a custom attribute type in place of the// default basetypes.ObjectType. When retrieving data, the basetypes.ObjectValuable// associated with this custom type must be used in place of types.Object.CustomTypebasetypes.ObjectTypable// Validators define value validation functionality for the attribute. All// elements of the slice of AttributeValidator are run, regardless of any// previous error diagnostics.//// Many common use case validators can be found in the// github.com/hashicorp/terraform-plugin-framework-validators Go module.//// If the Type field points to a custom type that implements the// xattr.TypeWithValidate interface, the validators defined in this field// are run in addition to the validation defined by the type.Validators []validator.Object// PlanModifiers defines a sequence of modifiers for this attribute at// plan time. Schema-based plan modifications occur before any// resource-level plan modifications.//// Schema-based plan modifications can adjust Terraform's plan by:////  - Requiring resource recreation. Typically used for configuration//    updates which cannot be done in-place.//  - Setting the planned value. Typically used for enhancing the plan//    to replace unknown values. Computed must be true or Terraform will//    return an error. If the plan value is known due to a known//    configuration value, the plan value cannot be changed or Terraform//    will return an error.//// Any errors will prevent further execution of this sequence or modifiers.PlanModifiers []planmodifier.Object}

func (NestedAttributeObject)ApplyTerraform5AttributePathStep¶

func (oNestedAttributeObject) ApplyTerraform5AttributePathStep(steptftypes.AttributePathStep) (any,error)

ApplyTerraform5AttributePathStep performs an AttributeName step on theunderlying attributes or returns an error.

func (NestedAttributeObject)Equal¶

func (oNestedAttributeObject) Equal(otherfwschema.NestedAttributeObject)bool

Equal returns true if the given NestedAttributeObject is equivalent.

func (NestedAttributeObject)GetAttributes¶

func (oNestedAttributeObject) GetAttributes()fwschema.UnderlyingAttributes

GetAttributes returns the Attributes field value.

func (NestedAttributeObject)ObjectPlanModifiers¶

func (oNestedAttributeObject) ObjectPlanModifiers() []planmodifier.Object

ObjectPlanModifiers returns the PlanModifiers field value.

func (NestedAttributeObject)ObjectValidators¶

func (oNestedAttributeObject) ObjectValidators() []validator.Object

ObjectValidators returns the Validators field value.

func (NestedAttributeObject)Type¶

func (oNestedAttributeObject) Type()basetypes.ObjectTypable

Type returns the framework type of the NestedAttributeObject.

type NestedBlockObject struct {// Attributes is the mapping of underlying attribute names to attribute// definitions.//// Names must only contain lowercase letters, numbers, and underscores.// Names must not collide with any Blocks names.Attributes map[string]Attribute// Blocks is the mapping of underlying block names to block definitions.//// Names must only contain lowercase letters, numbers, and underscores.// Names must not collide with any Attributes names.Blocks map[string]Block// CustomType enables the use of a custom attribute type in place of the// default basetypes.ObjectType. When retrieving data, the basetypes.ObjectValuable// associated with this custom type must be used in place of types.Object.CustomTypebasetypes.ObjectTypable// Validators define value validation functionality for the attribute. All// elements of the slice of AttributeValidator are run, regardless of any// previous error diagnostics.//// Many common use case validators can be found in the// github.com/hashicorp/terraform-plugin-framework-validators Go module.//// If the Type field points to a custom type that implements the// xattr.TypeWithValidate interface, the validators defined in this field// are run in addition to the validation defined by the type.Validators []validator.Object// PlanModifiers defines a sequence of modifiers for this attribute at// plan time. Schema-based plan modifications occur before any// resource-level plan modifications.//// Schema-based plan modifications can adjust Terraform's plan by:////  - Requiring resource recreation. Typically used for configuration//    updates which cannot be done in-place.//  - Setting the planned value. Typically used for enhancing the plan//    to replace unknown values. Computed must be true or Terraform will//    return an error. If the plan value is known due to a known//    configuration value, the plan value cannot be changed or Terraform//    will return an error.//// Any errors will prevent further execution of this sequence or modifiers.PlanModifiers []planmodifier.Object}

func (NestedBlockObject)ApplyTerraform5AttributePathStep¶

func (oNestedBlockObject) ApplyTerraform5AttributePathStep(steptftypes.AttributePathStep) (any,error)

ApplyTerraform5AttributePathStep performs an AttributeName step on theunderlying attributes or returns an error.

func (NestedBlockObject)Equal¶

func (oNestedBlockObject) Equal(otherfwschema.NestedBlockObject)bool

Equal returns true if the given NestedBlockObject is equivalent.

func (NestedBlockObject)GetAttributes¶

func (oNestedBlockObject) GetAttributes()fwschema.UnderlyingAttributes

GetAttributes returns the Attributes field value.

func (NestedBlockObject)GetBlocks¶

func (oNestedBlockObject) GetBlocks() map[string]fwschema.Block

GetAttributes returns the Blocks field value.

func (NestedBlockObject)ObjectPlanModifiers¶

func (oNestedBlockObject) ObjectPlanModifiers() []planmodifier.Object

ObjectPlanModifiers returns the PlanModifiers field value.

func (NestedBlockObject)ObjectValidators¶

func (oNestedBlockObject) ObjectValidators() []validator.Object

ObjectValidators returns the Validators field value.

func (NestedBlockObject)Type¶

func (oNestedBlockObject) Type()basetypes.ObjectTypable

Type returns the framework type of the NestedBlockObject.

type NumberAttribute struct {// CustomType enables the use of a custom attribute type in place of the// default basetypes.NumberType. When retrieving data, the basetypes.NumberValuable// associated with this custom type must be used in place of types.Number.CustomTypebasetypes.NumberTypable// Required indicates whether the practitioner must enter a value for// this attribute or not. Required and Optional cannot both be true,// and Required and Computed cannot both be true.Requiredbool// Optional indicates whether the practitioner can choose to enter a value// for this attribute or not. Optional and Required cannot both be true.Optionalbool// Computed indicates whether the provider may return its own value for// this Attribute or not. Required and Computed cannot both be true. If// Required and Optional are both false, Computed must be true, and the// attribute will be considered "read only" for the practitioner, with// only the provider able to set its value.Computedbool// Sensitive indicates whether the value of this attribute should be// considered sensitive data. Setting it to true will obscure the value// in CLI output. Sensitive does not impact how values are stored, and// practitioners are encouraged to store their state as if the entire// file is sensitive.Sensitivebool// Description is used in various tooling, like the language server, to// give practitioners more information about what this attribute is,// what it's for, and how it should be used. It should be written as// plain text, with no special formatting.Descriptionstring// MarkdownDescription is used in various tooling, like the// documentation generator, to give practitioners more information// about what this attribute is, what it's for, and how it should be// used. It should be formatted using Markdown.MarkdownDescriptionstring// DeprecationMessage defines warning diagnostic details to display when// practitioner configurations use this Attribute. The warning diagnostic// summary is automatically set to "Attribute Deprecated" along with// configuration source file and line information.//// Set this field to a practitioner actionable message such as:////  - "Configure other_attribute instead. This attribute will be removed//    in the next major version of the provider."//  - "Remove this attribute's configuration as it no longer is used and//    the attribute will be removed in the next major version of the//    provider."//// In Terraform 1.2.7 and later, this warning diagnostic is displayed any// time a practitioner attempts to configure a value for this attribute and// certain scenarios where this attribute is referenced.//// In Terraform 1.2.6 and earlier, this warning diagnostic is only// displayed when the Attribute is Required or Optional, and if the// practitioner configuration sets the value to a known or unknown value// (which may eventually be null). It has no effect when the Attribute is// Computed-only (read-only; not Required or Optional).//// Across any Terraform version, there are no warnings raised for// practitioner configuration values set directly to null, as there is no// way for the framework to differentiate between an unset and null// configuration due to how Terraform sends configuration information// across the protocol.//// Additional information about deprecation enhancements for read-only// attributes can be found in:////  -https://github.com/hashicorp/terraform/issues/7569//DeprecationMessagestring// Validators define value validation functionality for the attribute. All// elements of the slice of AttributeValidator are run, regardless of any// previous error diagnostics.//// Many common use case validators can be found in the// github.com/hashicorp/terraform-plugin-framework-validators Go module.//// If the Type field points to a custom type that implements the// xattr.TypeWithValidate interface, the validators defined in this field// are run in addition to the validation defined by the type.Validators []validator.Number// PlanModifiers defines a sequence of modifiers for this attribute at// plan time. Schema-based plan modifications occur before any// resource-level plan modifications.//// Schema-based plan modifications can adjust Terraform's plan by:////  - Requiring resource recreation. Typically used for configuration//    updates which cannot be done in-place.//  - Setting the planned value. Typically used for enhancing the plan//    to replace unknown values. Computed must be true or Terraform will//    return an error. If the plan value is known due to a known//    configuration value, the plan value cannot be changed or Terraform//    will return an error.//// Any errors will prevent further execution of this sequence or modifiers.PlanModifiers []planmodifier.Number// Default defines a proposed new state (plan) value for the attribute// if the configuration value is null. Default prevents the framework// from automatically marking the value as unknown during planning when// other proposed new state changes are detected. If the attribute is// computed and the value could be altered by other changes then a default// should be avoided and a plan modifier should be used instead.Defaultdefaults.Number// WriteOnly indicates that Terraform will not store this attribute value// in the plan or state artifacts.// If WriteOnly is true, either Optional or Required must also be true.// WriteOnly cannot be set with Computed.//// This functionality is only supported in Terraform 1.11 and later.// Practitioners that choose a value for this attribute with older// versions of Terraform will receive an error.WriteOnlybool}

func (NumberAttribute)ApplyTerraform5AttributePathStep¶

func (aNumberAttribute) ApplyTerraform5AttributePathStep(steptftypes.AttributePathStep) (interface{},error)

ApplyTerraform5AttributePathStep always returns an error as it is notpossible to step further into a NumberAttribute.

func (NumberAttribute)Equal¶

func (aNumberAttribute) Equal(ofwschema.Attribute)bool

Equal returns true if the given Attribute is a NumberAttributeand all fields are equal.

func (NumberAttribute)GetDeprecationMessage¶

func (aNumberAttribute) GetDeprecationMessage()string

GetDeprecationMessage returns the DeprecationMessage field value.

func (NumberAttribute)GetDescription¶

func (aNumberAttribute) GetDescription()string

GetDescription returns the Description field value.

func (NumberAttribute)GetMarkdownDescription¶

func (aNumberAttribute) GetMarkdownDescription()string

GetMarkdownDescription returns the MarkdownDescription field value.

func (NumberAttribute)GetType¶

func (aNumberAttribute) GetType()attr.Type

GetType returns types.NumberType or the CustomType field value if defined.

func (NumberAttribute)IsComputed¶

func (aNumberAttribute) IsComputed()bool

IsComputed returns the Computed field value.

func (NumberAttribute)IsOptional¶

func (aNumberAttribute) IsOptional()bool

IsOptional returns the Optional field value.

func (NumberAttribute)IsOptionalForImport¶added inv1.15.0

func (aNumberAttribute) IsOptionalForImport()bool

IsOptionalForImport returns false as this behavior is only relevantfor managed resource identity schema attributes.

func (NumberAttribute)IsRequired¶

func (aNumberAttribute) IsRequired()bool

IsRequired returns the Required field value.

func (NumberAttribute)IsRequiredForImport¶added inv1.15.0

func (aNumberAttribute) IsRequiredForImport()bool

IsRequiredForImport returns false as this behavior is only relevantfor managed resource identity schema attributes.

func (NumberAttribute)IsSensitive¶

func (aNumberAttribute) IsSensitive()bool

IsSensitive returns the Sensitive field value.

func (NumberAttribute)IsWriteOnly¶added inv1.14.0

func (aNumberAttribute) IsWriteOnly()bool

IsWriteOnly returns the WriteOnly field value.

func (NumberAttribute)NumberDefaultValue¶added inv1.2.0

func (aNumberAttribute) NumberDefaultValue()defaults.Number

NumberDefaultValue returns the Default field value.

func (NumberAttribute)NumberPlanModifiers¶

func (aNumberAttribute) NumberPlanModifiers() []planmodifier.Number

NumberPlanModifiers returns the PlanModifiers field value.

func (NumberAttribute)NumberValidators¶

func (aNumberAttribute) NumberValidators() []validator.Number

NumberValidators returns the Validators field value.

func (NumberAttribute)ValidateImplementation¶added inv1.3.0

func (aNumberAttribute) ValidateImplementation(ctxcontext.Context, reqfwschema.ValidateImplementationRequest, resp *fwschema.ValidateImplementationResponse)

ValidateImplementation contains logic for validating theprovider-defined implementation of the attribute to prevent unexpectederrors or panics. This logic runs during the GetProviderSchema RPC andshould never include false positives.

type ObjectAttribute struct {// AttributeTypes is the mapping of underlying attribute names to attribute// types. This field must be set.//// Attribute types that contain a collection with a nested dynamic type (i.e. types.List[types.Dynamic]) are not supported.// If underlying dynamic collection values are required, replace this attribute definition with// DynamicAttribute instead.AttributeTypes map[string]attr.Type// CustomType enables the use of a custom attribute type in place of the// default basetypes.ObjectType. When retrieving data, the basetypes.ObjectValuable// associated with this custom type must be used in place of types.Object.CustomTypebasetypes.ObjectTypable// Required indicates whether the practitioner must enter a value for// this attribute or not. Required and Optional cannot both be true,// and Required and Computed cannot both be true.Requiredbool// Optional indicates whether the practitioner can choose to enter a value// for this attribute or not. Optional and Required cannot both be true.Optionalbool// Computed indicates whether the provider may return its own value for// this Attribute or not. Required and Computed cannot both be true. If// Required and Optional are both false, Computed must be true, and the// attribute will be considered "read only" for the practitioner, with// only the provider able to set its value.Computedbool// Sensitive indicates whether the value of this attribute should be// considered sensitive data. Setting it to true will obscure the value// in CLI output. Sensitive does not impact how values are stored, and// practitioners are encouraged to store their state as if the entire// file is sensitive.Sensitivebool// Description is used in various tooling, like the language server, to// give practitioners more information about what this attribute is,// what it's for, and how it should be used. It should be written as// plain text, with no special formatting.Descriptionstring// MarkdownDescription is used in various tooling, like the// documentation generator, to give practitioners more information// about what this attribute is, what it's for, and how it should be// used. It should be formatted using Markdown.MarkdownDescriptionstring// DeprecationMessage defines warning diagnostic details to display when// practitioner configurations use this Attribute. The warning diagnostic// summary is automatically set to "Attribute Deprecated" along with// configuration source file and line information.//// Set this field to a practitioner actionable message such as:////  - "Configure other_attribute instead. This attribute will be removed//    in the next major version of the provider."//  - "Remove this attribute's configuration as it no longer is used and//    the attribute will be removed in the next major version of the//    provider."//// In Terraform 1.2.7 and later, this warning diagnostic is displayed any// time a practitioner attempts to configure a value for this attribute and// certain scenarios where this attribute is referenced.//// In Terraform 1.2.6 and earlier, this warning diagnostic is only// displayed when the Attribute is Required or Optional, and if the// practitioner configuration sets the value to a known or unknown value// (which may eventually be null). It has no effect when the Attribute is// Computed-only (read-only; not Required or Optional).//// Across any Terraform version, there are no warnings raised for// practitioner configuration values set directly to null, as there is no// way for the framework to differentiate between an unset and null// configuration due to how Terraform sends configuration information// across the protocol.//// Additional information about deprecation enhancements for read-only// attributes can be found in:////  -https://github.com/hashicorp/terraform/issues/7569//DeprecationMessagestring// Validators define value validation functionality for the attribute. All// elements of the slice of AttributeValidator are run, regardless of any// previous error diagnostics.//// Many common use case validators can be found in the// github.com/hashicorp/terraform-plugin-framework-validators Go module.//// If the Type field points to a custom type that implements the// xattr.TypeWithValidate interface, the validators defined in this field// are run in addition to the validation defined by the type.Validators []validator.Object// PlanModifiers defines a sequence of modifiers for this attribute at// plan time. Schema-based plan modifications occur before any// resource-level plan modifications.//// Schema-based plan modifications can adjust Terraform's plan by:////  - Requiring resource recreation. Typically used for configuration//    updates which cannot be done in-place.//  - Setting the planned value. Typically used for enhancing the plan//    to replace unknown values. Computed must be true or Terraform will//    return an error. If the plan value is known due to a known//    configuration value, the plan value cannot be changed or Terraform//    will return an error.//// Any errors will prevent further execution of this sequence or modifiers.PlanModifiers []planmodifier.Object// Default defines a proposed new state (plan) value for the attribute// if the configuration value is null. Default prevents the framework// from automatically marking the value as unknown during planning when// other proposed new state changes are detected. If the attribute is// computed and the value could be altered by other changes then a default// should be avoided and a plan modifier should be used instead.Defaultdefaults.Object// WriteOnly indicates that Terraform will not store this attribute value// in the plan or state artifacts.// If WriteOnly is true, either Optional or Required must also be true.// WriteOnly cannot be set with Computed.//// This functionality is only supported in Terraform 1.11 and later.// Practitioners that choose a value for this attribute with older// versions of Terraform will receive an error.WriteOnlybool}

func (ObjectAttribute)ApplyTerraform5AttributePathStep¶

func (aObjectAttribute) ApplyTerraform5AttributePathStep(steptftypes.AttributePathStep) (interface{},error)

ApplyTerraform5AttributePathStep returns the result of stepping into anattribute name or an error.

func (ObjectAttribute)Equal¶

func (aObjectAttribute) Equal(ofwschema.Attribute)bool

Equal returns true if the given Attribute is a ObjectAttributeand all fields are equal.

func (ObjectAttribute)GetDeprecationMessage¶

func (aObjectAttribute) GetDeprecationMessage()string

GetDeprecationMessage returns the DeprecationMessage field value.

func (ObjectAttribute)GetDescription¶

func (aObjectAttribute) GetDescription()string

GetDescription returns the Description field value.

func (ObjectAttribute)GetMarkdownDescription¶

func (aObjectAttribute) GetMarkdownDescription()string

GetMarkdownDescription returns the MarkdownDescription field value.

func (ObjectAttribute)GetType¶

func (aObjectAttribute) GetType()attr.Type

GetType returns types.ObjectType or the CustomType field value if defined.

func (ObjectAttribute)IsComputed¶

func (aObjectAttribute) IsComputed()bool

IsComputed returns the Computed field value.

func (ObjectAttribute)IsOptional¶

func (aObjectAttribute) IsOptional()bool

IsOptional returns the Optional field value.

func (ObjectAttribute)IsOptionalForImport¶added inv1.15.0

func (aObjectAttribute) IsOptionalForImport()bool

IsOptionalForImport returns false as this behavior is only relevantfor managed resource identity schema attributes.

func (ObjectAttribute)IsRequired¶

func (aObjectAttribute) IsRequired()bool

IsRequired returns the Required field value.

func (ObjectAttribute)IsRequiredForImport¶added inv1.15.0

func (aObjectAttribute) IsRequiredForImport()bool

IsRequiredForImport returns false as this behavior is only relevantfor managed resource identity schema attributes.

func (ObjectAttribute)IsSensitive¶

func (aObjectAttribute) IsSensitive()bool

IsSensitive returns the Sensitive field value.

func (ObjectAttribute)IsWriteOnly¶added inv1.14.0

func (aObjectAttribute) IsWriteOnly()bool

IsWriteOnly returns the WriteOnly field value.

func (ObjectAttribute)ObjectDefaultValue¶added inv1.2.0

func (aObjectAttribute) ObjectDefaultValue()defaults.Object

ObjectDefaultValue returns the Default field value.

func (ObjectAttribute)ObjectPlanModifiers¶

func (aObjectAttribute) ObjectPlanModifiers() []planmodifier.Object

ObjectPlanModifiers returns the PlanModifiers field value.

func (ObjectAttribute)ObjectValidators¶

func (aObjectAttribute) ObjectValidators() []validator.Object

ObjectValidators returns the Validators field value.

func (ObjectAttribute)ValidateImplementation¶added inv1.3.0

func (aObjectAttribute) ValidateImplementation(ctxcontext.Context, reqfwschema.ValidateImplementationRequest, resp *fwschema.ValidateImplementationResponse)

ValidateImplementation contains logic for validating theprovider-defined implementation of the attribute to prevent unexpectederrors or panics. This logic runs during the GetProviderSchema RPC andshould never include false positives.

type Schema struct {// Attributes is the mapping of underlying attribute names to attribute// definitions.//// Names must only contain lowercase letters, numbers, and underscores.// Names must not collide with any Blocks names.Attributes map[string]Attribute// Blocks is the mapping of underlying block names to block definitions.//// Names must only contain lowercase letters, numbers, and underscores.// Names must not collide with any Attributes names.Blocks map[string]Block// Description is used in various tooling, like the language server, to// give practitioners more information about what this resource is,// what it's for, and how it should be used. It should be written as// plain text, with no special formatting.Descriptionstring// MarkdownDescription is used in various tooling, like the// documentation generator, to give practitioners more information// about what this resource is, what it's for, and how it should be// used. It should be formatted using Markdown.MarkdownDescriptionstring// DeprecationMessage defines warning diagnostic details to display when// practitioner configurations use this resource. The warning diagnostic// summary is automatically set to "Resource Deprecated" along with// configuration source file and line information.//// Set this field to a practitioner actionable message such as:////  - "Use examplecloud_other resource instead. This resource//    will be removed in the next major version of the provider."//  - "Remove this resource as it no longer is valid and//    will be removed in the next major version of the provider."//DeprecationMessagestring// Version indicates the current version of the resource schema. Resource// schema versioning enables state upgrades in conjunction with the// [resource.ResourceWithStateUpgrades] interface. Versioning is only// required if there is a breaking change involving existing state data,// such as changing an attribute or block type in a manner that is// incompatible with the Terraform type.//// Versions are conventionally only incremented by one each release.Versionint64}

func (Schema)ApplyTerraform5AttributePathStep¶

func (sSchema) ApplyTerraform5AttributePathStep(steptftypes.AttributePathStep) (any,error)

ApplyTerraform5AttributePathStep applies the given AttributePathStep to theschema.

func (Schema)AttributeAtPath¶

func (sSchema) AttributeAtPath(ctxcontext.Context, ppath.Path) (fwschema.Attribute,diag.Diagnostics)

AttributeAtPath returns the Attribute at the passed path. If the path pointsto an element or attribute of a complex type, rather than to an Attribute,it will return an ErrPathInsideAtomicAttribute error.

func (Schema)AttributeAtTerraformPath¶

func (sSchema) AttributeAtTerraformPath(ctxcontext.Context, p *tftypes.AttributePath) (fwschema.Attribute,error)

AttributeAtPath returns the Attribute at the passed path. If the path pointsto an element or attribute of a complex type, rather than to an Attribute,it will return an ErrPathInsideAtomicAttribute error.

func (Schema)GetAttributes¶

func (sSchema) GetAttributes() map[string]fwschema.Attribute

GetAttributes returns the Attributes field value.

func (Schema)GetBlocks¶

func (sSchema) GetBlocks() map[string]fwschema.Block

GetBlocks returns the Blocks field value.

func (Schema)GetDeprecationMessage¶

func (sSchema) GetDeprecationMessage()string

GetDeprecationMessage returns the DeprecationMessage field value.

func (Schema)GetDescription¶

func (sSchema) GetDescription()string

GetDescription returns the Description field value.

func (Schema)GetMarkdownDescription¶

func (sSchema) GetMarkdownDescription()string

GetMarkdownDescription returns the MarkdownDescription field value.

func (Schema)GetVersion¶

func (sSchema) GetVersion()int64

GetVersion returns the Version field value.

func (Schema)Type¶

func (sSchema) Type()attr.Type

Type returns the framework type of the schema.

func (Schema)TypeAtPath¶

func (sSchema) TypeAtPath(ctxcontext.Context, ppath.Path) (attr.Type,diag.Diagnostics)

TypeAtPath returns the framework type at the given schema path.

func (Schema)TypeAtTerraformPath¶

func (sSchema) TypeAtTerraformPath(ctxcontext.Context, p *tftypes.AttributePath) (attr.Type,error)

TypeAtTerraformPath returns the framework type at the given tftypes path.

func (Schema)ValidateImplementation¶added inv1.3.0

func (sSchema) ValidateImplementation(ctxcontext.Context)diag.Diagnostics

ValidateImplementation contains logic for validating the provider-definedimplementation of the schema and underlying attributes and blocks to preventunexpected errors or panics. This logic runs during theValidateResourceConfig RPC, or via provider-defined unit testing, and shouldnever include false positives.

type SetAttribute struct {// ElementType is the type for all elements of the set. This field must be// set.//// Element types that contain a dynamic type (i.e. types.Dynamic) are not supported.// If underlying dynamic values are required, replace this attribute definition with// DynamicAttribute instead.ElementTypeattr.Type// CustomType enables the use of a custom attribute type in place of the// default basetypes.SetType. When retrieving data, the basetypes.SetValuable// associated with this custom type must be used in place of types.Set.CustomTypebasetypes.SetTypable// Required indicates whether the practitioner must enter a value for// this attribute or not. Required and Optional cannot both be true,// and Required and Computed cannot both be true.Requiredbool// Optional indicates whether the practitioner can choose to enter a value// for this attribute or not. Optional and Required cannot both be true.Optionalbool// Computed indicates whether the provider may return its own value for// this Attribute or not. Required and Computed cannot both be true. If// Required and Optional are both false, Computed must be true, and the// attribute will be considered "read only" for the practitioner, with// only the provider able to set its value.Computedbool// Sensitive indicates whether the value of this attribute should be// considered sensitive data. Setting it to true will obscure the value// in CLI output. Sensitive does not impact how values are stored, and// practitioners are encouraged to store their state as if the entire// file is sensitive.Sensitivebool// Description is used in various tooling, like the language server, to// give practitioners more information about what this attribute is,// what it's for, and how it should be used. It should be written as// plain text, with no special formatting.Descriptionstring// MarkdownDescription is used in various tooling, like the// documentation generator, to give practitioners more information// about what this attribute is, what it's for, and how it should be// used. It should be formatted using Markdown.MarkdownDescriptionstring// DeprecationMessage defines warning diagnostic details to display when// practitioner configurations use this Attribute. The warning diagnostic// summary is automatically set to "Attribute Deprecated" along with// configuration source file and line information.//// Set this field to a practitioner actionable message such as:////  - "Configure other_attribute instead. This attribute will be removed//    in the next major version of the provider."//  - "Remove this attribute's configuration as it no longer is used and//    the attribute will be removed in the next major version of the//    provider."//// In Terraform 1.2.7 and later, this warning diagnostic is displayed any// time a practitioner attempts to configure a value for this attribute and// certain scenarios where this attribute is referenced.//// In Terraform 1.2.6 and earlier, this warning diagnostic is only// displayed when the Attribute is Required or Optional, and if the// practitioner configuration sets the value to a known or unknown value// (which may eventually be null). It has no effect when the Attribute is// Computed-only (read-only; not Required or Optional).//// Across any Terraform version, there are no warnings raised for// practitioner configuration values set directly to null, as there is no// way for the framework to differentiate between an unset and null// configuration due to how Terraform sends configuration information// across the protocol.//// Additional information about deprecation enhancements for read-only// attributes can be found in:////  -https://github.com/hashicorp/terraform/issues/7569//DeprecationMessagestring// Validators define value validation functionality for the attribute. All// elements of the slice of AttributeValidator are run, regardless of any// previous error diagnostics.//// Many common use case validators can be found in the// github.com/hashicorp/terraform-plugin-framework-validators Go module.//// If the Type field points to a custom type that implements the// xattr.TypeWithValidate interface, the validators defined in this field// are run in addition to the validation defined by the type.Validators []validator.Set// PlanModifiers defines a sequence of modifiers for this attribute at// plan time. Schema-based plan modifications occur before any// resource-level plan modifications.//// Schema-based plan modifications can adjust Terraform's plan by:////  - Requiring resource recreation. Typically used for configuration//    updates which cannot be done in-place.//  - Setting the planned value. Typically used for enhancing the plan//    to replace unknown values. Computed must be true or Terraform will//    return an error. If the plan value is known due to a known//    configuration value, the plan value cannot be changed or Terraform//    will return an error.//// Any errors will prevent further execution of this sequence or modifiers.PlanModifiers []planmodifier.Set// Default defines a proposed new state (plan) value for the attribute// if the configuration value is null. Default prevents the framework// from automatically marking the value as unknown during planning when// other proposed new state changes are detected. If the attribute is// computed and the value could be altered by other changes then a default// should be avoided and a plan modifier should be used instead.Defaultdefaults.Set}

func (SetAttribute)ApplyTerraform5AttributePathStep¶

func (aSetAttribute) ApplyTerraform5AttributePathStep(steptftypes.AttributePathStep) (interface{},error)

ApplyTerraform5AttributePathStep returns the result of stepping into a setindex or an error.

func (SetAttribute)Equal¶

func (aSetAttribute) Equal(ofwschema.Attribute)bool

Equal returns true if the given Attribute is a SetAttributeand all fields are equal.

func (SetAttribute)GetDeprecationMessage¶

func (aSetAttribute) GetDeprecationMessage()string

GetDeprecationMessage returns the DeprecationMessage field value.

func (SetAttribute)GetDescription¶

func (aSetAttribute) GetDescription()string

GetDescription returns the Description field value.

func (SetAttribute)GetMarkdownDescription¶

func (aSetAttribute) GetMarkdownDescription()string

GetMarkdownDescription returns the MarkdownDescription field value.

func (SetAttribute)GetType¶

func (aSetAttribute) GetType()attr.Type

GetType returns types.SetType or the CustomType field value if defined.

func (SetAttribute)IsComputed¶

func (aSetAttribute) IsComputed()bool

IsComputed returns the Computed field value.

func (SetAttribute)IsOptional¶

func (aSetAttribute) IsOptional()bool

IsOptional returns the Optional field value.

func (SetAttribute)IsOptionalForImport¶added inv1.15.0

func (aSetAttribute) IsOptionalForImport()bool

IsOptionalForImport returns false as this behavior is only relevantfor managed resource identity schema attributes.

func (SetAttribute)IsRequired¶

func (aSetAttribute) IsRequired()bool

IsRequired returns the Required field value.

func (SetAttribute)IsRequiredForImport¶added inv1.15.0

func (aSetAttribute) IsRequiredForImport()bool

IsRequiredForImport returns false as this behavior is only relevantfor managed resource identity schema attributes.

func (SetAttribute)IsSensitive¶

func (aSetAttribute) IsSensitive()bool

IsSensitive returns the Sensitive field value.

func (SetAttribute)IsWriteOnly¶added inv1.14.0

func (aSetAttribute) IsWriteOnly()bool

IsWriteOnly returns false as write-only attributes are not supported for sets and set-based data.

func (SetAttribute)SetDefaultValue¶added inv1.2.0

func (aSetAttribute) SetDefaultValue()defaults.Set

SetDefaultValue returns the Default field value.

func (SetAttribute)SetPlanModifiers¶

func (aSetAttribute) SetPlanModifiers() []planmodifier.Set

SetPlanModifiers returns the PlanModifiers field value.

func (SetAttribute)SetValidators¶

func (aSetAttribute) SetValidators() []validator.Set

SetValidators returns the Validators field value.

func (SetAttribute)ValidateImplementation¶added inv1.3.0

func (aSetAttribute) ValidateImplementation(ctxcontext.Context, reqfwschema.ValidateImplementationRequest, resp *fwschema.ValidateImplementationResponse)

ValidateImplementation contains logic for validating theprovider-defined implementation of the attribute to prevent unexpectederrors or panics. This logic runs during the GetProviderSchema RPC andshould never include false positives.

type SetNestedAttribute struct {// NestedObject is the underlying object that contains nested attributes.// This field must be set.//// Nested attributes that contain a dynamic type (i.e. DynamicAttribute) are not supported.// If underlying dynamic values are required, replace this attribute definition with// DynamicAttribute instead.NestedObjectNestedAttributeObject// CustomType enables the use of a custom attribute type in place of the// default types.SetType of types.ObjectType. When retrieving data, the// basetypes.SetValuable associated with this custom type must be used in// place of types.Set.CustomTypebasetypes.SetTypable// Required indicates whether the practitioner must enter a value for// this attribute or not. Required and Optional cannot both be true,// and Required and Computed cannot both be true.Requiredbool// Optional indicates whether the practitioner can choose to enter a value// for this attribute or not. Optional and Required cannot both be true.Optionalbool// Computed indicates whether the provider may return its own value for// this Attribute or not. Required and Computed cannot both be true. If// Required and Optional are both false, Computed must be true, and the// attribute will be considered "read only" for the practitioner, with// only the provider able to set its value.Computedbool// Sensitive indicates whether the value of this attribute should be// considered sensitive data. Setting it to true will obscure the value// in CLI output. Sensitive does not impact how values are stored, and// practitioners are encouraged to store their state as if the entire// file is sensitive.Sensitivebool// Description is used in various tooling, like the language server, to// give practitioners more information about what this attribute is,// what it's for, and how it should be used. It should be written as// plain text, with no special formatting.Descriptionstring// MarkdownDescription is used in various tooling, like the// documentation generator, to give practitioners more information// about what this attribute is, what it's for, and how it should be// used. It should be formatted using Markdown.MarkdownDescriptionstring// DeprecationMessage defines warning diagnostic details to display when// practitioner configurations use this Attribute. The warning diagnostic// summary is automatically set to "Attribute Deprecated" along with// configuration source file and line information.//// Set this field to a practitioner actionable message such as:////  - "Configure other_attribute instead. This attribute will be removed//    in the next major version of the provider."//  - "Remove this attribute's configuration as it no longer is used and//    the attribute will be removed in the next major version of the//    provider."//// In Terraform 1.2.7 and later, this warning diagnostic is displayed any// time a practitioner attempts to configure a value for this attribute and// certain scenarios where this attribute is referenced.//// In Terraform 1.2.6 and earlier, this warning diagnostic is only// displayed when the Attribute is Required or Optional, and if the// practitioner configuration sets the value to a known or unknown value// (which may eventually be null). It has no effect when the Attribute is// Computed-only (read-only; not Required or Optional).//// Across any Terraform version, there are no warnings raised for// practitioner configuration values set directly to null, as there is no// way for the framework to differentiate between an unset and null// configuration due to how Terraform sends configuration information// across the protocol.//// Additional information about deprecation enhancements for read-only// attributes can be found in:////  -https://github.com/hashicorp/terraform/issues/7569//DeprecationMessagestring// Validators define value validation functionality for the attribute. All// elements of the slice of AttributeValidator are run, regardless of any// previous error diagnostics.//// Many common use case validators can be found in the// github.com/hashicorp/terraform-plugin-framework-validators Go module.//// If the Type field points to a custom type that implements the// xattr.TypeWithValidate interface, the validators defined in this field// are run in addition to the validation defined by the type.Validators []validator.Set// PlanModifiers defines a sequence of modifiers for this attribute at// plan time. Schema-based plan modifications occur before any// resource-level plan modifications.//// Schema-based plan modifications can adjust Terraform's plan by:////  - Requiring resource recreation. Typically used for configuration//    updates which cannot be done in-place.//  - Setting the planned value. Typically used for enhancing the plan//    to replace unknown values. Computed must be true or Terraform will//    return an error. If the plan value is known due to a known//    configuration value, the plan value cannot be changed or Terraform//    will return an error.//// Any errors will prevent further execution of this sequence or modifiers.PlanModifiers []planmodifier.Set// Default defines a proposed new state (plan) value for the attribute// if the configuration value is null. Default prevents the framework// from automatically marking the value as unknown during planning when// other proposed new state changes are detected. If the attribute is// computed and the value could be altered by other changes then a default// should be avoided and a plan modifier should be used instead.Defaultdefaults.Set}

func (SetNestedAttribute)ApplyTerraform5AttributePathStep¶

func (aSetNestedAttribute) ApplyTerraform5AttributePathStep(steptftypes.AttributePathStep) (interface{},error)

ApplyTerraform5AttributePathStep returns the Attributes field value if stepis ElementKeyValue, otherwise returns an error.

func (SetNestedAttribute)Equal¶

func (aSetNestedAttribute) Equal(ofwschema.Attribute)bool

Equal returns true if the given Attribute is a SetNestedAttributeand all fields are equal.

func (SetNestedAttribute)GetDeprecationMessage¶

func (aSetNestedAttribute) GetDeprecationMessage()string

GetDeprecationMessage returns the DeprecationMessage field value.

func (SetNestedAttribute)GetDescription¶

func (aSetNestedAttribute) GetDescription()string

GetDescription returns the Description field value.

func (SetNestedAttribute)GetMarkdownDescription¶

func (aSetNestedAttribute) GetMarkdownDescription()string

GetMarkdownDescription returns the MarkdownDescription field value.

func (SetNestedAttribute)GetNestedObject¶

func (aSetNestedAttribute) GetNestedObject()fwschema.NestedAttributeObject

GetNestedObject returns the NestedObject field value.

func (SetNestedAttribute)GetNestingMode¶

func (aSetNestedAttribute) GetNestingMode()fwschema.NestingMode

GetNestingMode always returns NestingModeSet.

func (SetNestedAttribute)GetType¶

func (aSetNestedAttribute) GetType()attr.Type

GetType returns SetType of ObjectType or CustomType.

func (SetNestedAttribute)IsComputed¶

func (aSetNestedAttribute) IsComputed()bool

IsComputed returns the Computed field value.

func (SetNestedAttribute)IsOptional¶

func (aSetNestedAttribute) IsOptional()bool

IsOptional returns the Optional field value.

func (SetNestedAttribute)IsOptionalForImport¶added inv1.15.0

func (aSetNestedAttribute) IsOptionalForImport()bool

IsOptionalForImport returns false as this behavior is only relevantfor managed resource identity schema attributes.

func (SetNestedAttribute)IsRequired¶

func (aSetNestedAttribute) IsRequired()bool

IsRequired returns the Required field value.

func (SetNestedAttribute)IsRequiredForImport¶added inv1.15.0

func (aSetNestedAttribute) IsRequiredForImport()bool

IsRequiredForImport returns false as this behavior is only relevantfor managed resource identity schema attributes.

func (SetNestedAttribute)IsSensitive¶

func (aSetNestedAttribute) IsSensitive()bool

IsSensitive returns the Sensitive field value.

func (SetNestedAttribute)IsWriteOnly¶added inv1.14.0

func (aSetNestedAttribute) IsWriteOnly()bool

IsWriteOnly returns false as write-only attributes are not supported for sets and set-based data.

func (SetNestedAttribute)SetDefaultValue¶added inv1.2.0

func (aSetNestedAttribute) SetDefaultValue()defaults.Set

SetDefaultValue returns the Default field value.

func (SetNestedAttribute)SetPlanModifiers¶

func (aSetNestedAttribute) SetPlanModifiers() []planmodifier.Set

SetPlanModifiers returns the PlanModifiers field value.

func (SetNestedAttribute)SetValidators¶

func (aSetNestedAttribute) SetValidators() []validator.Set

SetValidators returns the Validators field value.

func (SetNestedAttribute)ValidateImplementation¶added inv1.3.0

func (aSetNestedAttribute) ValidateImplementation(ctxcontext.Context, reqfwschema.ValidateImplementationRequest, resp *fwschema.ValidateImplementationResponse)

ValidateImplementation contains logic for validating theprovider-defined implementation of the attribute to prevent unexpectederrors or panics. This logic runs during the GetProviderSchema RPC andshould never include false positives.

type SetNestedBlock struct {// NestedObject is the underlying object that contains nested attributes or// blocks. This field must be set.//// Nested attributes that contain a dynamic type (i.e. DynamicAttribute) are not supported.// If underlying dynamic values are required, replace this block definition with// a DynamicAttribute.NestedObjectNestedBlockObject// CustomType enables the use of a custom attribute type in place of the// default types.SetType of types.ObjectType. When retrieving data, the// basetypes.SetValuable associated with this custom type must be used in// place of types.Set.CustomTypebasetypes.SetTypable// Description is used in various tooling, like the language server, to// give practitioners more information about what this attribute is,// what it's for, and how it should be used. It should be written as// plain text, with no special formatting.Descriptionstring// MarkdownDescription is used in various tooling, like the// documentation generator, to give practitioners more information// about what this attribute is, what it's for, and how it should be// used. It should be formatted using Markdown.MarkdownDescriptionstring// DeprecationMessage defines warning diagnostic details to display when// practitioner configurations use this Attribute. The warning diagnostic// summary is automatically set to "Attribute Deprecated" along with// configuration source file and line information.//// Set this field to a practitioner actionable message such as:////  - "Configure other_attribute instead. This attribute will be removed//    in the next major version of the provider."//  - "Remove this attribute's configuration as it no longer is used and//    the attribute will be removed in the next major version of the//    provider."//// In Terraform 1.2.7 and later, this warning diagnostic is displayed any// time a practitioner attempts to configure a value for this attribute and// certain scenarios where this attribute is referenced.//// In Terraform 1.2.6 and earlier, this warning diagnostic is only// displayed when the Attribute is Required or Optional, and if the// practitioner configuration sets the value to a known or unknown value// (which may eventually be null). It has no effect when the Attribute is// Computed-only (read-only; not Required or Optional).//// Across any Terraform version, there are no warnings raised for// practitioner configuration values set directly to null, as there is no// way for the framework to differentiate between an unset and null// configuration due to how Terraform sends configuration information// across the protocol.//// Additional information about deprecation enhancements for read-only// attributes can be found in:////  -https://github.com/hashicorp/terraform/issues/7569//DeprecationMessagestring// Validators define value validation functionality for the attribute. All// elements of the slice of AttributeValidator are run, regardless of any// previous error diagnostics.//// Many common use case validators can be found in the// github.com/hashicorp/terraform-plugin-framework-validators Go module.//// If the Type field points to a custom type that implements the// xattr.TypeWithValidate interface, the validators defined in this field// are run in addition to the validation defined by the type.Validators []validator.Set// PlanModifiers defines a sequence of modifiers for this attribute at// plan time. Schema-based plan modifications occur before any// resource-level plan modifications.//// Schema-based plan modifications can adjust Terraform's plan by:////  - Requiring resource recreation. Typically used for configuration//    updates which cannot be done in-place.//  - Setting the planned value. Typically used for enhancing the plan//    to replace unknown values. Computed must be true or Terraform will//    return an error. If the plan value is known due to a known//    configuration value, the plan value cannot be changed or Terraform//    will return an error.//// Any errors will prevent further execution of this sequence or modifiers.PlanModifiers []planmodifier.Set}

func (SetNestedBlock)ApplyTerraform5AttributePathStep¶

func (bSetNestedBlock) ApplyTerraform5AttributePathStep(steptftypes.AttributePathStep) (interface{},error)

ApplyTerraform5AttributePathStep returns the NestedObject field value if stepis ElementKeyValue, otherwise returns an error.

func (SetNestedBlock)Equal¶

func (bSetNestedBlock) Equal(ofwschema.Block)bool

Equal returns true if the given Block is SetNestedBlockand all fields are equal.

func (SetNestedBlock)GetDeprecationMessage¶

func (bSetNestedBlock) GetDeprecationMessage()string

GetDeprecationMessage returns the DeprecationMessage field value.

func (SetNestedBlock)GetDescription¶

func (bSetNestedBlock) GetDescription()string

GetDescription returns the Description field value.

func (SetNestedBlock)GetMarkdownDescription¶

func (bSetNestedBlock) GetMarkdownDescription()string

GetMarkdownDescription returns the MarkdownDescription field value.

func (SetNestedBlock)GetNestedObject¶

func (bSetNestedBlock) GetNestedObject()fwschema.NestedBlockObject

GetNestedObject returns the NestedObject field value.

func (SetNestedBlock)GetNestingMode¶

func (bSetNestedBlock) GetNestingMode()fwschema.BlockNestingMode

GetNestingMode always returns BlockNestingModeSet.

func (SetNestedBlock)SetPlanModifiers¶

func (bSetNestedBlock) SetPlanModifiers() []planmodifier.Set

SetPlanModifiers returns the PlanModifiers field value.

func (SetNestedBlock)SetValidators¶

func (bSetNestedBlock) SetValidators() []validator.Set

SetValidators returns the Validators field value.

func (SetNestedBlock)Type¶

func (bSetNestedBlock) Type()attr.Type

Type returns SetType of ObjectType or CustomType.

func (SetNestedBlock)ValidateImplementation¶added inv1.7.0

func (bSetNestedBlock) ValidateImplementation(ctxcontext.Context, reqfwschema.ValidateImplementationRequest, resp *fwschema.ValidateImplementationResponse)

ValidateImplementation contains logic for validating theprovider-defined implementation of the block to prevent unexpectederrors or panics. This logic runs during the GetProviderSchema RPC andshould never include false positives.

type SingleNestedAttribute struct {// Attributes is the mapping of underlying attribute names to attribute// definitions. This field must be set.Attributes map[string]Attribute// CustomType enables the use of a custom attribute type in place of the// default basetypes.ObjectType. When retrieving data, the basetypes.ObjectValuable// associated with this custom type must be used in place of types.Object.CustomTypebasetypes.ObjectTypable// Required indicates whether the practitioner must enter a value for// this attribute or not. Required and Optional cannot both be true,// and Required and Computed cannot both be true.Requiredbool// Optional indicates whether the practitioner can choose to enter a value// for this attribute or not. Optional and Required cannot both be true.Optionalbool// Computed indicates whether the provider may return its own value for// this Attribute or not. Required and Computed cannot both be true. If// Required and Optional are both false, Computed must be true, and the// attribute will be considered "read only" for the practitioner, with// only the provider able to set its value.Computedbool// Sensitive indicates whether the value of this attribute should be// considered sensitive data. Setting it to true will obscure the value// in CLI output. Sensitive does not impact how values are stored, and// practitioners are encouraged to store their state as if the entire// file is sensitive.Sensitivebool// Description is used in various tooling, like the language server, to// give practitioners more information about what this attribute is,// what it's for, and how it should be used. It should be written as// plain text, with no special formatting.Descriptionstring// MarkdownDescription is used in various tooling, like the// documentation generator, to give practitioners more information// about what this attribute is, what it's for, and how it should be// used. It should be formatted using Markdown.MarkdownDescriptionstring// DeprecationMessage defines warning diagnostic details to display when// practitioner configurations use this Attribute. The warning diagnostic// summary is automatically set to "Attribute Deprecated" along with// configuration source file and line information.//// Set this field to a practitioner actionable message such as:////  - "Configure other_attribute instead. This attribute will be removed//    in the next major version of the provider."//  - "Remove this attribute's configuration as it no longer is used and//    the attribute will be removed in the next major version of the//    provider."//// In Terraform 1.2.7 and later, this warning diagnostic is displayed any// time a practitioner attempts to configure a value for this attribute and// certain scenarios where this attribute is referenced.//// In Terraform 1.2.6 and earlier, this warning diagnostic is only// displayed when the Attribute is Required or Optional, and if the// practitioner configuration sets the value to a known or unknown value// (which may eventually be null). It has no effect when the Attribute is// Computed-only (read-only; not Required or Optional).//// Across any Terraform version, there are no warnings raised for// practitioner configuration values set directly to null, as there is no// way for the framework to differentiate between an unset and null// configuration due to how Terraform sends configuration information// across the protocol.//// Additional information about deprecation enhancements for read-only// attributes can be found in:////  -https://github.com/hashicorp/terraform/issues/7569//DeprecationMessagestring// Validators define value validation functionality for the attribute. All// elements of the slice of AttributeValidator are run, regardless of any// previous error diagnostics.//// Many common use case validators can be found in the// github.com/hashicorp/terraform-plugin-framework-validators Go module.//// If the Type field points to a custom type that implements the// xattr.TypeWithValidate interface, the validators defined in this field// are run in addition to the validation defined by the type.Validators []validator.Object// PlanModifiers defines a sequence of modifiers for this attribute at// plan time. Schema-based plan modifications occur before any// resource-level plan modifications.//// Schema-based plan modifications can adjust Terraform's plan by:////  - Requiring resource recreation. Typically used for configuration//    updates which cannot be done in-place.//  - Setting the planned value. Typically used for enhancing the plan//    to replace unknown values. Computed must be true or Terraform will//    return an error. If the plan value is known due to a known//    configuration value, the plan value cannot be changed or Terraform//    will return an error.//// Any errors will prevent further execution of this sequence or modifiers.PlanModifiers []planmodifier.Object// Default defines a proposed new state (plan) value for the attribute// if the configuration value is null. Default prevents the framework// from automatically marking the value as unknown during planning when// other proposed new state changes are detected. If the attribute is// computed and the value could be altered by other changes then a default// should be avoided and a plan modifier should be used instead.Defaultdefaults.Object// WriteOnly indicates that Terraform will not store this attribute value// in the plan or state artifacts.// If WriteOnly is true, either Optional or Required must also be true.// WriteOnly cannot be set with Computed.//// This functionality is only supported in Terraform 1.11 and later.// Practitioners that choose a value for this attribute with older// versions of Terraform will receive an error.WriteOnlybool}

func (SingleNestedAttribute)ApplyTerraform5AttributePathStep¶

func (aSingleNestedAttribute) ApplyTerraform5AttributePathStep(steptftypes.AttributePathStep) (interface{},error)

ApplyTerraform5AttributePathStep returns the Attributes field value if stepis AttributeName, otherwise returns an error.

func (SingleNestedAttribute)Equal¶

func (aSingleNestedAttribute) Equal(ofwschema.Attribute)bool

Equal returns true if the given Attribute is a SingleNestedAttributeand all fields are equal.

func (SingleNestedAttribute)GetAttributes¶

func (aSingleNestedAttribute) GetAttributes()fwschema.UnderlyingAttributes

GetAttributes returns the Attributes field value.

func (SingleNestedAttribute)GetDeprecationMessage¶

func (aSingleNestedAttribute) GetDeprecationMessage()string

GetDeprecationMessage returns the DeprecationMessage field value.

func (SingleNestedAttribute)GetDescription¶

func (aSingleNestedAttribute) GetDescription()string

GetDescription returns the Description field value.

func (SingleNestedAttribute)GetMarkdownDescription¶

func (aSingleNestedAttribute) GetMarkdownDescription()string

GetMarkdownDescription returns the MarkdownDescription field value.

func (SingleNestedAttribute)GetNestedObject¶

func (aSingleNestedAttribute) GetNestedObject()fwschema.NestedAttributeObject

GetNestedObject returns a generated NestedAttributeObject from theAttributes, CustomType, and Validators field values.

func (SingleNestedAttribute)GetNestingMode¶

func (aSingleNestedAttribute) GetNestingMode()fwschema.NestingMode

GetNestingMode always returns NestingModeSingle.

func (SingleNestedAttribute)GetType¶

func (aSingleNestedAttribute) GetType()attr.Type

GetType returns ListType of ObjectType or CustomType.

func (SingleNestedAttribute)IsComputed¶

func (aSingleNestedAttribute) IsComputed()bool

IsComputed returns the Computed field value.

func (SingleNestedAttribute)IsOptional¶

func (aSingleNestedAttribute) IsOptional()bool

IsOptional returns the Optional field value.

func (SingleNestedAttribute)IsOptionalForImport¶added inv1.15.0

func (aSingleNestedAttribute) IsOptionalForImport()bool

IsOptionalForImport returns false as this behavior is only relevantfor managed resource identity schema attributes.

func (SingleNestedAttribute)IsRequired¶

func (aSingleNestedAttribute) IsRequired()bool

IsRequired returns the Required field value.

func (SingleNestedAttribute)IsRequiredForImport¶added inv1.15.0

func (aSingleNestedAttribute) IsRequiredForImport()bool

IsRequiredForImport returns false as this behavior is only relevantfor managed resource identity schema attributes.

func (SingleNestedAttribute)IsSensitive¶

func (aSingleNestedAttribute) IsSensitive()bool

IsSensitive returns the Sensitive field value.

func (SingleNestedAttribute)IsWriteOnly¶added inv1.14.0

func (aSingleNestedAttribute) IsWriteOnly()bool

IsWriteOnly returns the WriteOnly field value.

func (SingleNestedAttribute)ObjectDefaultValue¶added inv1.2.0

func (aSingleNestedAttribute) ObjectDefaultValue()defaults.Object

ObjectDefaultValue returns the Default field value.

func (SingleNestedAttribute)ObjectPlanModifiers¶

func (aSingleNestedAttribute) ObjectPlanModifiers() []planmodifier.Object

ObjectPlanModifiers returns the PlanModifiers field value.

func (SingleNestedAttribute)ObjectValidators¶

func (aSingleNestedAttribute) ObjectValidators() []validator.Object

ObjectValidators returns the Validators field value.

func (SingleNestedAttribute)ValidateImplementation¶added inv1.3.0

func (aSingleNestedAttribute) ValidateImplementation(ctxcontext.Context, reqfwschema.ValidateImplementationRequest, resp *fwschema.ValidateImplementationResponse)

ValidateImplementation contains logic for validating theprovider-defined implementation of the attribute to prevent unexpectederrors or panics. This logic runs during the GetProviderSchema RPC andshould never include false positives.

type SingleNestedBlock struct {// Attributes is the mapping of underlying attribute names to attribute// definitions.//// Names must only contain lowercase letters, numbers, and underscores.// Names must not collide with any Blocks names.Attributes map[string]Attribute// Blocks is the mapping of underlying block names to block definitions.//// Names must only contain lowercase letters, numbers, and underscores.// Names must not collide with any Attributes names.Blocks map[string]Block// CustomType enables the use of a custom attribute type in place of the// default basetypes.ObjectType. When retrieving data, the basetypes.ObjectValuable// associated with this custom type must be used in place of types.Object.CustomTypebasetypes.ObjectTypable// Description is used in various tooling, like the language server, to// give practitioners more information about what this attribute is,// what it's for, and how it should be used. It should be written as// plain text, with no special formatting.Descriptionstring// MarkdownDescription is used in various tooling, like the// documentation generator, to give practitioners more information// about what this attribute is, what it's for, and how it should be// used. It should be formatted using Markdown.MarkdownDescriptionstring// DeprecationMessage defines warning diagnostic details to display when// practitioner configurations use this Attribute. The warning diagnostic// summary is automatically set to "Attribute Deprecated" along with// configuration source file and line information.//// Set this field to a practitioner actionable message such as:////  - "Configure other_attribute instead. This attribute will be removed//    in the next major version of the provider."//  - "Remove this attribute's configuration as it no longer is used and//    the attribute will be removed in the next major version of the//    provider."//// In Terraform 1.2.7 and later, this warning diagnostic is displayed any// time a practitioner attempts to configure a value for this attribute and// certain scenarios where this attribute is referenced.//// In Terraform 1.2.6 and earlier, this warning diagnostic is only// displayed when the Attribute is Required or Optional, and if the// practitioner configuration sets the value to a known or unknown value// (which may eventually be null). It has no effect when the Attribute is// Computed-only (read-only; not Required or Optional).//// Across any Terraform version, there are no warnings raised for// practitioner configuration values set directly to null, as there is no// way for the framework to differentiate between an unset and null// configuration due to how Terraform sends configuration information// across the protocol.//// Additional information about deprecation enhancements for read-only// attributes can be found in:////  -https://github.com/hashicorp/terraform/issues/7569//DeprecationMessagestring// Validators define value validation functionality for the attribute. All// elements of the slice of AttributeValidator are run, regardless of any// previous error diagnostics.//// Many common use case validators can be found in the// github.com/hashicorp/terraform-plugin-framework-validators Go module.//// If the Type field points to a custom type that implements the// xattr.TypeWithValidate interface, the validators defined in this field// are run in addition to the validation defined by the type.Validators []validator.Object// PlanModifiers defines a sequence of modifiers for this attribute at// plan time. Schema-based plan modifications occur before any// resource-level plan modifications.//// Schema-based plan modifications can adjust Terraform's plan by:////  - Requiring resource recreation. Typically used for configuration//    updates which cannot be done in-place.//  - Setting the planned value. Typically used for enhancing the plan//    to replace unknown values. Computed must be true or Terraform will//    return an error. If the plan value is known due to a known//    configuration value, the plan value cannot be changed or Terraform//    will return an error.//// Any errors will prevent further execution of this sequence or modifiers.PlanModifiers []planmodifier.Object}

func (SingleNestedBlock)ApplyTerraform5AttributePathStep¶

func (bSingleNestedBlock) ApplyTerraform5AttributePathStep(steptftypes.AttributePathStep) (interface{},error)

ApplyTerraform5AttributePathStep returns the Attributes field value if stepis AttributeName, otherwise returns an error.

func (SingleNestedBlock)Equal¶

func (bSingleNestedBlock) Equal(ofwschema.Block)bool

Equal returns true if the given Attribute is b SingleNestedBlockand all fields are equal.

func (SingleNestedBlock)GetDeprecationMessage¶

func (bSingleNestedBlock) GetDeprecationMessage()string

GetDeprecationMessage returns the DeprecationMessage field value.

func (SingleNestedBlock)GetDescription¶

func (bSingleNestedBlock) GetDescription()string

GetDescription returns the Description field value.

func (SingleNestedBlock)GetMarkdownDescription¶

func (bSingleNestedBlock) GetMarkdownDescription()string

GetMarkdownDescription returns the MarkdownDescription field value.

func (SingleNestedBlock)GetNestedObject¶

func (bSingleNestedBlock) GetNestedObject()fwschema.NestedBlockObject

GetNestedObject returns a generated NestedBlockObject from theAttributes, CustomType, and Validators field values.

func (SingleNestedBlock)GetNestingMode¶

func (bSingleNestedBlock) GetNestingMode()fwschema.BlockNestingMode

GetNestingMode always returns BlockNestingModeSingle.

func (SingleNestedBlock)ObjectPlanModifiers¶

func (bSingleNestedBlock) ObjectPlanModifiers() []planmodifier.Object

ObjectPlanModifiers returns the PlanModifiers field value.

func (SingleNestedBlock)ObjectValidators¶

func (bSingleNestedBlock) ObjectValidators() []validator.Object

ObjectValidators returns the Validators field value.

func (SingleNestedBlock)Type¶

func (bSingleNestedBlock) Type()attr.Type

Type returns ObjectType or CustomType.

type StringAttribute struct {// CustomType enables the use of a custom attribute type in place of the// default basetypes.StringType. When retrieving data, the basetypes.StringValuable// associated with this custom type must be used in place of types.String.CustomTypebasetypes.StringTypable// Required indicates whether the practitioner must enter a value for// this attribute or not. Required and Optional cannot both be true,// and Required and Computed cannot both be true.Requiredbool// Optional indicates whether the practitioner can choose to enter a value// for this attribute or not. Optional and Required cannot both be true.Optionalbool// Computed indicates whether the provider may return its own value for// this Attribute or not. Required and Computed cannot both be true. If// Required and Optional are both false, Computed must be true, and the// attribute will be considered "read only" for the practitioner, with// only the provider able to set its value.Computedbool// Sensitive indicates whether the value of this attribute should be// considered sensitive data. Setting it to true will obscure the value// in CLI output. Sensitive does not impact how values are stored, and// practitioners are encouraged to store their state as if the entire// file is sensitive.Sensitivebool// Description is used in various tooling, like the language server, to// give practitioners more information about what this attribute is,// what it's for, and how it should be used. It should be written as// plain text, with no special formatting.Descriptionstring// MarkdownDescription is used in various tooling, like the// documentation generator, to give practitioners more information// about what this attribute is, what it's for, and how it should be// used. It should be formatted using Markdown.MarkdownDescriptionstring// DeprecationMessage defines warning diagnostic details to display when// practitioner configurations use this Attribute. The warning diagnostic// summary is automatically set to "Attribute Deprecated" along with// configuration source file and line information.//// Set this field to a practitioner actionable message such as:////  - "Configure other_attribute instead. This attribute will be removed//    in the next major version of the provider."//  - "Remove this attribute's configuration as it no longer is used and//    the attribute will be removed in the next major version of the//    provider."//// In Terraform 1.2.7 and later, this warning diagnostic is displayed any// time a practitioner attempts to configure a value for this attribute and// certain scenarios where this attribute is referenced.//// In Terraform 1.2.6 and earlier, this warning diagnostic is only// displayed when the Attribute is Required or Optional, and if the// practitioner configuration sets the value to a known or unknown value// (which may eventually be null). It has no effect when the Attribute is// Computed-only (read-only; not Required or Optional).//// Across any Terraform version, there are no warnings raised for// practitioner configuration values set directly to null, as there is no// way for the framework to differentiate between an unset and null// configuration due to how Terraform sends configuration information// across the protocol.//// Additional information about deprecation enhancements for read-only// attributes can be found in:////  -https://github.com/hashicorp/terraform/issues/7569//DeprecationMessagestring// Validators define value validation functionality for the attribute. All// elements of the slice of AttributeValidator are run, regardless of any// previous error diagnostics.//// Many common use case validators can be found in the// github.com/hashicorp/terraform-plugin-framework-validators Go module.//// If the Type field points to a custom type that implements the// xattr.TypeWithValidate interface, the validators defined in this field// are run in addition to the validation defined by the type.Validators []validator.String// PlanModifiers defines a sequence of modifiers for this attribute at// plan time. Schema-based plan modifications occur before any// resource-level plan modifications.//// Schema-based plan modifications can adjust Terraform's plan by:////  - Requiring resource recreation. Typically used for configuration//    updates which cannot be done in-place.//  - Setting the planned value. Typically used for enhancing the plan//    to replace unknown values. Computed must be true or Terraform will//    return an error. If the plan value is known due to a known//    configuration value, the plan value cannot be changed or Terraform//    will return an error.//// Any errors will prevent further execution of this sequence or modifiers.PlanModifiers []planmodifier.String// Default defines a proposed new state (plan) value for the attribute// if the configuration value is null. Default prevents the framework// from automatically marking the value as unknown during planning when// other proposed new state changes are detected. If the attribute is// computed and the value could be altered by other changes then a default// should be avoided and a plan modifier should be used instead.Defaultdefaults.String// WriteOnly indicates that Terraform will not store this attribute value// in the plan or state artifacts.// If WriteOnly is true, either Optional or Required must also be true.// WriteOnly cannot be set with Computed.//// This functionality is only supported in Terraform 1.11 and later.// Practitioners that choose a value for this attribute with older// versions of Terraform will receive an error.WriteOnlybool}

func (StringAttribute)ApplyTerraform5AttributePathStep¶

func (aStringAttribute) ApplyTerraform5AttributePathStep(steptftypes.AttributePathStep) (interface{},error)

ApplyTerraform5AttributePathStep always returns an error as it is notpossible to step further into a StringAttribute.

func (StringAttribute)Equal¶

func (aStringAttribute) Equal(ofwschema.Attribute)bool

Equal returns true if the given Attribute is a StringAttributeand all fields are equal.

func (StringAttribute)GetDeprecationMessage¶

func (aStringAttribute) GetDeprecationMessage()string

GetDeprecationMessage returns the DeprecationMessage field value.

func (StringAttribute)GetDescription¶

func (aStringAttribute) GetDescription()string

GetDescription returns the Description field value.

func (StringAttribute)GetMarkdownDescription¶

func (aStringAttribute) GetMarkdownDescription()string

GetMarkdownDescription returns the MarkdownDescription field value.

func (StringAttribute)GetType¶

func (aStringAttribute) GetType()attr.Type

GetType returns types.StringType or the CustomType field value if defined.

func (StringAttribute)IsComputed¶

func (aStringAttribute) IsComputed()bool

IsComputed returns the Computed field value.

func (StringAttribute)IsOptional¶

func (aStringAttribute) IsOptional()bool

IsOptional returns the Optional field value.

func (StringAttribute)IsOptionalForImport¶added inv1.15.0

func (aStringAttribute) IsOptionalForImport()bool

IsOptionalForImport returns false as this behavior is only relevantfor managed resource identity schema attributes.

func (StringAttribute)IsRequired¶