deployer

Documentation

Index

• type DeleteOpts
• type DeleteResult
• type DeployOptFunc
  • func WithConfirm(confirm bool) DeployOptFunc
• type DeployOpts
• type DeployResult
• type Deployer
  • func New(ctx context.Context) (*Deployer, error)
  • func NewFromConfig(cfg aws.Config) *Deployer
  • func (b *Deployer) Delete(ctx context.Context, opts DeleteOpts) (*DeleteResult, error)
  • func (b *Deployer) Deploy(ctx context.Context, opts DeployOpts) (*DeployResult, error)

Types

type DeleteOpts

type DeleteOpts struct {
	// StackName to delete
	StackName string
	// RoleARN is an optional deployment role to use
	RoleARN string
}

type DeleteResult

type DeleteResult struct {
	FinalStatus       string
	DeleteStackOutput *cloudformation.DeleteStackOutput
}

type DeployOptFunc

type DeployOptFunc func(*DeployOpts)

func WithConfirm

func WithConfirm(confirm bool) DeployOptFunc

WithConfirm adjusts the Confirm variable in the deployment options.

type DeployOpts

type DeployOpts struct {
	// Template to deploy. Can be either
	// a URL or an inline JSON/YAML string.
	Template string
	// Params are CloudFormation parameters
	Params []types.Parameter
	// Tags to associate with the stack
	Tags map[string]string
	// StackName is the name of the deployed stack
	StackName string
	// RoleARN is an optional deployment role to use
	RoleARN string
	// Confirm will skip interactive confirmations
	// if set to tru
	Confirm bool
}

type DeployResult

type DeployResult struct {
	FinalStatus string
}

type Deployer

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

Deployer contains methods to interactively manage CloudFormations via a CLI.

func New

func New(ctx context.Context) (*Deployer, error)

New creates a new

func NewFromConfig

func NewFromConfig(cfg aws.Config) *Deployer

NewFromConfig creates a Deployer from an existing AWS config.

func (*Deployer) Delete

func (b *Deployer) Delete(ctx context.Context, opts DeleteOpts) (*DeleteResult, error)

Delete a CloudFormation stack and returns the final status

func (*Deployer) Deploy

func (b *Deployer) Deploy(ctx context.Context, opts DeployOpts) (*DeployResult, error)

Deploy deploys a stack and returns the final status template can be either a URL or a template body