s3

Documentation

Index

• type Backend
  • func (b *Backend) Configure() error
  • func (b *Backend) GetBackendBytes(stackName, unitName string) ([]byte, error)
  • func (b *Backend) GetBackendHCL(stackName, unitName string) (*hclwrite.File, error)
  • func (b *Backend) GetRemoteStateHCL(stackName, unitName string) ([]byte, error)
  • func (b *Backend) LockState() error
  • func (b *Backend) Name() string
  • func (b *Backend) Provider() string
  • func (b *Backend) ReadState() (string, error)
  • func (b *Backend) State() map[string]interface{}
  • func (b *Backend) UnlockState() error
  • func (b *Backend) WriteState(stateData string) error
• type Factory
  • func (f *Factory) New(config []byte, name string, p *project.Project) (project.Backend, error)

Types

type Backend

type Backend struct {
	Bucket                    string `yaml:"bucket"`
	Region                    string `yaml:"region"`
	AccessKey                 string `yaml:"access_key,omitempty"`
	SecretKey                 string `yaml:"secret_key,omitempty"`
	Profile                   string `yaml:"profile,omitempty"`
	Token                     string `yaml:"token,omitempty"`
	Endpoint                  string `yaml:"endpoint,omitempty"`
	SkipMetadataApiCheck      bool   `yaml:"skip_metadata_api_check,omitempty"`
	SkipCredentialsValidation bool   `yaml:"skip_credentials_validation,omitempty"`
	MaxRetries                int    `yaml:"max_retries,omitempty"`
	SharedCredentialsFile     string `yaml:"shared_credentials_file,omitempty"`
	SkipRegionValidation      string `yaml:"skip_region_validation,omitempty"`
	StsEndpoint               string `yaml:"sts_endpoint,omitempty"`
	IamEndpoint               string `yaml:"iam_endpoint,omitempty"`
	ForcePathStyle            bool   `yaml:"force_path_style,omitempty"`
	// Assume role
	AssumeRoleDurationSeconds   string            `yaml:"assume_role_duration_seconds,omitempty"`
	AssumeRolePolicy            string            `yaml:"assume_role_policy,omitempty"`
	AssumeRolePolicyArns        []string          `yaml:"assume_role_policy_arns,omitempty"`
	AssumeRoleTags              map[string]string `yaml:"assume_role_tags,omitempty"`
	AssumeRoleTransitiveTagKeys string            `yaml:"assume_role_transitive_tag_keys,omitempty"`
	ExternalId                  string            `yaml:"external_id,omitempty"`
	RoleArn                     string            `yaml:"role_arn,omitempty"`
	SessionName                 string            `yaml:"session_name,omitempty"`

	Workspaces string `yaml:"workspaces,omitempty"`

	ProjectPtr *project.Project `yaml:"-"`
	// contains filtered or unexported fields
}

Backend - describe s3 backend for interface package.backend.

func (*Backend) Configure

func (b *Backend) Configure() error

func (*Backend) GetBackendBytes

func (b *Backend) GetBackendBytes(stackName, unitName string) ([]byte, error)

GetBackendBytes generate terraform backend config.

func (*Backend) GetBackendHCL

func (b *Backend) GetBackendHCL(stackName, unitName string) (*hclwrite.File, error)

GetBackendHCL generate terraform backend config.

func (*Backend) GetRemoteStateHCL

func (b *Backend) GetRemoteStateHCL(stackName, unitName string) ([]byte, error)

GetRemoteStateHCL generate terraform remote state for this backend.

func (*Backend) LockState

func (b *Backend) LockState() error

func (*Backend) Name

func (b *Backend) Name() string

Name return name.

func (*Backend) Provider

func (b *Backend) Provider() string

Provider return name.

func (*Backend) ReadState

func (b *Backend) ReadState() (string, error)

func (*Backend) State

func (b *Backend) State() map[string]interface{}

func (*Backend) UnlockState

func (b *Backend) UnlockState() error

func (*Backend) WriteState

func (b *Backend) WriteState(stateData string) error

type Factory

type Factory struct{}

Factory factory for s3 backends.

func (*Factory) New

func (f *Factory) New(config []byte, name string, p *project.Project) (project.Backend, error)

New creates the new s3 backend.