objchange

Documentation

Index

• func AssertPlanValid(schema *configschema.Block, priorState, config, plannedState cty.Value) []error
• func PlannedDataResourceObject(schema *configschema.Block, config cty.Value) cty.Value
• func ProposedNew(schema *configschema.Block, prior, config cty.Value) cty.Value

Functions

func AssertPlanValid

func AssertPlanValid(schema *configschema.Block, priorState, config, plannedState cty.Value) []error

AssertPlanValid checks checks whether a planned new state returned by a provider's PlanResourceChange method is suitable to achieve a change from priorState to config. It returns a slice with nonzero length if any problems are detected. Because problems here indicate bugs in the provider that generated the plannedState, they are written with provider developers as an audience, rather than end-users.

All of the given values must have the same type and must conform to the implied type of the given schema, or this function may panic or produce garbage results.

During planning, a provider may only make changes to attributes that are null (unset) in the configuration and are marked as "computed" in the resource type schema, in order to insert any default values the provider may know about. If the default value cannot be determined until apply time, the provider can return an unknown value. Providers are forbidden from planning a change that disagrees with any non-null argument in the configuration.

As a special exception, providers _are_ allowed to provide attribute values conflicting with configuration if and only if the planned value exactly matches the corresponding attribute value in the prior state. The provider can use this to signal that the new value is functionally equivalent to the old and thus no change is required.

func PlannedDataResourceObject

func PlannedDataResourceObject(schema *configschema.Block, config cty.Value) cty.Value

PlannedDataResourceObject is similar to proposedNewBlock but tailored for planning data resources in particular. Specifically, it replaces the values of any Computed attributes not set in the configuration with an unknown value, which serves as a placeholder for a value to be filled in by the provider when the data resource is finally read.

Data resources are different because the planning of them is handled entirely within OpenTofu Core and not subject to customization by the provider. This function is, in effect, producing an equivalent result to passing the proposedNewBlock result into a provider's PlanResourceChange function, assuming a fixed implementation of PlanResourceChange that just fills in unknown values as needed.

func ProposedNew

func ProposedNew(schema *configschema.Block, prior, config cty.Value) cty.Value

ProposedNew constructs a proposed new object value by combining the computed attribute values from "prior" with the configured attribute values from "config".

Both value must conform to the given schema's implied type, or this function will panic.

The prior value must be wholly known, but the config value may be unknown or have nested unknown values.

The merging of the two objects includes the attributes of any nested blocks, which will be correlated in a manner appropriate for their nesting mode. Note in particular that the correlation for blocks backed by sets is a heuristic based on matching non-computed attribute values and so it may produce strange results with more "extreme" cases, such as a nested set block where _all_ attributes are computed.