numberplanmodifier

package
v1.13.0 Latest Latest
Warning

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

Go to latest
Published: Oct 31, 2024 License: MPL-2.0 Imports: 3 Imported by: 2

Documentation

Overview

Package numberplanmodifier provides plan modifiers for types.Number attributes.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func RequiresReplace

func RequiresReplace() planmodifier.Number

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.Number

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.Number

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.Number

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

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.

Jump to

Keyboard shortcuts

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