s3

Documentation

Index

• func New() backend.Backend
• type Backend
  • func (b *Backend) ConfigSchema() *configschema.Block
  • func (b *Backend) Configure(obj cty.Value) tfdiags.Diagnostics
  • func (b *Backend) DeleteWorkspace(name string, _ bool) error
  • func (b *Backend) PrepareConfig(obj cty.Value) (cty.Value, tfdiags.Diagnostics)
  • func (b *Backend) StateMgr(name string) (statemgr.Full, error)
  • func (b *Backend) Workspaces() ([]string, error)
• type RemoteClient
  • func (c *RemoteClient) Delete() error
  • func (c *RemoteClient) Get() (payload *remote.Payload, err error)
  • func (c *RemoteClient) Lock(info *statemgr.LockInfo) (string, error)
  • func (c *RemoteClient) Put(data []byte) error
  • func (c *RemoteClient) Unlock(id string) error

Functions

func New

func New() backend.Backend

Types

type Backend

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

func (*Backend) ConfigSchema

func (b *Backend) ConfigSchema() *configschema.Block

ConfigSchema returns a description of the expected configuration structure for the receiving backend.

func (*Backend) Configure

func (b *Backend) Configure(obj cty.Value) tfdiags.Diagnostics

Configure uses the provided configuration to set configuration fields within the backend.

The given configuration is assumed to have already been validated against the schema returned by ConfigSchema and passed validation via PrepareConfig.

func (*Backend) DeleteWorkspace

func (b *Backend) DeleteWorkspace(name string, _ bool) error

func (*Backend) PrepareConfig

func (b *Backend) PrepareConfig(obj cty.Value) (cty.Value, tfdiags.Diagnostics)

PrepareConfig checks the validity of the values in the given configuration, and inserts any missing defaults, assuming that its structure has already been validated per the schema returned by ConfigSchema.

func (*Backend) StateMgr

func (b *Backend) StateMgr(name string) (statemgr.Full, error)

func (*Backend) Workspaces

func (b *Backend) Workspaces() ([]string, error)

type RemoteClient

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

func (*RemoteClient) Delete

func (c *RemoteClient) Delete() error

func (*RemoteClient) Get

func (c *RemoteClient) Get() (payload *remote.Payload, err error)

func (*RemoteClient) Lock

func (c *RemoteClient) Lock(info *statemgr.LockInfo) (string, error)

func (*RemoteClient) Put

func (c *RemoteClient) Put(data []byte) error

func (*RemoteClient) Unlock

func (c *RemoteClient) Unlock(id string) error