dc

Documentation

Overview

The dc package contains types and functions to facilitate parsing user-supplied configuration like tags and parameters, which are used for the deploy and forecast commands

Index

• Constants
• Variables
• func ConfigFromStack(stack types.Stack) (string, error)
• func GetParameters(template cft.Template, combinedParameters map[string]string, ...) []types.Parameter
• func GetStackName(stackName string, base string) string
• func ListToMap(name string, in []string) map[string]string
• func MakeTags(tags map[string]string) []types.Tag
• type DeployConfig
  • func GetDeployConfig(tags []string, params []string, configFilePath string, base string, ...) (*DeployConfig, error)
  • func (dc DeployConfig) GetParam(name string) (string, bool)

Constants

const MaxStackNameLength = 128

Variables

var FixStackNameRe *regexp.Regexp

Functions

func ConfigFromStack

func ConfigFromStack(stack types.Stack) (string, error)

ConfigFromStack returns a yaml string containing the tags and parameters of the given stack

func GetParameters

func GetParameters(
	template cft.Template,
	combinedParameters map[string]string,
	old []types.Parameter,
	stackExists bool,
	yes bool,
	ignoreUnknownParams bool) []types.Parameter

GetParameters checks the combined params supplied as args and in a file and asks the user to supply any values that are missing

func GetStackName

func GetStackName(stackName string, base string) string

GetStackName returns stackName if it is not blank, otherwise it creates a name based on the template file name

func ListToMap

func ListToMap(name string, in []string) map[string]string

ListToMap converts a pflag parsed StringSlice into a map where values are expected to be presented in the form Foo=bar,Baz=quux,mooz,Xyzzy=garply

func MakeTags

func MakeTags(tags map[string]string) []types.Tag

converts map of strings to a slice of types.Tag

Types

type DeployConfig

type DeployConfig struct {
	Params []types.Parameter
	Tags   map[string]string
}

DeployConfig represents the user-supplied configuration for a deployment This is also used by the forecast command

func GetDeployConfig

func GetDeployConfig(
	tags []string,
	params []string,
	configFilePath string,
	base string,
	template cft.Template,
	stack types.Stack,
	stackExists bool,
	yes bool,
	ignoreUnknownParams bool) (*DeployConfig, error)

GetDeployConfig populates an instance of DeployConfig based on user-supplied values

func (DeployConfig) GetParam

func (dc DeployConfig) GetParam(name string) (string, bool)

GetParam gets the value of a supplied parameter