metadata

Documentation

Index

• Variables
• func GetLogger() aws.Logger
• type AWSClients
• type Context
  • func NewPlugin(options Options, stop <-chan struct{}) (*Context, error)
  • func (c *Context) Funcs() []template.Function
  • func (c *Context) Get(path types.Path) (value *types.Any, err error)
  • func (c *Context) List(path types.Path) (child []string, err error)
• type Options
  • func (options *Options) Flags() *pflag.FlagSet

Variables

var (
	// ErrNotSupported is when an object cannot be 'described' via AWS api either through lack of mapping or bad input
	ErrNotSupported = fmt.Errorf("not-supported")
)

Functions

func GetLogger

func GetLogger() aws.Logger

GetLogger gets a logger that can be used with the AWS SDK.

Types

type AWSClients

type AWSClients struct {
	Cfn cloudformationiface.CloudFormationAPI
	Ec2 ec2iface.EC2API
	Asg autoscalingiface.AutoScalingAPI
}

AWSClients holds a set of AWS API clients

type Context

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

Context is the template context for the template which when evaluated, exports metadata.

func NewPlugin

func NewPlugin(options Options, stop <-chan struct{}) (*Context, error)

NewPlugin creates an instance of the plugin

func (*Context) Funcs

func (c *Context) Funcs() []template.Function

Funcs return the additional functions that are available for AWS.

func (*Context) Get

func (c *Context) Get(path types.Path) (value *types.Any, err error)

Get retrieves the value at path given.

func (*Context) List

func (c *Context) List(path types.Path) (child []string, err error)

List returns a list of *child nodes* given a path, which is specified as a slice where for i > j path[i] is the parent of path[j]

type Options

type Options struct {
	instance.Options `json:",inline" yaml:",inline"`

	Debug           bool
	Template        string
	TemplateOptions template.Options
	StackName       string
	PollInterval    types.Duration
}

Options containe properties important for the AWS api

func (*Options) Flags

func (options *Options) Flags() *pflag.FlagSet

Flags returns the flags required.