Documentation
¶
Overview ¶
planmodifiers/bool.go
planmodifiers/set.go
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BoolModifier ¶
type BoolModifier interface {
planmodifier.Bool
Description(context.Context) string
MarkdownDescription(context.Context) string
}
BoolModifier defines the interface for boolean plan modifiers
func BoolDefaultValue ¶
func BoolDefaultValue(defaultValue bool) BoolModifier
BoolDefaultValue returns a plan modifier that sets a default value if the planned value is null
func UseStateForUnknownBool ¶
func UseStateForUnknownBool() BoolModifier
UseStateForUnknownBool returns a plan modifier that copies a known prior state bool value into a planned unknown value.
type Int64Modifier ¶
type Int64Modifier interface {
planmodifier.Int64
Description(context.Context) string
MarkdownDescription(context.Context) string
}
Int64Modifier defines the interface for int64 plan modifiers
func DefaultValueInt64 ¶
func DefaultValueInt64(defaultValue int64) Int64Modifier
DefaultValueInt64 returns a plan modifier that sets a default value if the planned value is null.
func RequiresReplaceIfInt64 ¶
func RequiresReplaceIfInt64(predicate func(context.Context, planmodifier.Int64Request) bool) Int64Modifier
RequiresReplaceIfInt64 returns a plan modifier that requires resource replacement if the value changes and the given predicate returns true.
func RequiresReplaceInt64 ¶
func RequiresReplaceInt64() Int64Modifier
RequiresReplaceInt64 returns a plan modifier that requires resource replacement if the value changes.
func UseStateForUnknownInt64 ¶
func UseStateForUnknownInt64() Int64Modifier
UseStateForUnknownInt64 returns a plan modifier that copies a known prior state int64 value into a planned unknown value.
type ListModifier ¶
type ListModifier interface {
planmodifier.List
Description(context.Context) string
MarkdownDescription(context.Context) string
}
func DefaultListEmptyValue ¶
func DefaultListEmptyValue() ListModifier
DefaultListEmptyValue sets the default value to an empty list
func DefaultListValue ¶
func DefaultListValue(defaultValue []attr.Value) ListModifier
DefaultListValue sets a custom default list value
type ObjectModifier ¶
type ObjectModifier interface {
planmodifier.Object
Description(context.Context) string
MarkdownDescription(context.Context) string
}
ObjectModifier provides plan modifier functionality for objects.
func DefaultValueObject ¶
func DefaultValueObject(defaultValue map[string]attr.Value) ObjectModifier
DefaultValueObject constructor, creates an object modifier with a specified default value
func UseStateForUnknownObject ¶
func UseStateForUnknownObject() ObjectModifier
UseStateForUnknownObject constructor
type SetModifier ¶
type SetModifier interface {
planmodifier.Set
Description(context.Context) string
MarkdownDescription(context.Context) string
}
func DefaultValueSet ¶
func DefaultValueSet(defaultValue []attr.Value) SetModifier
func UseStateForUnknownSet ¶
func UseStateForUnknownSet() SetModifier
type StringModifier ¶
type StringModifier interface {
planmodifier.String
Description(context.Context) string
MarkdownDescription(context.Context) string
}
StringModifier defines the interface for string plan modifiers
func DefaultValueString ¶
func DefaultValueString(defaultValue string) StringModifier
DefaultValue returns a plan modifier that sets a default string value.
func RequiresReplaceString ¶
func RequiresReplaceString() StringModifier
RequiresReplaceIfString returns a plan modifier that requires resource replacement if the string value changes.
func UseStateForUnknownString ¶
func UseStateForUnknownString() StringModifier
UseStateForUnknownString returns a plan modifier that copies a known prior state string value into a planned unknown value.
Source Files