tfstate

package

v1.2.0 Latest Latest Go to latest Published: Mar 19, 2024 License: MPL-2.0 Imports: 30 Imported by: 13

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

View Source

const (
	StateVersion = 4
)

This section is empty.

func FuncMap(ctx context.Context, stateLoc string) (template.FuncMap, error)

FuncMap provides a tamplate.FuncMap tfstate based on URL and provide

func FuncMapWithName(ctx context.Context, name string, stateLoc string) (template.FuncMap, error)

FuncMapWithName provides a tamplate.FuncMap. can lockup values from tfstate.

func MustFuncMap(ctx context.Context, stateLoc string) template.FuncMap

MustFuncMap is similar to FuncMap, but panics if it cannot get and parse tfstate.

func MustFuncMapWithName(ctx context.Context, name string, stateLoc string) template.FuncMap

MustFuncMapWithName is similar to FuncMapWithName, but panics if it cannot get and parse tfstate.

type Object struct {
	Value interface{}
}

func (a Object) Bytes() []byte

func (a *Object) Query(query string) (*Object, error)

Query queries object by go-jq

func (a Object) String() string

type TFState struct {
	// contains filtered or unexported fields
}

TFState represents a tfstate

func Read(ctx context.Context, src io.Reader) (*TFState, error)

Read reads a tfstate from io.Reader

func ReadFile(ctx context.Context, file string) (*TFState, error)

ReadFile reads terraform.tfstate from the file (a workspace reads from environment file in the same directory)

func ReadURL(ctx context.Context, loc string) (*TFState, error)

ReadURL reads terraform.tfstate from the URL.

func ReadWithWorkspace(ctx context.Context, src io.Reader, ws string) (*TFState, error)

ReadWithWorkspace reads a tfstate from io.Reader with workspace

func (s *TFState) List() ([]string, error)

List lists resource and output names in tfstate

func (s *TFState) Lookup(key string) (*Object, error)

Lookup lookups attributes of the specified key in tfstate