stringplanmodifier

Documentation

Overview

Package stringplanmodifier provides plan modifiers for types.String attributes.

Index

• func RequiresReplace() planmodifier.String
• func RequiresReplaceIf(f RequiresReplaceIfFunc, description, markdownDescription string) planmodifier.String
• func RequiresReplaceIfConfigured() planmodifier.String
• func UseStateForUnknown() planmodifier.String
• type RequiresReplaceIfFunc
• type RequiresReplaceIfFuncResponse

Functions

func RequiresReplace

func RequiresReplace() planmodifier.String

RequiresReplace returns a plan modifier that conditionally requires resource replacement if:

• The resource is planned for update.
• The plan and state values are not equal.

Use RequiresReplaceIfConfigured if the resource replacement should only occur if there is a configuration value (ignore unconfigured drift detection changes). Use RequiresReplaceIf if the resource replacement should check provider-defined conditional logic.

func RequiresReplaceIf

func RequiresReplaceIf(f RequiresReplaceIfFunc, description, markdownDescription string) planmodifier.String

RequiresReplaceIf returns a plan modifier that conditionally requires resource replacement if:

• The resource is planned for update.
• The plan and state values are not equal.
• The given function returns true. Returning false will not unset any prior resource replacement.

Use RequiresReplace if the resource replacement should always occur on value changes. Use RequiresReplaceIfConfigured if the resource replacement should occur on value changes, but only if there is a configuration value (ignore unconfigured drift detection changes).

func RequiresReplaceIfConfigured

func RequiresReplaceIfConfigured() planmodifier.String

RequiresReplaceIfConfigured returns a plan modifier that conditionally requires resource replacement if:

• The resource is planned for update.
• The plan and state values are not equal.
• The configuration value is not null.

Use RequiresReplace if the resource replacement should occur regardless of the presence of a configuration value. Use RequiresReplaceIf if the resource replacement should check provider-defined conditional logic.

func UseStateForUnknown

func UseStateForUnknown() planmodifier.String

UseStateForUnknown returns a plan modifier that copies a known prior state value into the planned value. Use this when it is known that an unconfigured value will remain the same after a resource update.

To prevent Terraform errors, the framework automatically sets unconfigured and Computed attributes to an unknown value "(known after apply)" on update. Using this plan modifier will instead display the prior state value in the plan, unless a prior plan modifier adjusts the value.

Types

type RequiresReplaceIfFunc

type RequiresReplaceIfFunc func(context.Context, planmodifier.StringRequest, *RequiresReplaceIfFuncResponse)

RequiresReplaceIfFunc is a conditional function used in the RequiresReplaceIf plan modifier to determine whether the attribute requires replacement.

type RequiresReplaceIfFuncResponse

type RequiresReplaceIfFuncResponse struct {
	// Diagnostics report errors or warnings related to this logic. An empty
	// or unset slice indicates success, with no warnings or errors generated.
	Diagnostics diag.Diagnostics

	// RequiresReplace should be enabled if the resource should be replaced.
	RequiresReplace bool
}

RequiresReplaceIfFuncResponse is the response type for a RequiresReplaceIfFunc.