cloudformation

Documentation

Index

• func GetStackName(manifestFile *manifest.Manifest, fileName, environment, stackNameFlag string) string
• func ResolveParameters(environment string, cliParams map[string]string, cfYaml YamlCloudformation, ...) []*awsCF.Parameter
• func ResolveParametersS3(c *cli.Context, manifestFile *manifest.Manifest) []*awsCF.Parameter
• type GenerateParams
• type Parameter
• type YamlCloudformation
  • func GenerateYamlTemplate(params GenerateParams) (compiledTemplate YamlCloudformation, err error)
• type YamlConfig

Functions

func GetStackName

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

GetStackName cleaned to fix AWS requirements

func ResolveParameters

func ResolveParameters(
	environment string,
	cliParams map[string]string,
	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 {
	ObjectStore            core.ObjectStore
	Filename               string
	Directory              string
	WriteParams            bool
	EnvFile                string
	Env                    string
	GenerateDefaultOutputs bool
	ParamMap               map[string]string
	Plugins                []*plugins.PluginLoaded
}

GenerateParams are required to generate a cloudformation yaml template

type Parameter

type Parameter struct {
	ParameterKey     string
	ParameterValue   string
	ResolvedValue    string `json:"ResolvedValue,omitempty"`
	UsePreviousValue bool   `json:"UsePreviousValue,omitempty"`
}

CloudFormation Parameter data type: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html

type YamlCloudformation

type YamlCloudformation struct {
	AWSTemplateFormatVersion string               `yaml:"AWSTemplateFormatVersion,omitempty"`
	Description              string               `yaml:"Description,omitempty"`
	Metadata                 types.TemplateObject `yaml:"Metadata,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 GenerateYamlTemplate

func GenerateYamlTemplate(params GenerateParams) (compiledTemplate YamlCloudformation, err error)

GenerateYamlTemplate - generate a cloudformation template

type YamlConfig

type YamlConfig struct {
	AWSTemplateFormatVersion string                      `yaml:"AWSTemplateFormatVersion,omitempty"`
	Description              string                      `yaml:"Description,omitempty"`
	Metadata                 types.TemplateObject        `yaml:"Metadata,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                map[string]types.CfResource `yaml:"Resources"`
	Outputs                  types.TemplateObject        `yaml:"Outputs,omitempty"`
}

YamlConfig -