stringplanmodifier

Documentation

Index

• func RequiresRefreshIf(f RequiresRefreshIfFunc, description, markdownDescription string) planmodifier.String
• type RequiresRefreshIfFunc
• type RequiresRefreshIfFuncResponse

Functions

func RequiresRefreshIf

func RequiresRefreshIf(f RequiresRefreshIfFunc, description, markdownDescription string) planmodifier.String

RequiresRefreshIf returns a plan modifier that conditionally requires attribute refreshment if:

• The resource is planned for update.
• The given function returns true. Returning false will not unset any prior resource refreshment.

Types

type RequiresRefreshIfFunc

type RequiresRefreshIfFunc func(context.Context, planmodifier.StringRequest, *RequiresRefreshIfFuncResponse)

RequiresRefreshIfFunc is a conditional function used in the RequiresRefreshIf plan modifier to determine whether the attribute requires refreshment.

type RequiresRefreshIfFuncResponse

type RequiresRefreshIfFuncResponse 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

	// RequiresRefresh should be enabled if the resource should be refreshed.
	RequiresRefresh bool
}

RequiresRefreshIfFuncResponse is the response type for a RequiresRefreshIfFunc.