backend

Documentation

Index

• Constants
• func IsRemote(backend *configs.Backend) bool
• func String(v string) *string
• type RemoteBackend
  • func DecodeConfig(backend *configs.Backend) (*RemoteBackend, error)
• type Workspaces
  • func (w *Workspaces) Multiple() bool

Constants

const DefaultHostname = "app.terraform.io"

DefaultHostname is the hostname for the public version of Terraform Cloud

Functions

func IsRemote

func IsRemote(backend *configs.Backend) bool

IsRemote returns whether the backend is defined and is of type "remote"

func String

func String(v string) *string

String returns a string pointer for a string value

Types

type RemoteBackend

type RemoteBackend struct {
	Hostname     *string `hcl:"hostname,attr"`
	Organization *string `hcl:"organization,attr"`

	Workspaces Workspaces `hcl:"workspaces,block"`
}

RemoteBackend is a Terraform remote backend configuration

func DecodeConfig

func DecodeConfig(backend *configs.Backend) (*RemoteBackend, error)

DecodeConfig decodes a backend config into a RemoteBackend object

type Workspaces

type Workspaces struct {
	Name   *string `hcl:"name,attr"`
	Prefix *string `hcl:"prefix,attr"`
}

Workspaces is a Terraform remote backend workspaces configuration

func (*Workspaces) Multiple

func (w *Workspaces) Multiple() bool

Multiple returns whether multiple workspaces are defined with a prefix