template

Documentation

Overview

Package template provides types and functions that enable programmatic generation of CloudFormation templates

Index

• func FnBase64(valueToEncode interface{}) interface{}
• func FnFindInMap(mapName string, topLevelKey interface{}, secondLevelKey interface{}) interface{}
• func FnGetAZs(region interface{}) interface{}
• func FnGetAtt(logicalNameOfResource string, attributeName interface{}) interface{}
• func FnJoin(delimeter interface{}, listOfValues ...interface{}) interface{}
• func FnSelect(index interface{}, listOfObjects interface{}) interface{}
• func Ref(logicalName string) interface{}
• type Condition
• type Mapping
• type Output
• type Parameter
• type Resource
• type Template
  • func (t *Template) String() string

Functions

func FnBase64

func FnBase64(valueToEncode interface{}) interface{}

FnBase64 marshals to the CloudFormation intrinsic function Fn::Base64

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-base64.html

func FnFindInMap

func FnFindInMap(mapName string, topLevelKey interface{}, secondLevelKey interface{}) interface{}

FnFindInMap marshals to the CloudFormation intrinsic function Fn::FindInMap

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-findinmap.html

func FnGetAZs

func FnGetAZs(region interface{}) interface{}

FnGetAZs marshals to the CloudFormation intrinsic function Fn::GetAZs

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getavailabilityzones.html

func FnGetAtt

func FnGetAtt(logicalNameOfResource string, attributeName interface{}) interface{}

FnGetAtt marshals to the CloudFormation intrinsic function Fn::GetAtt

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html

func FnJoin

func FnJoin(delimeter interface{}, listOfValues ...interface{}) interface{}

FnJoin marshals to the CloudFormation intrinsic function Fn::Join

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-join.html

func FnSelect

func FnSelect(index interface{}, listOfObjects interface{}) interface{}

FnSelect marshals to the CloudFormation intrinsic function Fn::Select

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-select.html

func Ref

func Ref(logicalName string) interface{}

Ref marshals to the CloudFormation intrinsic function Ref

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html

Types

type Condition

type Condition map[string]interface{}

Condition defines a CloudFormation template condition

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/conditions-section-structure.html

type Mapping

type Mapping map[string]map[string]string

Mapping defines a CloudFormation template mapping

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/mappings-section-structure.html

type Output

type Output struct {
	Description string `json:",omitempty"`
	Value       interface{}
}

Output defines a CloudFormation template output

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/outputs-section-structure.html

type Parameter

type Parameter struct {
	Type                  string
	Default               string   `json:",omitempty"`
	NoEcho                bool     `json:",omitempty,string"`
	AllowedValues         []string `json:",omitempty"`
	AllowedPattern        string   `json:",omitempty"`
	MaxLength             int      `json:",omitempty,string"`
	MinLength             int      `json:",omitempty,string"`
	Description           string   `json:",omitempty"`
	ConstraintDescription string   `json:",omitempty"`
}

Parameter defines a CloudFormation template parameter

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html

type Resource

type Resource struct {
	Type       string
	Properties map[string]interface{} `json:",omitempty"`
	Metadata   map[string]interface{} `json:",omitempty"`

	DependsOn      interface{} `json:",omitempty"`
	CreationPolicy interface{} `json:",omitempty"`
	UpdatePolicy   interface{} `json:",omitempty"`
	DeletionPolicy interface{} `json:",omitempty"`
}

Resource defines a CloudFormation template resource

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resources-section-structure.html

type Template

type Template struct {
	AWSTemplateFormatVersion string                 `json:",omitempty"`
	Description              string                 `json:",omitempty"`
	Metadata                 map[string]interface{} `json:",omitempty"`
	Parameters               map[string]Parameter   `json:",omitempty"`
	Mappings                 map[string]Mapping     `json:",omitempty"`
	Conditions               map[string]Condition   `json:",omitempty"`
	Resources                map[string]Resource    `json:",omitempty"`
	Outputs                  map[string]Output      `json:",omitempty"`
}

Template defines a CloudFormation template.

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html

func (*Template) String

func (t *Template) String() string

String returns a JSON representation of the Template suitable for use in CloudFormation requests such as CreateStack and UpdateStack