package
1.12.0-alpha20250213
Repository: https://github.com/hashicorp/terraform.git
Documentation: pkg.go.dev

# Packages

Package configload knows how to install modules into the .terraform/modules directory and to load modules from those installed locations.
Package configschema contains types for describing the expected structure of a configuration block whose shape is not known until runtime.
No description provided by the author
No description provided by the author

# Functions

BuildConfig constructs a Config from a root module by loading all of its descendant modules via the given ModuleWalker.
No description provided by the author
IsEmptyDir returns true if the given filesystem path contains no Terraform configuration or test files.
IsIgnoredFile returns true if the given filename (which must not have a directory path ahead of it) should be ignored as e.g.
MergeBodies creates a new HCL body that contains a combination of the given base and override bodies.
NewEmptyConfig constructs a single-node configuration tree with an empty root module.
NewModule takes a list of primary files and a list of override files and produces a *Module by combining the files together.
NewModuleWithTests matches NewModule except it will also load in the provided test files.
NewParser creates and returns a new Parser that reads files from the given filesystem.
NewSourceBundleParser creates a new [SourceBundleParser] for the given source bundle.
ParseProviderConfigCompact parses the given absolute traversal as a relative provider address in compact form.
ParseProviderConfigCompactStr is a helper wrapper around ParseProviderConfigCompact that takes a string and parses it with the HCL native syntax traversal parser before interpreting it.
SynthBody is a forwarding alias for the old location of [configtesting.SynthBody].

# Constants

ApplyTestCommand causes the run block to execute a Terraform apply operation.
No description provided by the author
No description provided by the author
No description provided by the author
NormalTestMode causes the run block to execute in plans.NormalMode.
PlanTestCommand causes the run block to execute a Terraform plan operation.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
RefreshOnlyTestMode causes the run block to execute in plans.RefreshOnlyMode.
No description provided by the author
No description provided by the author
TypeHintList indicates that a value provided in an ambiguous context should be treated as an HCL expression, and additionally requires that the runtime value for the variable is of an tuple, list, or set type.
TypeHintMap indicates that a value provided in an ambiguous context should be treated as an HCL expression, and additionally requires that the runtime value for the variable is of an object or map type.
TypeHintNone indicates the absence of a type hint.
TypeHintString spec indicates that a value provided in an ambiguous context should be treated as a literal string, and additionally requires that the runtime value for the variable is of a primitive type (string, number, bool).
No description provided by the author
VariableParseHCL is a variable parsing mode that attempts to parse the given string as an HCL expression and returns the result.
VariableParseLiteral is a variable parsing mode that just takes the given string directly as a cty.String value.

# Variables

DisabledModuleWalker is a ModuleWalker that doesn't support child modules at all, and so will return an error if asked to load one.
ResourceBlockSchema is the schema for a resource or data resource type within Terraform.

# Structs

Backend represents a "backend" block inside a "terraform" block in a module or file.
Check represents a configuration defined check block.
CheckRule represents a configuration-defined validation rule, precondition, or postcondition.
Cloud represents a "cloud" block inside a "terraform" block in a module or file.
A Config is a node in the tree of modules within a configuration.
Connection represents a "connection" block when used within either a "resource" or "provisioner" block in a module or file.
File describes the contents of a single configuration file.
No description provided by the author
Local represents a single entry from a "locals" block in a module or file.
ManagedResource represents a "resource" block in a module or file.
MockData packages up all the available mock and override data available to a mocked provider.
MockResource maps a resource or data source type and name to a set of values for that resource.
Module is a container for a set of configuration constructs that are evaluated within a common namespace.
ModuleCall represents a "module" block in a module or file.
ModuleRequest is used with the ModuleWalker interface to describe a child module that must be loaded.
ModuleRequirements represents the provider requirements for an individual module, along with references to any child modules.
No description provided by the author
Output represents an "output" block in a module or file.
Override targets a specific module, resource or data source with a set of replacement values that should be used in place of whatever the underlying provider would normally do.
Parser is the main interface to read configuration files and other related files from disk.
PassedProviderConfig represents a provider config explicitly passed down to a child module, possibly giving it a new local address in the process.
Provider represents a "provider" block in a module or file.
No description provided by the author
ProviderMeta represents a "provider_meta" block inside a "terraform" block in a module or file.
Provisioner represents a "provisioner" block when used within a "resource" block in a module or file.
Removed describes the contents of a "removed" block in configuration.
RequiredProvider represents a declaration of a dependency on a particular provider version or source without actually configuring that provider.
RequiredProviderConfig represents a provider configuration that is required by a module, either explicitly or implicitly.
No description provided by the author
Resource represents a "resource" or "data" block in a module or file.
SourceBundleParser is the main interface to read configuration files and other related files from a source bundle.
TestFile represents a single test file within a `terraform test` execution.
TestFileConfig represents the configuration block within a test file.
TestFileModuleRequirements maps the runs for a given test file to the module requirements for that run block.
TestRun represents a single run block within a test file.
TestRunModuleCall specifies which module should be executed by a given run block.
TestRunOptions contains the plan options for a given run block.
Variable represents a "variable" block in a module or file.
VersionConstraint represents a version constraint on some resource (e.g.

# Interfaces

Container provides an interface for scoped resources.
MockDataLoader provides an interface similar to loading modules, except it loads and returns MockData objects for the testing framework to consume.
A ModuleWalker knows how to find and load a child module given details about the module to be loaded and a reference to its partially-loaded parent Config.

# Type aliases

MockDataLoaderFunc is an implementation of MockDataLoader that wraps a callback function, for more convenient use of that interface.
ModuleWalkerFunc is an implementation of ModuleWalker that directly wraps a callback function, for more convenient use of that interface.
No description provided by the author
ProvisionerOnFailure is an enum for valid values for on_failure options for provisioners.
ProvisionerWhen is an enum for valid values for when to run provisioners.
TestCommand represents the Terraform a given run block will execute, plan or apply.
TestMode represents the plan mode that Terraform will use for a given run block, normal or refresh-only.
VariableParsingMode defines how values of a particular variable given by text-only mechanisms (command line arguments and environment variables) should be parsed to produce the final value.
VariableTypeHint is an enumeration used for the Variable.TypeHint field, which is an incompletely-specified type for the variable which is used as a hint for whether a value provided in an ambiguous context (on the command line or in an environment variable) should be taken literally as a string or parsed as an HCL expression to produce a data structure.