Plan

public struct Plan : Decodable

A plan consists of a prior state, the configuration that is being applied to that state, and the set of changes Terraform plans to make to achieve that. For ease of consumption by callers, the plan representation includes a partial representation of the values in the final state (using a value representation), allowing callers to easily analyze the planned outcome using similar code as for analyzing the prior state.

  • priorState is a representation of the state that the configuration is being applied to, using the state representation described above.

    Declaration

    Swift

    public let priorState: State?

  • configuration is a representation of the configuration being applied to the prior state, using the configuration representation described above.

    Declaration

    Swift

    public let configuration: Configuration

  • A sub-object of plan output that describes a parsed Terraform configuration.

    See more

    Declaration

    Swift

    public struct Configuration : Decodable

  • plannedValues is a description of what is known so far of the outcome in the standard value representation, with any as-yet-unknown values omitted.

    Declaration

    Swift

    public let plannedValues: Values

  • proposedUnknown is a representation of the attributes, including any potentially-unknown attributes. Each value is replaced with “true” or “false” depending on whether it is known in the proposed plan.

    Declaration

    Swift

    public let proposedUnknown: Values?

  • variables is a representation of all the variables provided for the given plan. This is structured as a map similar to the output map so we can add additional fields in later.

    Declaration

    Swift

    public let variables: [String : Variable]

  • Undocumented

    See more

    Declaration

    Swift

    public struct Variable : Decodable

  • Each element of this array describes the action to take for one instance object. All resources in the configuration are included in this list.

    Declaration

    Swift

    public let resourceChanges: [ResourceChange]

  • A change describes the change that will be made to the indicated object.

    See more

    Declaration

    Swift

    public struct Change<Values> : Decodable where Values : Decodable

  • Undocumented

    See more

    Declaration

    Swift

    public struct ResourceChange : Decodable

  • Change describes the change that will be made to the indicated output value, using the same representation as for resource changes except that the only valid actions values are: [“create”] [“update”] [“delete”] In the Terraform CLI 0.12.0 release, Terraform is not yet fully able to track changes to output values, so the actions indicated may not be fully accurate, but the “after” value will always be correct.

    Declaration

    Swift

    public let outputChanges: [String : Change<AnyDecodable>]