module

Documentation

Index

• type Backend
  • func (be *Backend) Equals(b *Backend) bool
• type DeclaredModuleCall
  • func (mc DeclaredModuleCall) Copy() DeclaredModuleCall
• type InstalledModuleCall
• type LocalSourceAddr
  • func (lsa LocalSourceAddr) ForDisplay() string
  • func (lsa LocalSourceAddr) String() string
• type Meta
• type ModuleCalls
• type ModuleSourceAddr
  • func ParseModuleSourceAddr(source string) ModuleSourceAddr
• type Output
• type ProviderRef
• type ProviderRequirements
  • func (pr ProviderRequirements) Equals(reqs ProviderRequirements) bool
• type RemoteSourceAddr
  • func (rsa RemoteSourceAddr) ForDisplay() string
  • func (rsa RemoteSourceAddr) String() string
• type UnknownSourceAddr
  • func (usa UnknownSourceAddr) ForDisplay() string
  • func (usa UnknownSourceAddr) String() string
• type Variable

Types

type Backend

type Backend struct {
	Type string
	Data backend.BackendData
}

func (*Backend) Equals

func (be *Backend) Equals(b *Backend) bool

type DeclaredModuleCall

type DeclaredModuleCall struct {
	LocalName     string
	RawSourceAddr string
	SourceAddr    ModuleSourceAddr
	Version       version.Constraints
	InputNames    []string
	RangePtr      *hcl.Range
}

func (DeclaredModuleCall) Copy

func (mc DeclaredModuleCall) Copy() DeclaredModuleCall

type InstalledModuleCall

type InstalledModuleCall struct {
	LocalName  string
	SourceAddr ModuleSourceAddr
	Version    *version.Version
	Path       string
}

type LocalSourceAddr

type LocalSourceAddr string

LocalSourceAddr represents a local module source address containing a path to a local directory

func (LocalSourceAddr) ForDisplay

func (lsa LocalSourceAddr) ForDisplay() string

func (LocalSourceAddr) String

func (lsa LocalSourceAddr) String() string

type Meta

type Meta struct {
	Path      string
	Filenames []string

	CoreRequirements     version.Constraints
	Backend              *Backend
	Cloud                *backend.Cloud
	ProviderReferences   map[ProviderRef]tfaddr.Provider
	ProviderRequirements ProviderRequirements
	Variables            map[string]Variable
	Outputs              map[string]Output
	ModuleCalls          map[string]DeclaredModuleCall
}

type ModuleCalls

type ModuleCalls struct {
	Installed map[string]InstalledModuleCall
	Declared  map[string]DeclaredModuleCall
}

type ModuleSourceAddr

type ModuleSourceAddr interface {
	ForDisplay() string
	String() string
}

func ParseModuleSourceAddr

func ParseModuleSourceAddr(source string) ModuleSourceAddr

Parses the raw module source string from a module block

type Output

type Output struct {
	Description string
	IsSensitive bool
	Value       cty.Value
}

type ProviderRef

type ProviderRef struct {
	LocalName string

	// If not empty, Alias identifies which non-default (aliased) provider
	// configuration this address refers to.
	Alias string
}

type ProviderRequirements

type ProviderRequirements map[tfaddr.Provider]version.Constraints

func (ProviderRequirements) Equals

func (pr ProviderRequirements) Equals(reqs ProviderRequirements) bool

type RemoteSourceAddr

type RemoteSourceAddr string

RemoteSourceAddr represents a remote module source address containing a source string normalized by go-getter's detection logic

func (RemoteSourceAddr) ForDisplay

func (rsa RemoteSourceAddr) ForDisplay() string

func (RemoteSourceAddr) String

func (rsa RemoteSourceAddr) String() string

type UnknownSourceAddr

type UnknownSourceAddr string

UnknownSourceAddr represents an unknown module source address as a fallback

func (UnknownSourceAddr) ForDisplay

func (usa UnknownSourceAddr) ForDisplay() string

func (UnknownSourceAddr) String

func (usa UnknownSourceAddr) String() string

type Variable

type Variable struct {
	Description string
	Type        cty.Type

	// In case the version it is before 0.14 sensitive will always be false
	// that was actually the default value for prior versions
	IsSensitive bool

	// DefaultValue represents default value if one is defined
	// and is decodable without errors, else cty.NilVal
	DefaultValue cty.Value

	// TypeDefaults represents any default values for optional object
	// attributes assuming Type is of cty.Object and has defaults.
	//
	// Any relationships between DefaultValue & TypeDefaults are left
	// for downstream to deal with using e.g. TypeDefaults.Apply().
	TypeDefaults *typeexpr.Defaults
}