planmodifiers

package
v0.15.0-alpha Latest Latest
Warning

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

Go to latest
Published: Jun 4, 2025 License: MPL-2.0 Imports: 11 Imported by: 0

Documentation

Overview

planmodifiers/bool.go

In a file like mobileapp_assignment_plan_modifiers.go

planmodifiers/set.go

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func DefaultSetEmptyValue

func DefaultSetEmptyValue() planmodifier.Set

DefaultSetEmptyValue returns a SetModifier that sets the default value to an empty set.

func DefaultSetValue

func DefaultSetValue(defaultValue []attr.Value) planmodifier.Set

DefaultSetValue returns a SetModifier that sets the default value to the specified set.

func MobileAppAssignmentsListModifier

func MobileAppAssignmentsListModifier() planmodifier.List

MobileAppAssignmentsListModifier handles the reordering of assignments by the API

func NewRequiresReplaceIfChangedBool

func NewRequiresReplaceIfChangedBool() planmodifier.Bool

NewRequiresReplaceIfChangedBool returns a new instance of the RequiresReplaceIfChangedBool plan modifier.

func RequiresOtherAttributeEnabled

func RequiresOtherAttributeEnabled(dependencyPath path.Path) planmodifier.String

RequiresOtherAttributeEnabled returns a plan modifier that ensures an attribute can only be used when another specified attribute is enabled (set to true).

func RequiresOtherAttributeEnabledInt32

func RequiresOtherAttributeEnabledInt32(dependencyPath path.Path) planmodifier.Int32

RequiresOtherAttributeEnabledInt32 returns a plan modifier that ensures an Int32 attribute can only be used when another specified attribute is enabled (set to true).

func RequiresOtherAttributeEnabledInt64

func RequiresOtherAttributeEnabledInt64(dependencyPath path.Path) planmodifier.Int64

RequiresOtherAttributeEnabledInt64 returns a plan modifier that ensures an int64 attribute can only be used when another specified attribute is enabled (set to true).

func RequiresOtherAttributeEnabledList

func RequiresOtherAttributeEnabledList(dependencyPath path.Path) planmodifier.List

RequiresOtherAttributeEnabledList returns a plan modifier that ensures a list attribute can only be used when another specified attribute is enabled (set to true).

func RequiresOtherAttributeEnabledMap

func RequiresOtherAttributeEnabledMap(dependencyPath path.Path) planmodifier.Map

RequiresOtherAttributeEnabledMap returns a plan modifier that ensures a map attribute can only be used when another specified attribute is enabled (set to true).

func RequiresOtherAttributeEnabledObject

func RequiresOtherAttributeEnabledObject(dependencyPath path.Path) planmodifier.Object

RequiresOtherAttributeEnabledObject returns a plan modifier that ensures an object attribute can only be used when another specified attribute is enabled (set to true).

func RequiresOtherAttributeEnabledSet

func RequiresOtherAttributeEnabledSet(dependencyPath path.Path) planmodifier.Set

RequiresOtherAttributeEnabledSet returns a plan modifier that ensures a set attribute can only be used when another specified attribute is enabled (set to true).

func RequiresOtherAttributeValueBool

func RequiresOtherAttributeValueBool(dependencyPath path.Path, requiredValue string) planmodifier.Bool

RequiresOtherAttributeValueBool returns a plan modifier that ensures a Bool attribute can only be used when another specified attribute has a specific string value.

func RequiresOtherAttributeValueInt32

func RequiresOtherAttributeValueInt32(dependencyPath path.Path, requiredValue string) planmodifier.Int32

RequiresOtherAttributeValueInt32 returns a plan modifier that ensures an Int32 attribute can only be used when another specified attribute has a specific string value.

func UseStateForUnknownOrNullSet

func UseStateForUnknownOrNullSet() planmodifier.Set

UseStateForUnknownOrNullSet returns a plan modifier that copies a known prior state Set value into the planned value if the planned value is null or unknown. This is useful for fields that are populated during creation but may not be explicitly set in configuration.

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 Int32Modifier

type Int32Modifier interface {
	planmodifier.Int32
	Description(context.Context) string
	MarkdownDescription(context.Context) string
}

Int32Modifier defines the interface for int32 plan modifiers

func UseStateForUnknownInt32

func UseStateForUnknownInt32() Int32Modifier

UseStateForUnknownInt32 returns a plan modifier that copies a known prior state int32 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

func UseStateForUnknownList

func UseStateForUnknownList() ListModifier

UseStateForUnknownList returns a plan modifier that copies a known prior state value into the planned value when the planned value is unknown/null.

type NormalizeJSONPlanModifier

type NormalizeJSONPlanModifier struct{}

PlanModifyString normalizes the JSON string during the plan phase. NormalizeJSONPlanModifier is a custom plan modifier that normalizes JSON strings.

func (NormalizeJSONPlanModifier) Description

func (m NormalizeJSONPlanModifier) Description(ctx context.Context) string

Description provides a description of the Plan Modifier.

func (NormalizeJSONPlanModifier) MarkdownDescription

func (m NormalizeJSONPlanModifier) MarkdownDescription(ctx context.Context) string

MarkdownDescription provides a markdown-compatible description.

func (NormalizeJSONPlanModifier) PlanModifyString

PlanModifyString normalizes the JSON string during the plan phase.

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 RequiresReplaceIfChangedBool

type RequiresReplaceIfChangedBool struct{}

RequiresReplaceIfChangedBool is a custom PlanModifier for BoolAttribute

func (RequiresReplaceIfChangedBool) Description

func (RequiresReplaceIfChangedBool) MarkdownDescription

func (m RequiresReplaceIfChangedBool) MarkdownDescription(_ context.Context) string

func (RequiresReplaceIfChangedBool) PlanModifyBool

type SetModifier

type SetModifier interface {
	planmodifier.Set
	Description(context.Context) string
	MarkdownDescription(context.Context) string
}

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 CaseInsensitiveString

func CaseInsensitiveString() StringModifier

CaseInsensitiveString returns a plan modifier for case-insensitive string handling

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.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL