cloudformation

Documentation

Index

• func GetParamMap(c *cli.Context) map[string]string
• func GetStackName(manifestFile *manifest.Manifest, fileName, environment, stackNameFlag string) string
• func PluginDocs() (docs map[string]string)
• func ResolveEnvironment(envFile string, env string) types.TemplateObject
• func ResolveParameters(c *cli.Context, cfYaml YamlCloudformation, manifestFile *manifest.Manifest) []*awsCF.Parameter
• func ResolveParametersS3(c *cli.Context, manifestFile *manifest.Manifest) []*awsCF.Parameter
• type GenerateParams
• type YamlCloudformation
  • func GenerateYamlStack(params GenerateParams) (out YamlCloudformation, err error)
• type YamlConfig

Functions

func GetParamMap

func GetParamMap(c *cli.Context) map[string]string

GetParamMap retrives the --param if any, for the map of Parameters in the template

func GetStackName

func GetStackName(manifestFile *manifest.Manifest, fileName, environment, stackNameFlag string) string

GetStackName cleaned to fix AWS requirements

func PluginDocs

func PluginDocs() (docs map[string]string)

PluginDocs -

func ResolveEnvironment

func ResolveEnvironment(envFile string, env string) types.TemplateObject

ResolveEnvironment loads the correct configs/environment.yaml ValueMap for the specified env

func ResolveParameters

func ResolveParameters(
	c *cli.Context,
	cfYaml YamlCloudformation,
	manifestFile *manifest.Manifest,
) []*awsCF.Parameter

ResolveParameters for the template

func ResolveParametersS3

func ResolveParametersS3(
	c *cli.Context,
	manifestFile *manifest.Manifest,
) []*awsCF.Parameter

ResolveParametersS3 for an S3 based template

Types

type GenerateParams

type GenerateParams struct {
	Filename               string
	EnvFile                string
	Env                    string
	GenerateDefaultOutputs bool
	ParamMap               map[string]string
	Plugins                []*plugins.PluginLoaded
}

GenerateParams are required to generate a cloudformation yaml template

type YamlCloudformation

type YamlCloudformation struct {
	AWSTemplateFormatVersion string               `yaml:"AWSTemplateFormatVersion,omitempty"`
	Description              string               `yaml:"Description,omitempty"`
	Parameters               types.TemplateObject `yaml:"Parameters,omitempty"`
	Mappings                 types.TemplateObject `yaml:"Mappings,omitempty"`
	Conditions               types.TemplateObject `yaml:"Conditions,omitempty"`
	Transform                types.TemplateObject `yaml:"Transform,omitempty"`
	Resources                types.TemplateObject `yaml:"Resources"`
	Outputs                  types.TemplateObject `yaml:"Outputs,omitempty"`
}

YamlCloudformation -

func GenerateYamlStack

func GenerateYamlStack(params GenerateParams) (out YamlCloudformation, err error)

GenerateYamlStack - generate a stack definition from ./configs

type YamlConfig

type YamlConfig struct {
	AWSTemplateFormatVersion string               `yaml:"AWSTemplateFormatVersion,omitempty"`
	Description              string               `yaml:"Description,omitempty"`
	Parameters               types.TemplateObject `yaml:"Parameters,omitempty"`
	Mappings                 types.TemplateObject `yaml:"Mappings,omitempty"`
	Conditions               types.TemplateObject `yaml:"Conditions,omitempty"`
	Transform                types.TemplateObject `yaml:"Transform,omitempty"`
	Resources                types.ResourceMap    `yaml:"Resources"`
	Outputs                  types.TemplateObject `yaml:"Outputs,omitempty"`
}

YamlConfig -