Attribute define a value field inside the Schema. Implementations in this package include:
Additionally, the NestedAttribute interface extends Attribute with nested attributes. Only supported in protocol version 6. Implementations in this package include:
In practitioner configurations, an equals sign (=) is required to set the value. Configuration Reference
BoolAttribute represents a schema attribute that is a boolean. When retrieving the value for this attribute, use types.Bool as the value type unless the CustomType field is set.
Terraform configurations configure this attribute using expressions that return a boolean or directly via the true/false keywords.
example_attribute = true
Terraform configurations reference this attribute using the attribute name.
.example_attribute
ApplyTerraform5AttributePathStep always returns an error as it is not possible to step further into a BoolAttribute.
Equal returns true if the given Attribute is a BoolAttribute and all fields are equal.
GetDeprecationMessage always returns an empty string as there is no deprecation validation support for provider meta schemas.
GetDescription returns the Description field value.
GetMarkdownDescription returns the MarkdownDescription field value.
GetType returns types.StringType or the CustomType field value if defined.
IsComputed always returns false as provider schemas cannot be Computed.
IsOptional returns the Optional field value.
IsOptionalForImport returns false as this behavior is only relevant for managed resource identity schema attributes.
IsRequired returns the Required field value.
IsRequiredForImport returns false as this behavior is only relevant for managed resource identity schema attributes.
IsSensitive always returns false as there is no plan for provider meta schema data.
IsWriteOnly returns false as write-only attributes are not relevant to provider meta schemas, as these schemas describe data explicitly not saved to any artifact.
Float64Attribute represents a schema attribute that is a 64-bit floating point number. When retrieving the value for this attribute, use types.Float64 as the value type unless the CustomType field is set.
Use Int64Attribute for 64-bit integer attributes or NumberAttribute for 512-bit generic number attributes.
Terraform configurations configure this attribute using expressions that return a number or directly via a floating point value.
example_attribute = 123.45
Terraform configurations reference this attribute using the attribute name.
.example_attribute
ApplyTerraform5AttributePathStep always returns an error as it is not possible to step further into a Float64Attribute.
Equal returns true if the given Attribute is a Float64Attribute and all fields are equal.
GetDeprecationMessage always returns an empty string as there is no deprecation validation support for provider meta schemas.
GetDescription returns the Description field value.
GetMarkdownDescription returns the MarkdownDescription field value.
GetType returns types.Float64Type or the CustomType field value if defined.
IsComputed always returns false as provider schemas cannot be Computed.
IsOptional returns the Optional field value.
IsOptionalForImport returns false as this behavior is only relevant for managed resource identity schema attributes.
IsRequired returns the Required field value.
IsRequiredForImport returns false as this behavior is only relevant for managed resource identity schema attributes.
IsSensitive always returns false as there is no plan for provider meta schema data.
IsWriteOnly returns false as write-only attributes are not relevant to provider meta schemas, as these schemas describe data explicitly not saved to any artifact.
Int64Attribute represents a schema attribute that is a 64-bit integer. When retrieving the value for this attribute, use types.Int64 as the value type unless the CustomType field is set.
Use Float64Attribute for 64-bit floating point number attributes or NumberAttribute for 512-bit generic number attributes.
Terraform configurations configure this attribute using expressions that return a number or directly via an integer value.
example_attribute = 123
Terraform configurations reference this attribute using the attribute name.
.example_attribute
ApplyTerraform5AttributePathStep always returns an error as it is not possible to step further into a Int64Attribute.
Equal returns true if the given Attribute is a Int64Attribute and all fields are equal.
GetDeprecationMessage always returns an empty string as there is no deprecation validation support for provider meta schemas.
GetDescription returns the Description field value.
GetMarkdownDescription returns the MarkdownDescription field value.
GetType returns types.Int64Type or the CustomType field value if defined.
IsComputed always returns false as provider schemas cannot be Computed.
IsOptional returns the Optional field value.
IsOptionalForImport returns false as this behavior is only relevant for managed resource identity schema attributes.
IsRequired returns the Required field value.
IsRequiredForImport returns false as this behavior is only relevant for managed resource identity schema attributes.
IsSensitive always returns false as there is no plan for provider meta schema data.
IsWriteOnly returns false as write-only attributes are not relevant to provider meta schemas, as these schemas describe data explicitly not saved to any artifact.
ListAttribute represents a schema attribute that is a list with a single element type. When retrieving the value for this attribute, use types.List as the value type unless the CustomType field is set. The ElementType field must be set.
Use ListNestedAttribute if the underlying elements should be objects and require definition beyond type information.
Terraform configurations configure this attribute using expressions that return a list or directly via square brace syntax.
# list of strings example_attribute = ["first", "second"]
Terraform configurations reference this attribute using expressions that accept a list or an element directly via square brace 0-based index syntax:
# first known element .example_attribute[0]
ApplyTerraform5AttributePathStep returns the result of stepping into a list index or an error.
Equal returns true if the given Attribute is a ListAttribute and all fields are equal.
GetDeprecationMessage always returns an empty string as there is no deprecation validation support for provider meta schemas.
GetDescription returns the Description field value.
GetMarkdownDescription returns the MarkdownDescription field value.
GetType returns types.ListType or the CustomType field value if defined.
IsComputed always returns false as provider schemas cannot be Computed.
IsOptional returns the Optional field value.
IsOptionalForImport returns false as this behavior is only relevant for managed resource identity schema attributes.
IsRequired returns the Required field value.
IsRequiredForImport returns false as this behavior is only relevant for managed resource identity schema attributes.
IsSensitive always returns false as there is no plan for provider meta schema data.
IsWriteOnly returns false as write-only attributes are not relevant to provider meta schemas, as these schemas describe data explicitly not saved to any artifact.
ValidateImplementation contains logic for validating the provider-defined implementation of the attribute to prevent unexpected errors or panics. This logic runs during the GetProviderSchema RPC and should never include false positives.
ListNestedAttribute represents an attribute that is a list of objects where the object attributes can be fully defined, including further nested attributes. When retrieving the value for this attribute, use types.List as the value type unless the CustomType field is set. The NestedObject field must be set. Nested attributes are only compatible with protocol version 6.
Use ListAttribute if the underlying elements are of a single type and do not require definition beyond type information.
Terraform configurations configure this attribute using expressions that return a list of objects or directly via square and curly brace syntax.
# list of objects
example_attribute = [
{
nested_attribute = #...
},
]
Terraform configurations reference this attribute using expressions that accept a list of objects or an element directly via square brace 0-based index syntax:
# first known object .example_attribute[0] # first known object nested_attribute value .example_attribute[0].nested_attribute
ApplyTerraform5AttributePathStep returns the Attributes field value if step is ElementKeyInt, otherwise returns an error.
Equal returns true if the given Attribute is a ListNestedAttribute and all fields are equal.
GetDeprecationMessage always returns an empty string as there is no deprecation validation support for provider meta schemas.
GetDescription returns the Description field value.
GetMarkdownDescription returns the MarkdownDescription field value.
GetNestedObject returns the NestedObject field value.
GetNestingMode always returns NestingModeList.
GetType returns ListType of ObjectType or CustomType.
IsComputed always returns false as provider schemas cannot be Computed.
IsOptional returns the Optional field value.
IsOptionalForImport returns false as this behavior is only relevant for managed resource identity schema attributes.
IsRequired returns the Required field value.
IsRequiredForImport returns false as this behavior is only relevant for managed resource identity schema attributes.
IsSensitive always returns false as there is no plan for provider meta schema data.
IsWriteOnly returns false as write-only attributes are not relevant to provider meta schemas, as these schemas describe data explicitly not saved to any artifact.
MapAttribute represents a schema attribute that is a map with a single element type. When retrieving the value for this attribute, use types.Map as the value type unless the CustomType field is set. The ElementType field must be set.
Use MapNestedAttribute if the underlying elements should be objects and require definition beyond type information.
Terraform configurations configure this attribute using expressions that return a map or directly via curly brace syntax.
# map of strings
example_attribute = {
key1 = "first",
key2 = "second",
}
Terraform configurations reference this attribute using expressions that accept a map or an element directly via square brace string syntax:
# key1 known element .example_attribute["key1"]
ApplyTerraform5AttributePathStep returns the result of stepping into a map index or an error.
Equal returns true if the given Attribute is a MapAttribute and all fields are equal.
GetDeprecationMessage always returns an empty string as there is no deprecation validation support for provider meta schemas.
GetDescription returns the Description field value.
GetMarkdownDescription returns the MarkdownDescription field value.
GetType returns types.MapType or the CustomType field value if defined.
IsComputed always returns false as provider schemas cannot be Computed.
IsOptional returns the Optional field value.
IsOptionalForImport returns false as this behavior is only relevant for managed resource identity schema attributes.
IsRequired returns the Required field value.
IsRequiredForImport returns false as this behavior is only relevant for managed resource identity schema attributes.
IsSensitive always returns false as there is no plan for provider meta schema data.
IsWriteOnly returns false as write-only attributes are not relevant to provider meta schemas, as these schemas describe data explicitly not saved to any artifact.
ValidateImplementation contains logic for validating the provider-defined implementation of the attribute to prevent unexpected errors or panics. This logic runs during the GetProviderSchema RPC and should never include false positives.
MapNestedAttribute represents an attribute that is a map of objects where the object attributes can be fully defined, including further nested attributes. When retrieving the value for this attribute, use types.Map as the value type unless the CustomType field is set. The NestedObject field must be set. Nested attributes are only compatible with protocol version 6.
Use MapAttribute if the underlying elements are of a single type and do not require definition beyond type information.
Terraform configurations configure this attribute using expressions that return a map of objects or directly via curly brace syntax.
# map of objects
example_attribute = {
key = {
nested_attribute = #...
},
]
Terraform configurations reference this attribute using expressions that accept a map of objects or an element directly via square brace string syntax:
# known object at key .example_attribute["key"] # known object nested_attribute value at key .example_attribute["key"].nested_attribute
ApplyTerraform5AttributePathStep returns the Attributes field value if step is ElementKeyString, otherwise returns an error.
Equal returns true if the given Attribute is a MapNestedAttribute and all fields are equal.
GetDeprecationMessage always returns an empty string as there is no deprecation validation support for provider meta schemas.
GetDescription returns the Description field value.
GetMarkdownDescription returns the MarkdownDescription field value.
GetNestedObject returns the NestedObject field value.
GetNestingMode always returns NestingModeMap.
GetType returns MapType of ObjectType or CustomType.
IsComputed always returns false as provider schemas cannot be Computed.
IsOptional returns the Optional field value.
IsOptionalForImport returns false as this behavior is only relevant for managed resource identity schema attributes.
IsRequired returns the Required field value.
IsRequiredForImport returns false as this behavior is only relevant for managed resource identity schema attributes.
IsSensitive always returns false as there is no plan for provider meta schema data.
IsWriteOnly returns false as write-only attributes are not relevant to provider meta schemas, as these schemas describe data explicitly not saved to any artifact.
Nested attributes are only compatible with protocol version 6.
NestedAttributeObject is the object containing the underlying attributes for a ListNestedAttribute, MapNestedAttribute, SetNestedAttribute, or SingleNestedAttribute (automatically generated). When retrieving the value for this attribute, use types.Object as the value type unless the CustomType field is set. The Attributes field must be set. Nested attributes are only compatible with protocol version 6.
This object enables customizing and simplifying details within its parent NestedAttribute, therefore it cannot have Terraform schema fields such as Required, Description, etc.
ApplyTerraform5AttributePathStep performs an AttributeName step on the underlying attributes or returns an error.
Equal returns true if the given NestedAttributeObject is equivalent.
GetAttributes returns the Attributes field value.
Type returns the framework type of the NestedAttributeObject.
NumberAttribute represents a schema attribute that is a generic number with up to 512 bits of floating point or integer precision. When retrieving the value for this attribute, use types.Number as the value type unless the CustomType field is set.
Use Float64Attribute for 64-bit floating point number attributes or Int64Attribute for 64-bit integer number attributes.
Terraform configurations configure this attribute using expressions that return a number or directly via a floating point or integer value.
example_attribute = 123
Terraform configurations reference this attribute using the attribute name.
.example_attribute
ApplyTerraform5AttributePathStep always returns an error as it is not possible to step further into a NumberAttribute.
Equal returns true if the given Attribute is a NumberAttribute and all fields are equal.
GetDeprecationMessage always returns an empty string as there is no deprecation validation support for provider meta schemas.
GetDescription returns the Description field value.
GetMarkdownDescription returns the MarkdownDescription field value.
GetType returns types.NumberType or the CustomType field value if defined.
IsComputed always returns false as provider schemas cannot be Computed.
IsOptional returns the Optional field value.
IsOptionalForImport returns false as this behavior is only relevant for managed resource identity schema attributes.
IsRequired returns the Required field value.
IsRequiredForImport returns false as this behavior is only relevant for managed resource identity schema attributes.
IsSensitive always returns false as there is no plan for provider meta schema data.
IsWriteOnly returns false as write-only attributes are not relevant to provider meta schemas, as these schemas describe data explicitly not saved to any artifact.
ObjectAttribute represents a schema attribute that is an object with only type information for underlying attributes. When retrieving the value for this attribute, use types.Object as the value type unless the CustomType field is set. The AttributeTypes field must be set.
Prefer SingleNestedAttribute over ObjectAttribute if the provider is using protocol version 6 and full attribute functionality is needed.
Terraform configurations configure this attribute using expressions that return an object or directly via curly brace syntax.
# object with one attribute
example_attribute = {
underlying_attribute = #...
}
Terraform configurations reference this attribute using expressions that accept an object or an attribute directly via period syntax:
# underlying attribute .example_attribute.underlying_attribute
ApplyTerraform5AttributePathStep returns the result of stepping into an attribute name or an error.
Equal returns true if the given Attribute is a ObjectAttribute and all fields are equal.
GetDeprecationMessage always returns an empty string as there is no deprecation validation support for provider meta schemas.
GetDescription returns the Description field value.
GetMarkdownDescription returns the MarkdownDescription field value.
GetType returns types.ObjectType or the CustomType field value if defined.
IsComputed always returns false as provider schemas cannot be Computed.
IsOptional returns the Optional field value.
IsOptionalForImport returns false as this behavior is only relevant for managed resource identity schema attributes.
IsRequired returns the Required field value.
IsRequiredForImport returns false as this behavior is only relevant for managed resource identity schema attributes.
IsSensitive always returns false as there is no plan for provider meta schema data.
IsWriteOnly returns false as write-only attributes are not relevant to provider meta schemas, as these schemas describe data explicitly not saved to any artifact.
ValidateImplementation contains logic for validating the provider-defined implementation of the attribute to prevent unexpected errors or panics. This logic runs during the GetProviderSchema RPC and should never include false positives.
Schema defines the structure and value types of provider_meta configuration data. This type is used as the provider.MetaSchemaResponse type Schema field, which is implemented by the provider.ProviderWithMetaSchema type MetaSchema method.
ApplyTerraform5AttributePathStep applies the given AttributePathStep to the schema.
AttributeAtPath returns the Attribute at the passed path. If the path points to an element or attribute of a complex type, rather than to an Attribute, it will return an ErrPathInsideAtomicAttribute error.
AttributeAtPath returns the Attribute at the passed path. If the path points to an element or attribute of a complex type, rather than to an Attribute, it will return an ErrPathInsideAtomicAttribute error.
GetAttributes returns the Attributes field value.
GetBlocks always returns nil as meta schemas cannot contain blocks.
GetDeprecationMessage always returns an empty string as there is no deprecation validation support for meta schemas.
GetDescription always returns an empty string as there is no purpose for a meta schema description. The provider schema description should describe the provider itself.
GetMarkdownDescription always returns an empty string as there is no purpose for a meta schema description. The provider schema description should describe the provider itself.
GetVersion always returns 0 as provider meta schemas cannot be versioned.
Type returns the framework type of the schema.
TypeAtPath returns the framework type at the given schema path.
TypeAtTerraformPath returns the framework type at the given tftypes path.
Validate verifies that the schema is not using a reserved field name for a top-level attribute.
Deprecated: Use the ValidateImplementation method instead.
ValidateImplementation contains logic for validating the provider-defined implementation of the schema and underlying attributes and blocks to prevent unexpected errors or panics. This logic runs during the GetProviderSchema RPC, or via provider-defined unit testing, and should never include false positives.
SetAttribute represents a schema attribute that is a set with a single element type. When retrieving the value for this attribute, use types.Set as the value type unless the CustomType field is set. The ElementType field must be set.
Use SetNestedAttribute if the underlying elements should be objects and require definition beyond type information.
Terraform configurations configure this attribute using expressions that return a set or directly via square brace syntax.
# set of strings example_attribute = ["first", "second"]
Terraform configurations reference this attribute using expressions that accept a set. Sets cannot be indexed in Terraform, therefore an expression is required to access an explicit element.
ApplyTerraform5AttributePathStep returns the result of stepping into a set index or an error.
Equal returns true if the given Attribute is a SetAttribute and all fields are equal.
GetDeprecationMessage always returns an empty string as there is no deprecation validation support for provider meta schemas.
GetDescription returns the Description field value.
GetMarkdownDescription returns the MarkdownDescription field value.
GetType returns types.SetType or the CustomType field value if defined.
IsComputed always returns false as provider schemas cannot be Computed.
IsOptional returns the Optional field value.
IsOptionalForImport returns false as this behavior is only relevant for managed resource identity schema attributes.
IsRequired returns the Required field value.
IsRequiredForImport returns false as this behavior is only relevant for managed resource identity schema attributes.
IsSensitive always returns false as there is no plan for provider meta schema data.
IsWriteOnly returns false as write-only attributes are not relevant to provider meta schemas, as these schemas describe data explicitly not saved to any artifact.
ValidateImplementation contains logic for validating the provider-defined implementation of the attribute to prevent unexpected errors or panics. This logic runs during the GetProviderSchema RPC and should never include false positives.
SetNestedAttribute represents an attribute that is a set of objects where the object attributes can be fully defined, including further nested attributes. When retrieving the value for this attribute, use types.Set as the value type unless the CustomType field is set. The NestedObject field must be set. Nested attributes are only compatible with protocol version 6.
Use SetAttribute if the underlying elements are of a single type and do not require definition beyond type information.
Terraform configurations configure this attribute using expressions that return a set of objects or directly via square and curly brace syntax.
# set of objects
example_attribute = [
{
nested_attribute = #...
},
]
Terraform configurations reference this attribute using expressions that accept a set of objects. Sets cannot be indexed in Terraform, therefore an expression is required to access an explicit element.
ApplyTerraform5AttributePathStep returns the Attributes field value if step is ElementKeyValue, otherwise returns an error.
Equal returns true if the given Attribute is a SetNestedAttribute and all fields are equal.
GetDeprecationMessage always returns an empty string as there is no deprecation validation support for provider meta schemas.
GetDescription returns the Description field value.
GetMarkdownDescription returns the MarkdownDescription field value.
GetNestedObject returns the NestedObject field value.
GetNestingMode always returns NestingModeSet.
GetType returns SetType of ObjectType or CustomType.
IsComputed always returns false as provider schemas cannot be Computed.
IsOptional returns the Optional field value.
IsOptionalForImport returns false as this behavior is only relevant for managed resource identity schema attributes.
IsRequired returns the Required field value.
IsRequiredForImport returns false as this behavior is only relevant for managed resource identity schema attributes.
IsSensitive always returns false as there is no plan for provider meta schema data.
IsWriteOnly returns false as write-only attributes are not relevant to provider meta schemas, as these schemas describe data explicitly not saved to any artifact.
SingleNestedAttribute represents an attribute that is a single object where the object attributes can be fully defined, including further nested attributes. When retrieving the value for this attribute, use types.Object as the value type unless the CustomType field is set. The Attributes field must be set. Nested attributes are only compatible with protocol version 6.
Use ObjectAttribute if the underlying attributes do not require definition beyond type information.
Terraform configurations configure this attribute using expressions that return an object or directly via curly brace syntax.
# single object
example_attribute = {
nested_attribute = #...
}
Terraform configurations reference this attribute using expressions that accept an object or an attribute name directly via period syntax:
# object nested_attribute value .example_attribute.nested_attribute
ApplyTerraform5AttributePathStep returns the Attributes field value if step is AttributeName, otherwise returns an error.
Equal returns true if the given Attribute is a SingleNestedAttribute and all fields are equal.
GetAttributes returns the Attributes field value.
GetDeprecationMessage always returns an empty string as there is no deprecation validation support for provider meta schemas.
GetDescription returns the Description field value.
GetMarkdownDescription returns the MarkdownDescription field value.
GetNestedObject returns a generated NestedAttributeObject from the Attributes and CustomType field values.
GetNestingMode always returns NestingModeSingle.
GetType returns ListType of ObjectType or CustomType.
IsComputed always returns false as provider schemas cannot be Computed.
IsOptional returns the Optional field value.
IsOptionalForImport returns false as this behavior is only relevant for managed resource identity schema attributes.
IsRequired returns the Required field value.
IsRequiredForImport returns false as this behavior is only relevant for managed resource identity schema attributes.
IsSensitive always returns false as there is no plan for provider meta schema data.
IsWriteOnly returns false as write-only attributes are not relevant to provider meta schemas, as these schemas describe data explicitly not saved to any artifact.
StringAttribute represents a schema attribute that is a string. When retrieving the value for this attribute, use types.String as the value type unless the CustomType field is set.
Terraform configurations configure this attribute using expressions that return a string or directly via double quote syntax.
example_attribute = "value"
Terraform configurations reference this attribute using the attribute name.
.example_attribute
ApplyTerraform5AttributePathStep always returns an error as it is not possible to step further into a StringAttribute.
Equal returns true if the given Attribute is a StringAttribute and all fields are equal.
GetDeprecationMessage always returns an empty string as there is no deprecation validation support for provider meta schemas.
GetDescription returns the Description field value.
GetMarkdownDescription returns the MarkdownDescription field value.
GetType returns types.StringType or the CustomType field value if defined.
IsComputed always returns false as provider schemas cannot be Computed.
IsOptional returns the Optional field value.
IsOptionalForImport returns false as this behavior is only relevant for managed resource identity schema attributes.
IsRequired returns the Required field value.
IsRequiredForImport returns false as this behavior is only relevant for managed resource identity schema attributes.
IsSensitive always returns false as there is no plan for provider meta schema data.
IsWriteOnly returns false as write-only attributes are not relevant to provider meta schemas, as these schemas describe data explicitly not saved to any artifact.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4