terraform: github.com/hashicorp/terraform/configs Index | Files | Directories

package configs

import "github.com/hashicorp/terraform/configs"

Package configs contains types that represent Terraform configurations and the different elements thereof.

The functionality in this package can be used for some static analyses of Terraform configurations, but this package generally exposes representations of the configuration source code rather than the result of evaluating these objects. The sibling package "lang" deals with evaluation of structures and expressions in the configuration.

Due to its close relationship with HCL, this package makes frequent use of types from the HCL API, including raw HCL diagnostic messages. Such diagnostics can be converted into Terraform-flavored diagnostics, if needed, using functions in the sibling package tfdiags.

The Parser type is the main entry-point into this package. The LoadConfigDir method can be used to load a single module directory, and then a full configuration (including any descendent modules) can be produced using the top-level BuildConfig method.


Package Files

backend.go compat_shim.go config.go config_build.go depends_on.go doc.go experiments.go module.go module_call.go module_merge.go module_merge_body.go named_values.go parser.go parser_config.go parser_config_dir.go parser_values.go provider.go provider_meta.go provider_requirements.go provisioner.go provisioneronfailure_string.go provisionerwhen_string.go resource.go synth_body.go util.go variable_type_hint.go variabletypehint_string.go version_constraint.go

func IsEmptyDir Uses

func IsEmptyDir(path string) (bool, error)

IsEmptyDir returns true if the given filesystem path contains no Terraform configuration files.

Unlike the methods of the Parser type, this function always consults the real filesystem, and thus it isn't appropriate to use when working with configuration loaded from a plan file.

func IsIgnoredFile Uses

func IsIgnoredFile(name string) bool

IsIgnoredFile returns true if the given filename (which must not have a directory path ahead of it) should be ignored as e.g. an editor swap file.

func MergeBodies Uses

func MergeBodies(base, override hcl.Body) hcl.Body

MergeBodies creates a new HCL body that contains a combination of the given base and override bodies. Attributes and blocks defined in the override body take precedence over those of the same name defined in the base body.

If any block of a particular type appears in "override" then it will replace _all_ of the blocks of the same type in "base" in the new body.

func ParseProviderConfigCompact Uses

func ParseProviderConfigCompact(traversal hcl.Traversal) (addrs.LocalProviderConfig, tfdiags.Diagnostics)

ParseProviderConfigCompact parses the given absolute traversal as a relative provider address in compact form. The following are examples of traversals that can be successfully parsed as compact relative provider configuration addresses:


This function will panic if given a relative traversal.

If the returned diagnostics contains errors then the result value is invalid and must not be used.

func ParseProviderConfigCompactStr Uses

func ParseProviderConfigCompactStr(str string) (addrs.LocalProviderConfig, tfdiags.Diagnostics)

ParseProviderConfigCompactStr is a helper wrapper around ParseProviderConfigCompact that takes a string and parses it with the HCL native syntax traversal parser before interpreting it.

This should be used only in specialized situations since it will cause the created references to not have any meaningful source location information. If a reference string is coming from a source that should be identified in error messages then the caller should instead parse it directly using a suitable function from the HCL API and pass the traversal itself to ParseProviderConfigCompact.

Error diagnostics are returned if either the parsing fails or the analysis of the traversal fails. There is no way for the caller to distinguish the two kinds of diagnostics programmatically. If error diagnostics are returned then the returned address is invalid.

func SynthBody Uses

func SynthBody(filename string, values map[string]cty.Value) hcl.Body

SynthBody produces a synthetic hcl.Body that behaves as if it had attributes corresponding to the elements given in the values map.

This is useful in situations where, for example, values provided on the command line can override values given in configuration, using MergeBodies.

The given filename is used in case any diagnostics are returned. Since the created body is synthetic, it is likely that this will not be a "real" filename. For example, if from a command line argument it could be a representation of that argument's name, such as "-var=...".

type Backend Uses

type Backend struct {
    Type   string
    Config hcl.Body

    TypeRange hcl.Range
    DeclRange hcl.Range

Backend represents a "backend" block inside a "terraform" block in a module or file.

func (*Backend) Hash Uses

func (b *Backend) Hash(schema *configschema.Block) int

Hash produces a hash value for the reciever that covers the type and the portions of the config that conform to the given schema.

If the config does not conform to the schema then the result is not meaningful for comparison since it will be based on an incomplete result.

As an exception, required attributes in the schema are treated as optional for the purpose of hashing, so that an incomplete configuration can still be hashed. Other errors, such as extraneous attributes, have no such special case.

type Config Uses

type Config struct {
    // RootModule points to the Config for the root module within the same
    // module tree as this module. If this module _is_ the root module then
    // this is self-referential.
    Root *Config

    // ParentModule points to the Config for the module that directly calls
    // this module. If this is the root module then this field is nil.
    Parent *Config

    // Path is a sequence of module logical names that traverse from the root
    // module to this config. Path is empty for the root module.
    // This should only be used to display paths to the end-user in rare cases
    // where we are talking about the static module tree, before module calls
    // have been resolved. In most cases, an addrs.ModuleInstance describing
    // a node in the dynamic module tree is better, since it will then include
    // any keys resulting from evaluating "count" and "for_each" arguments.
    Path addrs.Module

    // ChildModules points to the Config for each of the direct child modules
    // called from this module. The keys in this map match the keys in
    // Module.ModuleCalls.
    Children map[string]*Config

    // Module points to the object describing the configuration for the
    // various elements (variables, resources, etc) defined by this module.
    Module *Module

    // CallRange is the source range for the header of the module block that
    // requested this module.
    // This field is meaningless for the root module, where its contents are undefined.
    CallRange hcl.Range

    // SourceAddr is the source address that the referenced module was requested
    // from, as specified in configuration.
    // This field is meaningless for the root module, where its contents are undefined.
    SourceAddr string

    // SourceAddrRange is the location in the configuration source where the
    // SourceAddr value was set, for use in diagnostic messages.
    // This field is meaningless for the root module, where its contents are undefined.
    SourceAddrRange hcl.Range

    // Version is the specific version that was selected for this module,
    // based on version constraints given in configuration.
    // This field is nil if the module was loaded from a non-registry source,
    // since versions are not supported for other sources.
    // This field is meaningless for the root module, where it will always
    // be nil.
    Version *version.Version

A Config is a node in the tree of modules within a configuration.

The module tree is constructed by following ModuleCall instances recursively through the root module transitively into descendent modules.

A module tree described in *this* package represents the static tree represented by configuration. During evaluation a static ModuleNode may expand into zero or more module instances depending on the use of count and for_each configuration attributes within each call.

func BuildConfig Uses

func BuildConfig(root *Module, walker ModuleWalker) (*Config, hcl.Diagnostics)

BuildConfig constructs a Config from a root module by loading all of its descendent modules via the given ModuleWalker.

The result is a module tree that has so far only had basic module- and file-level invariants validated. If the returned diagnostics contains errors, the returned module tree may be incomplete but can still be used carefully for static analysis.

func NewEmptyConfig Uses

func NewEmptyConfig() *Config

NewEmptyConfig constructs a single-node configuration tree with an empty root module. This is generally a pretty useless thing to do, so most callers should instead use BuildConfig.

func (*Config) AllModules Uses

func (c *Config) AllModules() []*Config

AllModules returns a slice of all the receiver and all of its descendent nodes in the module tree, in the same order they would be visited by DeepEach.

func (*Config) DeepEach Uses

func (c *Config) DeepEach(cb func(c *Config))

DeepEach calls the given function once for each module in the tree, starting with the receiver.

A parent is always called before its children and children of a particular node are visited in lexicographic order by their names.

func (*Config) Depth Uses

func (c *Config) Depth() int

Depth returns the number of "hops" the receiver is from the root of its module tree, with the root module having a depth of zero.

func (*Config) Descendent Uses

func (c *Config) Descendent(path addrs.Module) *Config

Descendent returns the descendent config that has the given path beneath the receiver, or nil if there is no such module.

The path traverses the static module tree, prior to any expansion to handle count and for_each arguments.

An empty path will just return the receiver, and is therefore pointless.

func (*Config) DescendentForInstance Uses

func (c *Config) DescendentForInstance(path addrs.ModuleInstance) *Config

DescendentForInstance is like Descendent except that it accepts a path to a particular module instance in the dynamic module graph, returning the node from the static module graph that corresponds to it.

All instances created by a particular module call share the same configuration, so the keys within the given path are disregarded.

func (*Config) ProviderForConfigAddr Uses

func (c *Config) ProviderForConfigAddr(addr addrs.LocalProviderConfig) addrs.Provider

ProviderForConfigAddr returns the FQN for a given addrs.ProviderConfig, first by checking for the provider in module.ProviderRequirements and falling back to addrs.NewDefaultProvider if it is not found.

func (*Config) ProviderRequirements Uses

func (c *Config) ProviderRequirements() (getproviders.Requirements, hcl.Diagnostics)

ProviderRequirements searches the full tree of modules under the receiver for both explicit and implicit dependencies on providers.

The result is a full manifest of all of the providers that must be available in order to work with the receiving configuration.

If the returned diagnostics includes errors then the resulting Requirements may be incomplete.

func (*Config) ProviderRequirementsByModule Uses

func (c *Config) ProviderRequirementsByModule() (*ModuleRequirements, hcl.Diagnostics)

ProviderRequirementsByModule searches the full tree of modules under the receiver for both explicit and implicit dependencies on providers, constructing a tree where the requirements are broken out by module.

If the returned diagnostics includes errors then the resulting Requirements may be incomplete.

func (*Config) ProviderTypes Uses

func (c *Config) ProviderTypes() []addrs.Provider

ProviderTypes returns the FQNs of each distinct provider type referenced in the receiving configuration.

This is a helper for easily determining which provider types are required to fully interpret the configuration, though it does not include version information and so callers are expected to have already dealt with provider version selection in an earlier step and have identified suitable versions for each provider.

func (*Config) ResolveAbsProviderAddr Uses

func (c *Config) ResolveAbsProviderAddr(addr addrs.ProviderConfig, inModule addrs.Module) addrs.AbsProviderConfig

ResolveAbsProviderAddr returns the AbsProviderConfig represented by the given ProviderConfig address, which must not be nil or this method will panic.

If the given address is already an AbsProviderConfig then this method returns it verbatim, and will always succeed. If it's a LocalProviderConfig then it will consult the local-to-FQN mapping table for the given module to find the absolute address corresponding to the given local one.

The module address to resolve local addresses in must be given in the second argument, and must refer to a module that exists under the receiver or else this method will panic.

type Connection Uses

type Connection struct {
    Config hcl.Body

    DeclRange hcl.Range

Connection represents a "connection" block when used within either a "resource" or "provisioner" block in a module or file.

type File Uses

type File struct {
    CoreVersionConstraints []VersionConstraint

    ActiveExperiments experiments.Set

    Backends          []*Backend
    ProviderConfigs   []*Provider
    ProviderMetas     []*ProviderMeta
    RequiredProviders []*RequiredProviders

    Variables []*Variable
    Locals    []*Local
    Outputs   []*Output

    ModuleCalls []*ModuleCall

    ManagedResources []*Resource
    DataResources    []*Resource

File describes the contents of a single configuration file.

Individual files are not usually used alone, but rather combined together with other files (conventionally, those in the same directory) to produce a *Module, using NewModule.

At the level of an individual file we represent directly the structural elements present in the file, without any attempt to detect conflicting declarations. A File object can therefore be used for some basic static analysis of individual elements, but must be built into a Module to detect duplicate declarations.

type Local Uses

type Local struct {
    Name string
    Expr hcl.Expression

    DeclRange hcl.Range

Local represents a single entry from a "locals" block in a module or file. The "locals" block itself is not represented, because it serves only to provide context for us to interpret its contents.

func (*Local) Addr Uses

func (l *Local) Addr() addrs.LocalValue

Addr returns the address of the local value declared by the receiver, relative to its containing module.

type ManagedResource Uses

type ManagedResource struct {
    Connection   *Connection
    Provisioners []*Provisioner

    CreateBeforeDestroy bool
    PreventDestroy      bool
    IgnoreChanges       []hcl.Traversal
    IgnoreAllChanges    bool

    CreateBeforeDestroySet bool
    PreventDestroySet      bool

ManagedResource represents a "resource" block in a module or file.

type Module Uses

type Module struct {

    // Any other caller that constructs a module directly with NewModule may
    // assign a suitable value to this attribute before using it for other
    // purposes. It should be treated as immutable by all consumers of Module
    // values.
    SourceDir string

    CoreVersionConstraints []VersionConstraint

    ActiveExperiments experiments.Set

    Backend              *Backend
    ProviderConfigs      map[string]*Provider
    ProviderRequirements *RequiredProviders
    ProviderLocalNames   map[addrs.Provider]string
    ProviderMetas        map[addrs.Provider]*ProviderMeta

    Variables map[string]*Variable
    Locals    map[string]*Local
    Outputs   map[string]*Output

    ModuleCalls map[string]*ModuleCall

    ManagedResources map[string]*Resource
    DataResources    map[string]*Resource

Module is a container for a set of configuration constructs that are evaluated within a common namespace.

func NewModule Uses

func NewModule(primaryFiles, overrideFiles []*File) (*Module, hcl.Diagnostics)

NewModule takes a list of primary files and a list of override files and produces a *Module by combining the files together.

If there are any conflicting declarations in the given files -- for example, if the same variable name is defined twice -- then the resulting module will be incomplete and error diagnostics will be returned. Careful static analysis of the returned Module is still possible in this case, but the module will probably not be semantically valid.

func (*Module) ImpliedProviderForUnqualifiedType Uses

func (m *Module) ImpliedProviderForUnqualifiedType(pType string) addrs.Provider

ImpliedProviderForUnqualifiedType returns the provider FQN for a given type, first by looking up the type in the provider requirements map, and falling back to an implied default provider.

The intended behaviour is that configuring a provider with local name "foo" in a required_providers block will result in resources with type "foo" using that provider.

func (*Module) LocalNameForProvider Uses

func (m *Module) LocalNameForProvider(p addrs.Provider) string

LocalNameForProvider returns the module-specific user-supplied local name for a given provider FQN, or the default local name if none was supplied.

func (*Module) ProviderForLocalConfig Uses

func (m *Module) ProviderForLocalConfig(pc addrs.LocalProviderConfig) addrs.Provider

ProviderForLocalConfig returns the provider FQN for a given LocalProviderConfig, based on its local name.

func (*Module) ResourceByAddr Uses

func (m *Module) ResourceByAddr(addr addrs.Resource) *Resource

ResourceByAddr returns the configuration for the resource with the given address, or nil if there is no such resource.

type ModuleCall Uses

type ModuleCall struct {
    Name string

    SourceAddr      string
    SourceAddrRange hcl.Range
    SourceSet       bool

    Config hcl.Body

    Version VersionConstraint

    Count   hcl.Expression
    ForEach hcl.Expression

    Providers []PassedProviderConfig

    DependsOn []hcl.Traversal

    DeclRange hcl.Range

ModuleCall represents a "module" block in a module or file.

type ModuleRequest Uses

type ModuleRequest struct {
    // Name is the "logical name" of the module call within configuration.
    // This is provided in case the name is used as part of a storage key
    // for the module, but implementations must otherwise treat it as an
    // opaque string. It is guaranteed to have already been validated as an
    // HCL identifier and UTF-8 encoded.
    Name string

    // Path is a list of logical names that traverse from the root module to
    // this module. This can be used, for example, to form a lookup key for
    // each distinct module call in a configuration, allowing for multiple
    // calls with the same name at different points in the tree.
    Path addrs.Module

    // SourceAddr is the source address string provided by the user in
    // configuration.
    SourceAddr string

    // SourceAddrRange is the source range for the SourceAddr value as it
    // was provided in configuration. This can and should be used to generate
    // diagnostics about the source address having invalid syntax, referring
    // to a non-existent object, etc.
    SourceAddrRange hcl.Range

    // VersionConstraint is the version constraint applied to the module in
    // configuration. This data structure includes the source range for
    // the constraint, which can and should be used to generate diagnostics
    // about constraint-related issues, such as constraints that eliminate all
    // available versions of a module whose source is otherwise valid.
    VersionConstraint VersionConstraint

    // Parent is the partially-constructed module tree node that the loaded
    // module will be added to. Callers may refer to any field of this
    // structure except Children, which is still under construction when
    // ModuleRequest objects are created and thus has undefined content.
    // The main reason this is provided is so that full module paths can
    // be constructed for uniqueness.
    Parent *Config

    // CallRange is the source range for the header of the "module" block
    // in configuration that prompted this request. This can be used as the
    // subject of an error diagnostic that relates to the module call itself,
    // rather than to either its source address or its version number.
    CallRange hcl.Range

ModuleRequest is used with the ModuleWalker interface to describe a child module that must be loaded.

type ModuleRequirements Uses

type ModuleRequirements struct {
    Name         string
    SourceAddr   string
    SourceDir    string
    Requirements getproviders.Requirements
    Children     map[string]*ModuleRequirements

ModuleRequirements represents the provider requirements for an individual module, along with references to any child modules. This is used to determine which modules require which providers.

type ModuleWalker Uses

type ModuleWalker interface {
    // LoadModule finds and loads a requested child module.
    // If errors are detected during loading, implementations should return them
    // in the diagnostics object. If the diagnostics object contains any errors
    // then the caller will tolerate the returned module being nil or incomplete.
    // If no errors are returned, it should be non-nil and complete.
    // Full validation need not have been performed but an implementation should
    // ensure that the basic file- and module-validations performed by the
    // LoadConfigDir function (valid syntax, no namespace collisions, etc) have
    // been performed before returning a module.
    LoadModule(req *ModuleRequest) (*Module, *version.Version, hcl.Diagnostics)

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.

var DisabledModuleWalker ModuleWalker

DisabledModuleWalker is a ModuleWalker that doesn't support child modules at all, and so will return an error if asked to load one.

This is provided primarily for testing. There is no good reason to use this in the main application.

type ModuleWalkerFunc Uses

type ModuleWalkerFunc func(req *ModuleRequest) (*Module, *version.Version, hcl.Diagnostics)

ModuleWalkerFunc is an implementation of ModuleWalker that directly wraps a callback function, for more convenient use of that interface.

func (ModuleWalkerFunc) LoadModule Uses

func (f ModuleWalkerFunc) LoadModule(req *ModuleRequest) (*Module, *version.Version, hcl.Diagnostics)

LoadModule implements ModuleWalker.

type Output Uses

type Output struct {
    Name        string
    Description string
    Expr        hcl.Expression
    DependsOn   []hcl.Traversal
    Sensitive   bool

    DescriptionSet bool
    SensitiveSet   bool

    DeclRange hcl.Range

Output represents an "output" block in a module or file.

type Parser Uses

type Parser struct {
    // contains filtered or unexported fields

Parser is the main interface to read configuration files and other related files from disk.

It retains a cache of all files that are loaded so that they can be used to create source code snippets in diagnostics, etc.

func NewParser Uses

func NewParser(fs afero.Fs) *Parser

NewParser creates and returns a new Parser that reads files from the given filesystem. If a nil filesystem is passed then the system's "real" filesystem will be used, via afero.OsFs.

func (Parser) ConfigDirFiles Uses

func (p Parser) ConfigDirFiles(dir string) (primary, override []string, diags hcl.Diagnostics)

ConfigDirFiles returns lists of the primary and override files configuration files in the given directory.

If the given directory does not exist or cannot be read, error diagnostics are returned. If errors are returned, the resulting lists may be incomplete.

func (*Parser) ForceFileSource Uses

func (p *Parser) ForceFileSource(filename string, src []byte)

ForceFileSource artificially adds source code to the cache of file sources, as if it had been loaded from the given filename.

This should be used only in special situations where configuration is loaded some other way. Most callers should load configuration via methods of Parser, which will update the sources cache automatically.

func (*Parser) IsConfigDir Uses

func (p *Parser) IsConfigDir(path string) bool

IsConfigDir determines whether the given path refers to a directory that exists and contains at least one Terraform config file (with a .tf or .tf.json extension.)

func (*Parser) LoadConfigDir Uses

func (p *Parser) LoadConfigDir(path string) (*Module, hcl.Diagnostics)

LoadConfigDir reads the .tf and .tf.json files in the given directory as config files (using LoadConfigFile) and then combines these files into a single Module.

If this method returns nil, that indicates that the given directory does not exist at all or could not be opened for some reason. Callers may wish to detect this case and ignore the returned diagnostics so that they can produce a more context-aware error message in that case.

If this method returns a non-nil module while error diagnostics are returned then the module may be incomplete but can be used carefully for static analysis.

This file does not consider a directory with no files to be an error, and will simply return an empty module in that case. Callers should first call Parser.IsConfigDir if they wish to recognize that situation.

.tf files are parsed using the HCL native syntax while .tf.json files are parsed using the HCL JSON syntax.

func (*Parser) LoadConfigFile Uses

func (p *Parser) LoadConfigFile(path string) (*File, hcl.Diagnostics)

LoadConfigFile reads the file at the given path and parses it as a config file.

If the file cannot be read -- for example, if it does not exist -- then a nil *File will be returned along with error diagnostics. Callers may wish to disregard the returned diagnostics in this case and instead generate their own error message(s) with additional context.

If the returned diagnostics has errors when a non-nil map is returned then the map may be incomplete but should be valid enough for careful static analysis.

This method wraps LoadHCLFile, and so it inherits the syntax selection behaviors documented for that method.

func (*Parser) LoadConfigFileOverride Uses

func (p *Parser) LoadConfigFileOverride(path string) (*File, hcl.Diagnostics)

LoadConfigFileOverride is the same as LoadConfigFile except that it relaxes certain required attribute constraints in order to interpret the given file as an overrides file.

func (*Parser) LoadHCLFile Uses

func (p *Parser) LoadHCLFile(path string) (hcl.Body, hcl.Diagnostics)

LoadHCLFile is a low-level method that reads the file at the given path, parses it, and returns the hcl.Body representing its root. In many cases it is better to use one of the other Load*File methods on this type, which additionally decode the root body in some way and return a higher-level construct.

If the file cannot be read at all -- e.g. because it does not exist -- then this method will return a nil body and error diagnostics. In this case callers may wish to ignore the provided error diagnostics and produce a more context-sensitive error instead.

The file will be parsed using the HCL native syntax unless the filename ends with ".json", in which case the HCL JSON syntax will be used.

func (*Parser) LoadValuesFile Uses

func (p *Parser) LoadValuesFile(path string) (map[string]cty.Value, hcl.Diagnostics)

LoadValuesFile reads the file at the given path and parses it as a "values file", which is an HCL config file whose top-level attributes are treated as arbitrary key.value pairs.

If the file cannot be read -- for example, if it does not exist -- then a nil map will be returned along with error diagnostics. Callers may wish to disregard the returned diagnostics in this case and instead generate their own error message(s) with additional context.

If the returned diagnostics has errors when a non-nil map is returned then the map may be incomplete but should be valid enough for careful static analysis.

This method wraps LoadHCLFile, and so it inherits the syntax selection behaviors documented for that method.

func (*Parser) Sources Uses

func (p *Parser) Sources() map[string][]byte

Sources returns a map of the cached source buffers for all files that have been loaded through this parser, with source filenames (as requested when each file was opened) as the keys.

type PassedProviderConfig Uses

type PassedProviderConfig struct {
    InChild  *ProviderConfigRef
    InParent *ProviderConfigRef

PassedProviderConfig represents a provider config explicitly passed down to a child module, possibly giving it a new local address in the process.

type Provider Uses

type Provider struct {
    Name       string
    NameRange  hcl.Range
    Alias      string
    AliasRange *hcl.Range // nil if no alias set

    Version VersionConstraint

    Config hcl.Body

    DeclRange hcl.Range

Provider represents a "provider" block in a module or file. A provider block is a provider configuration, and there can be zero or more configurations for each actual provider.

func (*Provider) Addr Uses

func (p *Provider) Addr() addrs.LocalProviderConfig

Addr returns the address of the receiving provider configuration, relative to its containing module.

type ProviderConfigRef Uses

type ProviderConfigRef struct {
    Name       string
    NameRange  hcl.Range
    Alias      string
    AliasRange *hcl.Range // nil if alias not set

func (*ProviderConfigRef) Addr Uses

func (r *ProviderConfigRef) Addr() addrs.LocalProviderConfig

Addr returns the provider config address corresponding to the receiving config reference.

This is a trivial conversion, essentially just discarding the source location information and keeping just the addressing information.

func (*ProviderConfigRef) String Uses

func (r *ProviderConfigRef) String() string

type ProviderMeta Uses

type ProviderMeta struct {
    Provider string
    Config   hcl.Body

    ProviderRange hcl.Range
    DeclRange     hcl.Range

ProviderMeta represents a "provider_meta" block inside a "terraform" block in a module or file.

type Provisioner Uses

type Provisioner struct {
    Type       string
    Config     hcl.Body
    Connection *Connection
    When       ProvisionerWhen
    OnFailure  ProvisionerOnFailure

    DeclRange hcl.Range
    TypeRange hcl.Range

Provisioner represents a "provisioner" block when used within a "resource" block in a module or file.

type ProvisionerOnFailure Uses

type ProvisionerOnFailure int

ProvisionerOnFailure is an enum for valid values for on_failure options for provisioners.

const (
    ProvisionerOnFailureInvalid ProvisionerOnFailure = iota

func (ProvisionerOnFailure) String Uses

func (i ProvisionerOnFailure) String() string

type ProvisionerWhen Uses

type ProvisionerWhen int

ProvisionerWhen is an enum for valid values for when to run provisioners.

const (
    ProvisionerWhenInvalid ProvisionerWhen = iota

func (ProvisionerWhen) String Uses

func (i ProvisionerWhen) String() string

type RequiredProvider Uses

type RequiredProvider struct {
    Name        string
    Source      string
    Type        addrs.Provider
    Requirement VersionConstraint
    DeclRange   hcl.Range

RequiredProvider represents a declaration of a dependency on a particular provider version or source without actually configuring that provider. This is used in child modules that expect a provider to be passed in from their parent.

type RequiredProviders Uses

type RequiredProviders struct {
    RequiredProviders map[string]*RequiredProvider
    DeclRange         hcl.Range

type Resource Uses

type Resource struct {
    Mode    addrs.ResourceMode
    Name    string
    Type    string
    Config  hcl.Body
    Count   hcl.Expression
    ForEach hcl.Expression

    ProviderConfigRef *ProviderConfigRef
    Provider          addrs.Provider

    DependsOn []hcl.Traversal

    // Managed is populated only for Mode = addrs.ManagedResourceMode,
    // containing the additional fields that apply to managed resources.
    // For all other resource modes, this field is nil.
    Managed *ManagedResource

    DeclRange hcl.Range
    TypeRange hcl.Range

Resource represents a "resource" or "data" block in a module or file.

func (*Resource) Addr Uses

func (r *Resource) Addr() addrs.Resource

Addr returns a resource address for the receiver that is relative to the resource's containing module.

func (*Resource) ProviderConfigAddr Uses

func (r *Resource) ProviderConfigAddr() addrs.LocalProviderConfig

ProviderConfigAddr returns the address for the provider configuration that should be used for this resource. This function returns a default provider config addr if an explicit "provider" argument was not provided.

type Variable Uses

type Variable struct {
    Name        string
    Description string
    Default     cty.Value
    Type        cty.Type
    ParsingMode VariableParsingMode
    Validations []*VariableValidation
    Sensitive   bool

    DescriptionSet bool

    DeclRange hcl.Range

Variable represents a "variable" block in a module or file.

func (*Variable) Required Uses

func (v *Variable) Required() bool

Required returns true if this variable is required to be set by the caller, or false if there is a default value that will be used when it isn't set.

type VariableParsingMode Uses

type VariableParsingMode rune

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.

const VariableParseHCL VariableParsingMode = 'H'

VariableParseHCL is a variable parsing mode that attempts to parse the given string as an HCL expression and returns the result.

const VariableParseLiteral VariableParsingMode = 'L'

VariableParseLiteral is a variable parsing mode that just takes the given string directly as a cty.String value.

func (VariableParsingMode) Parse Uses

func (m VariableParsingMode) Parse(name, value string) (cty.Value, hcl.Diagnostics)

Parse uses the receiving parsing mode to process the given variable value string, returning the result along with any diagnostics.

A VariableParsingMode does not know the expected type of the corresponding variable, so it's the caller's responsibility to attempt to convert the result to the appropriate type and return to the user any diagnostics that conversion may produce.

The given name is used to create a synthetic filename in case any diagnostics must be generated about the given string value. This should be the name of the root module variable whose value will be populated from the given string.

If the returned diagnostics has errors, the returned value may not be valid.

type VariableTypeHint Uses

type VariableTypeHint rune

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.

The type hint is applied to runtime values as well, but since it does not accurately describe a precise type it is not fully-sufficient to infer the dynamic type of a value passed through a variable.

These hints use inaccurate terminology for historical reasons. Full details are in the documentation for each constant in this enumeration, but in summary:

TypeHintString requires a primitive type
TypeHintList requires a type that could be converted to a tuple
TypeHintMap requires a type that could be converted to an object
const TypeHintList VariableTypeHint = 'L'

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.

const TypeHintMap VariableTypeHint = 'M'

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.

const TypeHintNone VariableTypeHint = 0

TypeHintNone indicates the absence of a type hint. Values specified in ambiguous contexts will be treated as literal strings, as if TypeHintString were selected, but no runtime value checks will be applied. This is reasonable type hint for a module that is never intended to be used at the top-level of a configuration, since descendent modules never receive values from ambiguous contexts.

const TypeHintString VariableTypeHint = 'S'

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

func (VariableTypeHint) String Uses

func (i VariableTypeHint) String() string

type VariableValidation Uses

type VariableValidation struct {
    // Condition is an expression that refers to the variable being tested
    // and contains no other references. The expression must return true
    // to indicate that the value is valid or false to indicate that it is
    // invalid. If the expression produces an error, that's considered a bug
    // in the module defining the validation rule, not an error in the caller.
    Condition hcl.Expression

    // ErrorMessage is one or more full sentences, which would need to be in
    // English for consistency with the rest of the error message output but
    // can in practice be in any language as long as it ends with a period.
    // The message should describe what is required for the condition to return
    // true in a way that would make sense to a caller of the module.
    ErrorMessage string

    DeclRange hcl.Range

VariableValidation represents a configuration-defined validation rule for a particular input variable, given as a "validation" block inside a "variable" block.

type VersionConstraint Uses

type VersionConstraint struct {
    Required  version.Constraints
    DeclRange hcl.Range

VersionConstraint represents a version constraint on some resource (e.g. Terraform Core, a provider, a module, ...) that carries with it a source range so that a helpful diagnostic can be printed in the event that a particular constraint does not match.


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

Package configs imports 22 packages (graph) and is imported by 68 packages. Updated 2020-09-23. Refresh now. Tools for package owners.