package
1.12.0-alpha20250213
Repository: https://github.com/hashicorp/terraform.git
Documentation: pkg.go.dev
# Packages
No description provided by the author
Package statefile deals with the file format used to serialize states for persistent storage and then deserialize them into memory again later.
Package statemgr defines the interfaces and some supporting functionality for "state managers", which are components responsible for writing state to some persistent storage and then later retrieving it.
# Functions
BuildState is a helper -- primarily intended for tests -- to build a state using imperative code against the StateSync type while still acting as an expression of type *State to assign into a containing struct.
LegacyInstanceObjectID is a helper for extracting an object id value from an instance object in a way that approximates how we used to do this for the old state types.
NewCheckResults constructs a new states.CheckResults object that is a snapshot of the check statuses recorded in the given checks.State object.
NewDeposedKey is an alias for [addrs.NewDeposedKey].
NewModule constructs an empty module state for the given module address.
NewResourceInstance constructs and returns a new ResourceInstance, ready to use.
NewState constructs a minimal empty state, containing an empty root module.
ParseDeposedKey is an alias for [addrs.ParseDeposedKey].
# Constants
NotDeposed is an alias for the zero value of [addrs.DeposedKey], which represents the absense of a deposed key, i.e.
ObjectPlanned is a special object status used only for the transient placeholder objects we place into state during the refresh and plan walks to stand in for objects that will be created during apply.
ObjectReady is an object status for an object that is ready to use.
ObjectTainted is an object status representing an object that is in an unrecoverable bad state due to a partial failure during a create, update, or delete operation.
# Structs
CheckResultAggregate represents both the overall result for a particular configured object that has checks and the individual checkable objects it declared, if any.
CheckResultObject is the check status for a single checkable object.
CheckResults represents a summary snapshot of the status of a set of checks declared in configuration, updated after each Terraform Core run that changes the state or remote system in a way that might impact the check results.
Module is a container for the states of objects within a particular module.
OutputValue represents the state of a particular output value.
Resource represents the state of a resource.
ResourceInstance represents the state of a particular instance of a resource.
ResourceInstanceObject is the local representation of a specific remote object associated with a resource instance.
ResourceInstanceObjectSrc is a not-fully-decoded version of ResourceInstanceObject.
State is the top-level type of a Terraform state.
SyncState is a wrapper around State that provides concurrency-safe access to various common operations that occur during a Terraform graph walk, or other similar concurrent contexts.
# Type aliases
DeposedKey is an alias for [addrs.DeposedKey], representing keys assigned to deposed resource instance objects.
ObjectStatus represents the status of a RemoteObject.