Documentation
¶
Overview ¶
Package fwxschema implements extra framework-based schema functionality on top of base Terraform attribute functionality.
This package is separated from fwschema to prevent import cycles with existing tfsdk functionality.
Index ¶
- type AttributeWithBoolPlanModifiers
- type AttributeWithBoolValidators
- type AttributeWithDynamicPlanModifiers
- type AttributeWithDynamicValidators
- type AttributeWithFloat32PlanModifiers
- type AttributeWithFloat32Validators
- type AttributeWithFloat64PlanModifiers
- type AttributeWithFloat64Validators
- type AttributeWithInt32PlanModifiers
- type AttributeWithInt32Validators
- type AttributeWithInt64PlanModifiers
- type AttributeWithInt64Validators
- type AttributeWithListPlanModifiers
- type AttributeWithListValidators
- type AttributeWithMapPlanModifiers
- type AttributeWithMapValidators
- type AttributeWithNumberPlanModifiers
- type AttributeWithNumberValidators
- type AttributeWithObjectPlanModifiers
- type AttributeWithObjectValidators
- type AttributeWithSetPlanModifiers
- type AttributeWithSetValidators
- type AttributeWithStringPlanModifiers
- type AttributeWithStringValidators
- type BlockWithListPlanModifiers
- type BlockWithListValidators
- type BlockWithObjectPlanModifiers
- type BlockWithObjectValidators
- type BlockWithSetPlanModifiers
- type BlockWithSetValidators
- type NestedAttributeObjectWithPlanModifiers
- type NestedAttributeObjectWithValidators
- type NestedBlockObjectWithPlanModifiers
- type NestedBlockObjectWithValidators
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AttributeWithBoolPlanModifiers ¶ added in v0.17.0
type AttributeWithBoolPlanModifiers interface {
fwschema.Attribute
// BoolPlanModifiers should return a list of Bool plan modifiers.
BoolPlanModifiers() []planmodifier.Bool
}
AttributeWithBoolPlanModifiers is an optional interface on Attribute which enables Bool plan modifier support.
type AttributeWithBoolValidators ¶ added in v0.17.0
type AttributeWithBoolValidators interface {
fwschema.Attribute
// BoolValidators should return a list of Bool validators.
BoolValidators() []validator.Bool
}
AttributeWithBoolValidators is an optional interface on Attribute which enables Bool validation support.
type AttributeWithDynamicPlanModifiers ¶ added in v1.7.0
type AttributeWithDynamicPlanModifiers interface {
fwschema.Attribute
// DynamicPlanModifiers should return a list of Dynamic plan modifiers.
DynamicPlanModifiers() []planmodifier.Dynamic
}
AttributeWithDynamicPlanModifiers is an optional interface on Attribute which enables Dynamic plan modifier support.
type AttributeWithDynamicValidators ¶ added in v1.7.0
type AttributeWithDynamicValidators interface {
fwschema.Attribute
// DynamicValidators should return a list of Dynamic validators.
DynamicValidators() []validator.Dynamic
}
AttributeWithDynamicValidators is an optional interface on Attribute which enables Dynamic validation support.
type AttributeWithFloat32PlanModifiers ¶ added in v1.10.0
type AttributeWithFloat32PlanModifiers interface {
fwschema.Attribute
// Float32PlanModifiers should return a list of Float32 plan modifiers.
Float32PlanModifiers() []planmodifier.Float32
}
AttributeWithFloat32PlanModifiers is an optional interface on Attribute which enables Float32 plan modifier support.
type AttributeWithFloat32Validators ¶ added in v1.10.0
type AttributeWithFloat32Validators interface {
fwschema.Attribute
// Float32Validators should return a list of Float32 validators.
Float32Validators() []validator.Float32
}
AttributeWithFloat32Validators is an optional interface on Attribute which enables Float32 validation support.
type AttributeWithFloat64PlanModifiers ¶ added in v0.17.0
type AttributeWithFloat64PlanModifiers interface {
fwschema.Attribute
// Float64PlanModifiers should return a list of Float64 plan modifiers.
Float64PlanModifiers() []planmodifier.Float64
}
AttributeWithFloat64PlanModifiers is an optional interface on Attribute which enables Float64 plan modifier support.
type AttributeWithFloat64Validators ¶ added in v0.17.0
type AttributeWithFloat64Validators interface {
fwschema.Attribute
// Float64Validators should return a list of Float64 validators.
Float64Validators() []validator.Float64
}
AttributeWithFloat64Validators is an optional interface on Attribute which enables Float64 validation support.
type AttributeWithInt32PlanModifiers ¶ added in v1.10.0
type AttributeWithInt32PlanModifiers interface {
fwschema.Attribute
// Int32PlanModifiers should return a list of Int32 plan modifiers.
Int32PlanModifiers() []planmodifier.Int32
}
AttributeWithInt32PlanModifiers is an optional interface on Attribute which enables Int32 plan modifier support.
type AttributeWithInt32Validators ¶ added in v1.10.0
type AttributeWithInt32Validators interface {
fwschema.Attribute
// Int32Validators should return a list of Int32 validators.
Int32Validators() []validator.Int32
}
AttributeWithInt32Validators is an optional interface on Attribute which enables Int32 validation support.
type AttributeWithInt64PlanModifiers ¶ added in v0.17.0
type AttributeWithInt64PlanModifiers interface {
fwschema.Attribute
// Int64PlanModifiers should return a list of Int64 plan modifiers.
Int64PlanModifiers() []planmodifier.Int64
}
AttributeWithInt64PlanModifiers is an optional interface on Attribute which enables Int64 plan modifier support.
type AttributeWithInt64Validators ¶ added in v0.17.0
type AttributeWithInt64Validators interface {
fwschema.Attribute
// Int64Validators should return a list of Int64 validators.
Int64Validators() []validator.Int64
}
AttributeWithInt64Validators is an optional interface on Attribute which enables Int64 validation support.
type AttributeWithListPlanModifiers ¶ added in v0.17.0
type AttributeWithListPlanModifiers interface {
fwschema.Attribute
// ListPlanModifiers should return a list of List plan modifiers.
ListPlanModifiers() []planmodifier.List
}
AttributeWithListPlanModifiers is an optional interface on Attribute which enables List plan modifier support.
type AttributeWithListValidators ¶ added in v0.17.0
type AttributeWithListValidators interface {
fwschema.Attribute
// ListValidators should return a list of List validators.
ListValidators() []validator.List
}
AttributeWithListValidators is an optional interface on Attribute which enables List validation support.
type AttributeWithMapPlanModifiers ¶ added in v0.17.0
type AttributeWithMapPlanModifiers interface {
fwschema.Attribute
// MapPlanModifiers should return a list of Map plan modifiers.
MapPlanModifiers() []planmodifier.Map
}
AttributeWithMapPlanModifiers is an optional interface on Attribute which enables Map plan modifier support.
type AttributeWithMapValidators ¶ added in v0.17.0
type AttributeWithMapValidators interface {
fwschema.Attribute
// MapValidators should return a list of Map validators.
MapValidators() []validator.Map
}
AttributeWithMapValidators is an optional interface on Attribute which enables Map validation support.
type AttributeWithNumberPlanModifiers ¶ added in v0.17.0
type AttributeWithNumberPlanModifiers interface {
fwschema.Attribute
// NumberPlanModifiers should return a list of Number plan modifiers.
NumberPlanModifiers() []planmodifier.Number
}
AttributeWithNumberPlanModifiers is an optional interface on Attribute which enables Number plan modifier support.
type AttributeWithNumberValidators ¶ added in v0.17.0
type AttributeWithNumberValidators interface {
fwschema.Attribute
// NumberValidators should return a list of Number validators.
NumberValidators() []validator.Number
}
AttributeWithNumberValidators is an optional interface on Attribute which enables Number validation support.
type AttributeWithObjectPlanModifiers ¶ added in v0.17.0
type AttributeWithObjectPlanModifiers interface {
fwschema.Attribute
// ObjectPlanModifiers should return a list of Object plan modifiers.
ObjectPlanModifiers() []planmodifier.Object
}
AttributeWithObjectPlanModifiers is an optional interface on Attribute which enables Object plan modifier support.
type AttributeWithObjectValidators ¶ added in v0.17.0
type AttributeWithObjectValidators interface {
fwschema.Attribute
// ObjectValidators should return a list of Object validators.
ObjectValidators() []validator.Object
}
AttributeWithObjectValidators is an optional interface on Attribute which enables Object validation support.
type AttributeWithSetPlanModifiers ¶ added in v0.17.0
type AttributeWithSetPlanModifiers interface {
fwschema.Attribute
// SetPlanModifiers should return a list of Set plan modifiers.
SetPlanModifiers() []planmodifier.Set
}
AttributeWithSetPlanModifiers is an optional interface on Attribute which enables Set plan modifier support.
type AttributeWithSetValidators ¶ added in v0.17.0
type AttributeWithSetValidators interface {
fwschema.Attribute
// SetValidators should return a list of Set validators.
SetValidators() []validator.Set
}
AttributeWithSetValidators is an optional interface on Attribute which enables Set validation support.
type AttributeWithStringPlanModifiers ¶ added in v0.17.0
type AttributeWithStringPlanModifiers interface {
fwschema.Attribute
// StringPlanModifiers should return a list of String plan modifiers.
StringPlanModifiers() []planmodifier.String
}
AttributeWithStringPlanModifiers is an optional interface on Attribute which enables String plan modifier support.
type AttributeWithStringValidators ¶ added in v0.17.0
type AttributeWithStringValidators interface {
fwschema.Attribute
// StringValidators should return a list of String validators.
StringValidators() []validator.String
}
AttributeWithStringValidators is an optional interface on Attribute which enables String validation support.
type BlockWithListPlanModifiers ¶ added in v0.17.0
type BlockWithListPlanModifiers interface {
fwschema.Block
// ListPlanModifiers should return a list of List plan modifiers.
ListPlanModifiers() []planmodifier.List
}
BlockWithListPlanModifiers is an optional interface on Block which enables List plan modifier support.
type BlockWithListValidators ¶ added in v0.17.0
type BlockWithListValidators interface {
fwschema.Block
// ListValidators should return a list of List validators.
ListValidators() []validator.List
}
BlockWithListValidators is an optional interface on Block which enables List validation support.
type BlockWithObjectPlanModifiers ¶ added in v0.17.0
type BlockWithObjectPlanModifiers interface {
fwschema.Block
// ObjectPlanModifiers should return a list of Object plan modifiers.
ObjectPlanModifiers() []planmodifier.Object
}
BlockWithObjectPlanModifiers is an optional interface on Block which enables Object plan modifier support.
type BlockWithObjectValidators ¶ added in v0.17.0
type BlockWithObjectValidators interface {
fwschema.Block
// ObjectValidators should return a list of Object validators.
ObjectValidators() []validator.Object
}
BlockWithObjectValidators is an optional interface on Block which enables Object validation support.
type BlockWithSetPlanModifiers ¶ added in v0.17.0
type BlockWithSetPlanModifiers interface {
fwschema.Block
// SetPlanModifiers should return a list of Set plan modifiers.
SetPlanModifiers() []planmodifier.Set
}
BlockWithSetPlanModifiers is an optional interface on Block which enables Set plan modifier support.
type BlockWithSetValidators ¶ added in v0.17.0
type BlockWithSetValidators interface {
fwschema.Block
// SetValidators should return a list of Set validators.
SetValidators() []validator.Set
}
BlockWithSetValidators is an optional interface on Block which enables Set validation support.
type NestedAttributeObjectWithPlanModifiers ¶ added in v0.17.0
type NestedAttributeObjectWithPlanModifiers interface {
fwschema.NestedAttributeObject
// ObjectPlanModifiers should return a list of Object plan modifiers.
ObjectPlanModifiers() []planmodifier.Object
}
NestedAttributeObjectWithPlanModifiers is an optional interface on NestedAttributeObject which enables Object plan modification support.
type NestedAttributeObjectWithValidators ¶ added in v0.17.0
type NestedAttributeObjectWithValidators interface {
fwschema.NestedAttributeObject
// ObjectValidators should return a list of Object validators.
ObjectValidators() []validator.Object
}
NestedAttributeObjectWithValidators is an optional interface on NestedAttributeObject which enables Object validation support.
type NestedBlockObjectWithPlanModifiers ¶ added in v0.17.0
type NestedBlockObjectWithPlanModifiers interface {
fwschema.NestedBlockObject
// ObjectPlanModifiers should return a list of Object plan modifiers.
ObjectPlanModifiers() []planmodifier.Object
}
NestedBlockObjectWithPlanModifiers is an optional interface on NestedBlockObject which enables Object plan modification support.
type NestedBlockObjectWithValidators ¶ added in v0.17.0
type NestedBlockObjectWithValidators interface {
fwschema.NestedBlockObject
// ObjectValidators should return a list of Object validators.
ObjectValidators() []validator.Object
}
NestedBlockObjectWithValidators is an optional interface on NestedBlockObject which enables Object validation support.