addons

Documentation

Overview

Package addons contains the service to manage addons.

Index

• Constants
• type Addons
  • func New(appName string) (*Addons, error)
  • func (a *Addons) Template() (string, error)
• type ErrDirNotExist
  • func (e *ErrDirNotExist) Error() string
• type Output
  • func Outputs(template string) ([]Output, error)

Constants

const (
	// StackName is the name of the addons nested stack resource.
	StackName = "AddonsStack"
)

Types

type Addons

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

Addons represents additional resources for an application.

func New

func New(appName string) (*Addons, error)

New creates an Addons object given an application name.

func (*Addons) Template

func (a *Addons) Template() (string, error)

Template merges the files under the "addons/" directory of an application into a single CloudFormation template and returns it.

type ErrDirNotExist

type ErrDirNotExist struct {
	AppName   string
	ParentErr error
}

ErrDirNotExist occurs when an addons directory for an application does not exist.

func (*ErrDirNotExist) Error

func (e *ErrDirNotExist) Error() string

type Output

type Output struct {
	// Name is the Logical ID of the output.
	Name string
	// IsSecret is true if the output value refers to a SecretsManager ARN. Otherwise, false.
	IsSecret bool
	// IsManagedPolicy is true if the output value refers to an IAM ManagedPolicy ARN. Otherwise, false.
	IsManagedPolicy bool
}

Output represents an output from a CloudFormation template.

func Outputs

func Outputs(template string) ([]Output, error)

Outputs parses the Outputs section of a CloudFormation template to extract logical IDs and returns them.