metaschema

package
v1.5.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 11, 2024 License: MPL-2.0 Imports: 9 Imported by: 2

Documentation

Overview

Package metaschema contains all available meta schema functionality for providers. Provider meta schemas define the structure and value types for provider_meta configuration data. Meta schemas are implemented via the provider.ProviderWithMetaSchema type MetaSchema method.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Attribute 

type Attribute interface {
	fwschema.Attribute
}

Attribute define a value field inside the Schema. Implementations in this package include:

  • BoolAttribute
  • Float64Attribute
  • Int64Attribute
  • ListAttribute
  • MapAttribute
  • NumberAttribute
  • ObjectAttribute
  • SetAttribute
  • StringAttribute

Additionally, the NestedAttribute interface extends Attribute with nested attributes. Only supported in protocol version 6. Implementations in this package include:

  • ListNestedAttribute
  • MapNestedAttribute
  • SetNestedAttribute
  • SingleNestedAttribute

In practitioner configurations, an equals sign (=) is required to set the value. Configuration Reference

type BoolAttribute 

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.
	CustomType basetypes.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.
	Required bool

	// Optional indicates whether the practitioner can choose to enter a value
	// for this attribute or not. Optional and Required cannot both be true.
	Optional bool

	// 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.
	Description string

	// 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.
	MarkdownDescription string
}

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

func (BoolAttribute) ApplyTerraform5AttributePathStep 

func (a BoolAttribute) ApplyTerraform5AttributePathStep(step tftypes.AttributePathStep) (interface{}, error)

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

func (BoolAttribute) Equal 

func (a BoolAttribute) Equal(o fwschema.Attribute) bool

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

func (BoolAttribute) GetDeprecationMessage 

func (a BoolAttribute) GetDeprecationMessage() string

GetDeprecationMessage always returns an empty string as there is no deprecation validation support for provider meta schemas.

func (BoolAttribute) GetDescription 

func (a BoolAttribute) GetDescription() string

GetDescription returns the Description field value.

func (BoolAttribute) GetMarkdownDescription 

func (a BoolAttribute) GetMarkdownDescription() string

GetMarkdownDescription returns the MarkdownDescription field value.

func (BoolAttribute) GetType 

func (a BoolAttribute) GetType() attr.Type

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

func (BoolAttribute) IsComputed 

func (a BoolAttribute) IsComputed() bool

IsComputed always returns false as provider schemas cannot be Computed.

func (BoolAttribute) IsOptional 

func (a BoolAttribute) IsOptional() bool

IsOptional returns the Optional field value.

func (BoolAttribute) IsRequired 

func (a BoolAttribute) IsRequired() bool

IsRequired returns the Required field value.

func (BoolAttribute) IsSensitive 

func (a BoolAttribute) IsSensitive() bool

IsSensitive always returns false as there is no plan for provider meta schema data.

type Float64Attribute 

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.
	CustomType basetypes.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.
	Required bool

	// Optional indicates whether the practitioner can choose to enter a value
	// for this attribute or not. Optional and Required cannot both be true.
	Optional bool

	// 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.
	Description string

	// 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.
	MarkdownDescription string
}

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

func (Float64Attribute) ApplyTerraform5AttributePathStep 

func (a Float64Attribute) ApplyTerraform5AttributePathStep(step tftypes.AttributePathStep) (interface{}, error)

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

func (Float64Attribute) Equal 

func (a Float64Attribute) Equal(o fwschema.Attribute) bool

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

func (Float64Attribute) GetDeprecationMessage 

func (a Float64Attribute) GetDeprecationMessage() string

GetDeprecationMessage always returns an empty string as there is no deprecation validation support for provider meta schemas.

func (Float64Attribute) GetDescription 

func (a Float64Attribute) GetDescription() string

GetDescription returns the Description field value.

func (Float64Attribute) GetMarkdownDescription 

func (a Float64Attribute) GetMarkdownDescription() string

GetMarkdownDescription returns the MarkdownDescription field value.

func (Float64Attribute) GetType 

func (a Float64Attribute) GetType() attr.Type

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

func (Float64Attribute) IsComputed 

func (a Float64Attribute) IsComputed() bool

IsComputed always returns false as provider schemas cannot be Computed.

func (Float64Attribute) IsOptional 

func (a Float64Attribute) IsOptional() bool

IsOptional returns the Optional field value.

func (Float64Attribute) IsRequired 

func (a Float64Attribute) IsRequired() bool

IsRequired returns the Required field value.

func (Float64Attribute) IsSensitive 

func (a Float64Attribute) IsSensitive() bool

IsSensitive always returns false as there is no plan for provider meta schema data.

type Int64Attribute 

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.
	CustomType basetypes.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.
	Required bool

	// Optional indicates whether the practitioner can choose to enter a value
	// for this attribute or not. Optional and Required cannot both be true.
	Optional bool

	// 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.
	Description string

	// 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.
	MarkdownDescription string
}

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

func (Int64Attribute) ApplyTerraform5AttributePathStep 

func (a Int64Attribute) ApplyTerraform5AttributePathStep(step tftypes.AttributePathStep) (interface{}, error)

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

func (Int64Attribute) Equal 

func (a Int64Attribute) Equal(o fwschema.Attribute) bool

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

func (Int64Attribute) GetDeprecationMessage 

func (a Int64Attribute) GetDeprecationMessage() string

GetDeprecationMessage always returns an empty string as there is no deprecation validation support for provider meta schemas.

func (Int64Attribute) GetDescription 

func (a Int64Attribute) GetDescription() string

GetDescription returns the Description field value.

func (Int64Attribute) GetMarkdownDescription 

func (a Int64Attribute) GetMarkdownDescription() string

GetMarkdownDescription returns the MarkdownDescription field value.

func (Int64Attribute) GetType 

func (a Int64Attribute) GetType() attr.Type

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

func (Int64Attribute) IsComputed 

func (a Int64Attribute) IsComputed() bool

IsComputed always returns false as provider schemas cannot be Computed.

func (Int64Attribute) IsOptional 

func (a Int64Attribute) IsOptional() bool

IsOptional returns the Optional field value.

func (Int64Attribute) IsRequired 

func (a Int64Attribute) IsRequired() bool

IsRequired returns the Required field value.

func (Int64Attribute) IsSensitive 

func (a Int64Attribute) IsSensitive() bool

IsSensitive always returns false as there is no plan for provider meta schema data.

type ListAttribute 

type ListAttribute struct {
	// ElementType is the type for all elements of the list. This field must be
	// set.
	ElementType attr.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.
	CustomType basetypes.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.
	Required bool

	// Optional indicates whether the practitioner can choose to enter a value
	// for this attribute or not. Optional and Required cannot both be true.
	Optional bool

	// 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.
	Description string

	// 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.
	MarkdownDescription string
}

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]

func (ListAttribute) ApplyTerraform5AttributePathStep 

func (a ListAttribute) ApplyTerraform5AttributePathStep(step tftypes.AttributePathStep) (interface{}, error)

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

func (ListAttribute) Equal 

func (a ListAttribute) Equal(o fwschema.Attribute) bool

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

func (ListAttribute) GetDeprecationMessage 

func (a ListAttribute) GetDeprecationMessage() string

GetDeprecationMessage always returns an empty string as there is no deprecation validation support for provider meta schemas.

func (ListAttribute) GetDescription 

func (a ListAttribute) GetDescription() string

GetDescription returns the Description field value.

func (ListAttribute) GetMarkdownDescription 

func (a ListAttribute) GetMarkdownDescription() string

GetMarkdownDescription returns the MarkdownDescription field value.

func (ListAttribute) GetType 

func (a ListAttribute) GetType() attr.Type

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

func (ListAttribute) IsComputed 

func (a ListAttribute) IsComputed() bool

IsComputed always returns false as provider schemas cannot be Computed.

func (ListAttribute) IsOptional 

func (a ListAttribute) IsOptional() bool

IsOptional returns the Optional field value.

func (ListAttribute) IsRequired 

func (a ListAttribute) IsRequired() bool

IsRequired returns the Required field value.

func (ListAttribute) IsSensitive 

func (a ListAttribute) IsSensitive() bool

IsSensitive always returns false as there is no plan for provider meta schema data.

func (ListAttribute) ValidateImplementation added in v1.3.0 

func (a ListAttribute) ValidateImplementation(ctx context.Context, req fwschema.ValidateImplementationRequest, resp *fwschema.ValidateImplementationResponse)

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.

type ListNestedAttribute 

type ListNestedAttribute struct {
	// NestedObject is the underlying object that contains nested attributes.
	// This field must be set.
	NestedObject NestedAttributeObject

	// 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.
	CustomType basetypes.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.
	Required bool

	// Optional indicates whether the practitioner can choose to enter a value
	// for this attribute or not. Optional and Required cannot both be true.
	Optional bool

	// 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.
	Description string

	// 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.
	MarkdownDescription string
}

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

func (ListNestedAttribute) ApplyTerraform5AttributePathStep 

func (a ListNestedAttribute) ApplyTerraform5AttributePathStep(step tftypes.AttributePathStep) (interface{}, error)

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

func (ListNestedAttribute) Equal 

func (a ListNestedAttribute) Equal(o fwschema.Attribute) bool

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

func (ListNestedAttribute) GetDeprecationMessage 

func (a ListNestedAttribute) GetDeprecationMessage() string

GetDeprecationMessage always returns an empty string as there is no deprecation validation support for provider meta schemas.

func (ListNestedAttribute) GetDescription 

func (a ListNestedAttribute) GetDescription() string

GetDescription returns the Description field value.

func (ListNestedAttribute) GetMarkdownDescription 

func (a ListNestedAttribute) GetMarkdownDescription() string

GetMarkdownDescription returns the MarkdownDescription field value.

func (ListNestedAttribute) GetNestedObject 

func (a ListNestedAttribute) GetNestedObject() fwschema.NestedAttributeObject

GetNestedObject returns the NestedObject field value.

func (ListNestedAttribute) GetNestingMode 

func (a ListNestedAttribute) GetNestingMode() fwschema.NestingMode

GetNestingMode always returns NestingModeList.

func (ListNestedAttribute) GetType 

func (a ListNestedAttribute) GetType() attr.Type

GetType returns ListType of ObjectType or CustomType.

func (ListNestedAttribute) IsComputed 

func (a ListNestedAttribute) IsComputed() bool

IsComputed always returns false as provider schemas cannot be Computed.

func (ListNestedAttribute) IsOptional 

func (a ListNestedAttribute) IsOptional() bool

IsOptional returns the Optional field value.

func (ListNestedAttribute) IsRequired 

func (a ListNestedAttribute) IsRequired() bool

IsRequired returns the Required field value.

func (ListNestedAttribute) IsSensitive 

func (a ListNestedAttribute) IsSensitive() bool

IsSensitive always returns false as there is no plan for provider meta schema data.

type MapAttribute 

type MapAttribute struct {
	// ElementType is the type for all elements of the map. This field must be
	// set.
	ElementType attr.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.
	CustomType basetypes.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.
	Required bool

	// Optional indicates whether the practitioner can choose to enter a value
	// for this attribute or not. Optional and Required cannot both be true.
	Optional bool

	// 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.
	Description string

	// 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.
	MarkdownDescription string
}

MapAttribute represents a schema attribute that is a list 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 list 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"]

func (MapAttribute) ApplyTerraform5AttributePathStep 

func (a MapAttribute) ApplyTerraform5AttributePathStep(step tftypes.AttributePathStep) (interface{}, error)

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

func (MapAttribute) Equal 

func (a MapAttribute) Equal(o fwschema.Attribute) bool

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

func (MapAttribute) GetDeprecationMessage 

func (a MapAttribute) GetDeprecationMessage() string

GetDeprecationMessage always returns an empty string as there is no deprecation validation support for provider meta schemas.

func (MapAttribute) GetDescription 

func (a MapAttribute) GetDescription() string

GetDescription returns the Description field value.

func (MapAttribute) GetMarkdownDescription 

func (a MapAttribute) GetMarkdownDescription() string

GetMarkdownDescription returns the MarkdownDescription field value.

func (MapAttribute) GetType 

func (a MapAttribute) GetType() attr.Type

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

func (MapAttribute) IsComputed 

func (a MapAttribute) IsComputed() bool

IsComputed always returns false as provider schemas cannot be Computed.

func (MapAttribute) IsOptional 

func (a MapAttribute) IsOptional() bool

IsOptional returns the Optional field value.

func (MapAttribute) IsRequired 

func (a MapAttribute) IsRequired() bool

IsRequired returns the Required field value.

func (MapAttribute) IsSensitive 

func (a MapAttribute) IsSensitive() bool

IsSensitive always returns false as there is no plan for provider meta schema data.

func (MapAttribute) ValidateImplementation added in v1.3.0 

func (a MapAttribute) ValidateImplementation(ctx context.Context, req fwschema.ValidateImplementationRequest, resp *fwschema.ValidateImplementationResponse)

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.

type MapNestedAttribute 

type MapNestedAttribute struct {
	// NestedObject is the underlying object that contains nested attributes.
	// This field must be set.
	NestedObject NestedAttributeObject

	// 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.
	CustomType basetypes.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.
	Required bool

	// Optional indicates whether the practitioner can choose to enter a value
	// for this attribute or not. Optional and Required cannot both be true.
	Optional bool

	// 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.
	Description string

	// 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.
	MarkdownDescription string
}

MapNestedAttribute 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.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 set 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

func (MapNestedAttribute) ApplyTerraform5AttributePathStep 

func (a MapNestedAttribute) ApplyTerraform5AttributePathStep(step tftypes.AttributePathStep) (interface{}, error)

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

func (MapNestedAttribute) Equal 

func (a MapNestedAttribute) Equal(o fwschema.Attribute) bool

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

func (MapNestedAttribute) GetDeprecationMessage 

func (a MapNestedAttribute) GetDeprecationMessage() string

GetDeprecationMessage always returns an empty string as there is no deprecation validation support for provider meta schemas.

func (MapNestedAttribute) GetDescription 

func (a MapNestedAttribute) GetDescription() string

GetDescription returns the Description field value.

func (MapNestedAttribute) GetMarkdownDescription 

func (a MapNestedAttribute) GetMarkdownDescription() string

GetMarkdownDescription returns the MarkdownDescription field value.

func (MapNestedAttribute) GetNestedObject 

func (a MapNestedAttribute) GetNestedObject() fwschema.NestedAttributeObject

GetNestedObject returns the NestedObject field value.

func (MapNestedAttribute) GetNestingMode 

func (a MapNestedAttribute) GetNestingMode() fwschema.NestingMode

GetNestingMode always returns NestingModeList.

func (MapNestedAttribute) GetType 

func (a MapNestedAttribute) GetType() attr.Type

GetType returns MapType of ObjectType or CustomType.

func (MapNestedAttribute) IsComputed 

func (a MapNestedAttribute) IsComputed() bool

IsComputed always returns false as provider schemas cannot be Computed.

func (MapNestedAttribute) IsOptional 

func (a MapNestedAttribute) IsOptional() bool

IsOptional returns the Optional field value.

func (MapNestedAttribute) IsRequired 

func (a MapNestedAttribute) IsRequired() bool

IsRequired returns the Required field value.

func (MapNestedAttribute) IsSensitive 

func (a MapNestedAttribute) IsSensitive() bool

IsSensitive always returns false as there is no plan for provider meta schema data.

type NestedAttribute 

type NestedAttribute interface {
	Attribute
	fwschema.NestedAttribute
}

Nested attributes are only compatible with protocol version 6.

type NestedAttributeObject 

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.
	CustomType basetypes.ObjectTypable
}

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.

func (NestedAttributeObject) ApplyTerraform5AttributePathStep 

func (o NestedAttributeObject) ApplyTerraform5AttributePathStep(step tftypes.AttributePathStep) (any, error)

ApplyTerraform5AttributePathStep performs an AttributeName step on the underlying attributes or returns an error.

func (NestedAttributeObject) Equal 

func (o NestedAttributeObject) Equal(other fwschema.NestedAttributeObject) bool

Equal returns true if the given NestedAttributeObject is equivalent.

func (NestedAttributeObject) GetAttributes 

func (o NestedAttributeObject) GetAttributes() fwschema.UnderlyingAttributes

GetAttributes returns the Attributes field value.

func (NestedAttributeObject) Type 

func (o NestedAttributeObject) Type() basetypes.ObjectTypable

Type returns the framework type of the NestedAttributeObject.

type NumberAttribute 

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.
	CustomType basetypes.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.
	Required bool

	// Optional indicates whether the practitioner can choose to enter a value
	// for this attribute or not. Optional and Required cannot both be true.
	Optional bool

	// 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.
	Description string

	// 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.
	MarkdownDescription string
}

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

func (NumberAttribute) ApplyTerraform5AttributePathStep 

func (a NumberAttribute) ApplyTerraform5AttributePathStep(step tftypes.AttributePathStep) (interface{}, error)

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

func (NumberAttribute) Equal 

func (a NumberAttribute) Equal(o fwschema.Attribute) bool

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

func (NumberAttribute) GetDeprecationMessage 

func (a NumberAttribute) GetDeprecationMessage() string

GetDeprecationMessage always returns an empty string as there is no deprecation validation support for provider meta schemas.

func (NumberAttribute) GetDescription 

func (a NumberAttribute) GetDescription() string

GetDescription returns the Description field value.

func (NumberAttribute) GetMarkdownDescription 

func (a NumberAttribute) GetMarkdownDescription() string

GetMarkdownDescription returns the MarkdownDescription field value.

func (NumberAttribute) GetType 

func (a NumberAttribute) GetType() attr.Type

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

func (NumberAttribute) IsComputed 

func (a NumberAttribute) IsComputed() bool

IsComputed always returns false as provider schemas cannot be Computed.

func (NumberAttribute) IsOptional 

func (a NumberAttribute) IsOptional() bool

IsOptional returns the Optional field value.

func (NumberAttribute) IsRequired 

func (a NumberAttribute) IsRequired() bool

IsRequired returns the Required field value.

func (NumberAttribute) IsSensitive 

func (a NumberAttribute) IsSensitive() bool

IsSensitive always returns false as there is no plan for provider meta schema data.

type ObjectAttribute 

type ObjectAttribute struct {
	// AttributeTypes is the mapping of underlying attribute names to attribute
	// types. This field must be set.
	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.
	CustomType basetypes.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.
	Required bool

	// Optional indicates whether the practitioner can choose to enter a value
	// for this attribute or not. Optional and Required cannot both be true.
	Optional bool

	// 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.
	Description string

	// 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.
	MarkdownDescription string
}

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

func (ObjectAttribute) ApplyTerraform5AttributePathStep 

func (a ObjectAttribute) ApplyTerraform5AttributePathStep(step tftypes.AttributePathStep) (interface{}, error)

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

func (ObjectAttribute) Equal 

func (a ObjectAttribute) Equal(o fwschema.Attribute) bool

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

func (ObjectAttribute) GetDeprecationMessage 

func (a ObjectAttribute) GetDeprecationMessage() string

GetDeprecationMessage always returns an empty string as there is no deprecation validation support for provider meta schemas.

func (ObjectAttribute) GetDescription 

func (a ObjectAttribute) GetDescription() string

GetDescription returns the Description field value.

func (ObjectAttribute) GetMarkdownDescription 

func (a ObjectAttribute) GetMarkdownDescription() string

GetMarkdownDescription returns the MarkdownDescription field value.

func (ObjectAttribute) GetType 

func (a ObjectAttribute) GetType() attr.Type

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

func (ObjectAttribute) IsComputed 

func (a ObjectAttribute) IsComputed() bool

IsComputed always returns false as provider schemas cannot be Computed.

func (ObjectAttribute) IsOptional 

func (a ObjectAttribute) IsOptional() bool

IsOptional returns the Optional field value.

func (ObjectAttribute) IsRequired 

func (a ObjectAttribute) IsRequired() bool

IsRequired returns the Required field value.

func (ObjectAttribute) IsSensitive 

func (a ObjectAttribute) IsSensitive() bool

IsSensitive always returns false as there is no plan for provider meta schema data.

func (ObjectAttribute) ValidateImplementation added in v1.3.0 

func (a ObjectAttribute) ValidateImplementation(ctx context.Context, req fwschema.ValidateImplementationRequest, resp *fwschema.ValidateImplementationResponse)

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.

type Schema 

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
}

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.

func (Schema) ApplyTerraform5AttributePathStep 

func (s Schema) ApplyTerraform5AttributePathStep(step tftypes.AttributePathStep) (any, error)

ApplyTerraform5AttributePathStep applies the given AttributePathStep to the schema.

func (Schema) AttributeAtPath 

func (s Schema) AttributeAtPath(ctx context.Context, p path.Path) (fwschema.Attribute, diag.Diagnostics)

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.

func (Schema) AttributeAtTerraformPath 

func (s Schema) AttributeAtTerraformPath(ctx context.Context, p *tftypes.AttributePath) (fwschema.Attribute, 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.

func (Schema) GetAttributes 

func (s Schema) GetAttributes() map[string]fwschema.Attribute

GetAttributes returns the Attributes field value.

func (Schema) GetBlocks 

func (s Schema) GetBlocks() map[string]fwschema.Block

GetBlocks always returns nil as meta schemas cannot contain blocks.

func (Schema) GetDeprecationMessage 

func (s Schema) GetDeprecationMessage() string

GetDeprecationMessage always returns an empty string as there is no deprecation validation support for meta schemas.

func (Schema) GetDescription 

func (s Schema) GetDescription() string

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.

func (Schema) GetMarkdownDescription 

func (s Schema) GetMarkdownDescription() string

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.

func (Schema) GetVersion 

func (s Schema) GetVersion() int64

GetVersion always returns 0 as provider meta schemas cannot be versioned.

func (Schema) Type 

func (s Schema) Type() attr.Type

Type returns the framework type of the schema.

func (Schema) TypeAtPath 

func (s Schema) TypeAtPath(ctx context.Context, p path.Path) (attr.Type, diag.Diagnostics)

TypeAtPath returns the framework type at the given schema path.

func (Schema) TypeAtTerraformPath 

func (s Schema) TypeAtTerraformPath(ctx context.Context, p *tftypes.AttributePath) (attr.Type, error)

TypeAtTerraformPath returns the framework type at the given tftypes path.

func (Schema) Validate deprecated added in v1.0.0 

func (s Schema) Validate() diag.Diagnostics

Validate verifies that the schema is not using a reserved field name for a top-level attribute.

Deprecated: Use the ValidateImplementation method instead.

func (Schema) ValidateImplementation added in v1.3.0 

func (s Schema) ValidateImplementation(ctx context.Context) diag.Diagnostics

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.

type SetAttribute 

type SetAttribute struct {
	// ElementType is the type for all elements of the set. This field must be
	// set.
	ElementType attr.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.
	CustomType basetypes.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.
	Required bool

	// Optional indicates whether the practitioner can choose to enter a value
	// for this attribute or not. Optional and Required cannot both be true.
	Optional bool

	// 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.
	Description string

	// 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.
	MarkdownDescription string
}

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.

func (SetAttribute) ApplyTerraform5AttributePathStep 

func (a SetAttribute) ApplyTerraform5AttributePathStep(step tftypes.AttributePathStep) (interface{}, error)

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

func (SetAttribute) Equal 

func (a SetAttribute) Equal(o fwschema.Attribute) bool

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

func (SetAttribute) GetDeprecationMessage 

func (a SetAttribute) GetDeprecationMessage() string

GetDeprecationMessage always returns an empty string as there is no deprecation validation support for provider meta schemas.

func (SetAttribute) GetDescription 

func (a SetAttribute) GetDescription() string

GetDescription returns the Description field value.

func (SetAttribute) GetMarkdownDescription 

func (a SetAttribute) GetMarkdownDescription() string

GetMarkdownDescription returns the MarkdownDescription field value.

func (SetAttribute) GetType 

func (a SetAttribute) GetType() attr.Type

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

func (SetAttribute) IsComputed 

func (a SetAttribute) IsComputed() bool

IsComputed always returns false as provider schemas cannot be Computed.

func (SetAttribute) IsOptional 

func (a SetAttribute) IsOptional() bool

IsOptional returns the Optional field value.

func (SetAttribute) IsRequired 

func (a SetAttribute) IsRequired() bool

IsRequired returns the Required field value.

func (SetAttribute) IsSensitive 

func (a SetAttribute) IsSensitive() bool

IsSensitive always returns false as there is no plan for provider meta schema data.

func (SetAttribute) ValidateImplementation added in v1.3.0 

func (a SetAttribute) ValidateImplementation(ctx context.Context, req fwschema.ValidateImplementationRequest, resp *fwschema.ValidateImplementationResponse)

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.

type SetNestedAttribute 

type SetNestedAttribute struct {
	// NestedObject is the underlying object that contains nested attributes.
	// This field must be set.
	NestedObject NestedAttributeObject

	// 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.
	CustomType basetypes.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.
	Required bool

	// Optional indicates whether the practitioner can choose to enter a value
	// for this attribute or not. Optional and Required cannot both be true.
	Optional bool

	// 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.
	Description string

	// 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.
	MarkdownDescription string
}

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.

func (SetNestedAttribute) ApplyTerraform5AttributePathStep 

func (a SetNestedAttribute) ApplyTerraform5AttributePathStep(step tftypes.AttributePathStep) (interface{}, error)

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

func (SetNestedAttribute) Equal 

func (a SetNestedAttribute) Equal(o fwschema.Attribute) bool

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

func (SetNestedAttribute) GetDeprecationMessage 

func (a SetNestedAttribute) GetDeprecationMessage() string

GetDeprecationMessage always returns an empty string as there is no deprecation validation support for provider meta schemas.

func (SetNestedAttribute) GetDescription 

func (a SetNestedAttribute) GetDescription() string

GetDescription returns the Description field value.

func (SetNestedAttribute) GetMarkdownDescription 

func (a SetNestedAttribute) GetMarkdownDescription() string

GetMarkdownDescription returns the MarkdownDescription field value.

func (SetNestedAttribute) GetNestedObject 

func (a SetNestedAttribute) GetNestedObject() fwschema.NestedAttributeObject

GetNestedObject returns the NestedObject field value.

func (SetNestedAttribute) GetNestingMode 

func (a SetNestedAttribute) GetNestingMode() fwschema.NestingMode

GetNestingMode always returns NestingModeList.

func (SetNestedAttribute) GetType 

func (a SetNestedAttribute) GetType() attr.Type

GetType returns SetType of ObjectType or CustomType.

func (SetNestedAttribute) IsComputed 

func (a SetNestedAttribute) IsComputed() bool

IsComputed always returns false as provider schemas cannot be Computed.

func (SetNestedAttribute) IsOptional 

func (a SetNestedAttribute) IsOptional() bool

IsOptional returns the Optional field value.

func (SetNestedAttribute) IsRequired 

func (a SetNestedAttribute) IsRequired() bool

IsRequired returns the Required field value.

func (SetNestedAttribute) IsSensitive 

func (a SetNestedAttribute) IsSensitive() bool

IsSensitive always returns false as there is no plan for provider meta schema data.

type SingleNestedAttribute 

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.
	CustomType basetypes.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.
	Required bool

	// Optional indicates whether the practitioner can choose to enter a value
	// for this attribute or not. Optional and Required cannot both be true.
	Optional bool

	// 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.
	Description string

	// 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.
	MarkdownDescription string
}

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

func (SingleNestedAttribute) ApplyTerraform5AttributePathStep 

func (a SingleNestedAttribute) ApplyTerraform5AttributePathStep(step tftypes.AttributePathStep) (interface{}, error)

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

func (SingleNestedAttribute) Equal 

func (a SingleNestedAttribute) Equal(o fwschema.Attribute) bool

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

func (SingleNestedAttribute) GetAttributes 

func (a SingleNestedAttribute) GetAttributes() fwschema.UnderlyingAttributes

GetAttributes returns the Attributes field value.

func (SingleNestedAttribute) GetDeprecationMessage 

func (a SingleNestedAttribute) GetDeprecationMessage() string

GetDeprecationMessage always returns an empty string as there is no deprecation validation support for provider meta schemas.

func (SingleNestedAttribute) GetDescription 

func (a SingleNestedAttribute) GetDescription() string

GetDescription returns the Description field value.

func (SingleNestedAttribute) GetMarkdownDescription 

func (a SingleNestedAttribute) GetMarkdownDescription() string

GetMarkdownDescription returns the MarkdownDescription field value.

func (SingleNestedAttribute) GetNestedObject 

func (a SingleNestedAttribute) GetNestedObject() fwschema.NestedAttributeObject

GetNestedObject returns a generated NestedAttributeObject from the Attributes and CustomType field values.

func (SingleNestedAttribute) GetNestingMode 

func (a SingleNestedAttribute) GetNestingMode() fwschema.NestingMode

GetNestingMode always returns NestingModeList.

func (SingleNestedAttribute) GetType 

func (a SingleNestedAttribute) GetType() attr.Type

GetType returns ListType of ObjectType or CustomType.

func (SingleNestedAttribute) IsComputed 

func (a SingleNestedAttribute) IsComputed() bool

IsComputed always returns false as provider schemas cannot be Computed.

func (SingleNestedAttribute) IsOptional 

func (a SingleNestedAttribute) IsOptional() bool

IsOptional returns the Optional field value.

func (SingleNestedAttribute) IsRequired 

func (a SingleNestedAttribute) IsRequired() bool

IsRequired returns the Required field value.

func (SingleNestedAttribute) IsSensitive 

func (a SingleNestedAttribute) IsSensitive() bool

IsSensitive always returns false as there is no plan for provider meta schema data.

type StringAttribute 

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.
	CustomType basetypes.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.
	Required bool

	// Optional indicates whether the practitioner can choose to enter a value
	// for this attribute or not. Optional and Required cannot both be true.
	Optional bool

	// 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.
	Description string

	// 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.
	MarkdownDescription string
}

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

func (StringAttribute) ApplyTerraform5AttributePathStep 

func (a StringAttribute) ApplyTerraform5AttributePathStep(step tftypes.AttributePathStep) (interface{}, error)

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

func (StringAttribute) Equal 

func (a StringAttribute) Equal(o fwschema.Attribute) bool

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

func (StringAttribute) GetDeprecationMessage 

func (a StringAttribute) GetDeprecationMessage() string

GetDeprecationMessage always returns an empty string as there is no deprecation validation support for provider meta schemas.

func (StringAttribute) GetDescription 

func (a StringAttribute) GetDescription() string

GetDescription returns the Description field value.

func (StringAttribute) GetMarkdownDescription 

func (a StringAttribute) GetMarkdownDescription() string

GetMarkdownDescription returns the MarkdownDescription field value.

func (StringAttribute) GetType 

func (a StringAttribute) GetType() attr.Type

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

func (StringAttribute) IsComputed 

func (a StringAttribute) IsComputed() bool

IsComputed always returns false as provider schemas cannot be Computed.

func (StringAttribute) IsOptional 

func (a StringAttribute) IsOptional() bool

IsOptional returns the Optional field value.

func (StringAttribute) IsRequired 

func (a StringAttribute) IsRequired() bool

IsRequired returns the Required field value.

func (StringAttribute) IsSensitive 

func (a StringAttribute) IsSensitive() bool

IsSensitive always returns false as there is no plan for provider meta schema data.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.