planmodifier

Documentation

Index

• type ImmutableFieldModifier
  • func (m ImmutableFieldModifier) Description(ctx context.Context) string
  • func (m ImmutableFieldModifier) MarkdownDescription(ctx context.Context) string
  • func (m ImmutableFieldModifier) Modify(ctx context.Context, req tfsdk.ModifyAttributePlanRequest, ...)

Types

type ImmutableFieldModifier

type ImmutableFieldModifier struct{}

ImmutableFieldModifier is a plan modifier that enforces immutability of an attribute. This should be used with attribute's that can't be changed after resource creation and you want to show error to user during `tf plan` rather than `tf apply`.

It should NOT be used for attribute's having "Computed: true" as they are already Read-Only.

For nested attribute types, applying this plan modifier at root attribute is enough.

func (ImmutableFieldModifier) Description

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

func (ImmutableFieldModifier) MarkdownDescription

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

func (ImmutableFieldModifier) Modify

func (m ImmutableFieldModifier) Modify(ctx context.Context, req tfsdk.ModifyAttributePlanRequest, resp *tfsdk.ModifyAttributePlanResponse)