intrinsics

Documentation

Index

• Variables
• func FnAnd(name string, input interface{}, template interface{}) interface{}
• func FnBase64(name string, input interface{}, template interface{}) interface{}
• func FnEquals(name string, input interface{}, template interface{}) interface{}
• func FnFindInMap(name string, input interface{}, template interface{}) interface{}
• func FnGetAZs(name string, input interface{}, template interface{}) interface{}
• func FnGetAtt(name string, input interface{}, template interface{}) interface{}
• func FnIf(name string, input interface{}, template interface{}) interface{}
• func FnJoin(name string, input interface{}, template interface{}) interface{}
• func FnNot(name string, input interface{}, template interface{}) interface{}
• func FnOr(name string, input interface{}, template interface{}) interface{}
• func FnSelect(name string, input interface{}, template interface{}) interface{}
• func FnSplit(name string, input interface{}, template interface{}) interface{}
• func FnSub(name string, input interface{}, template interface{}) interface{}
• func FnTransform(name string, input interface{}, template interface{}) interface{}
• func ProcessJSON(input []byte, options *ProcessorOptions) ([]byte, error)
• func ProcessYAML(input []byte, options *ProcessorOptions) ([]byte, error)
• func Ref(name string, input interface{}, template interface{}) interface{}
• func Sub(value string) string
• type IntrinsicHandler
• type ProcessorOptions

Variables

var AZs map[string][]interface{} = make(map[string][]interface{})

Functions

func FnAnd

func FnAnd(name string, input interface{}, template interface{}) interface{}

FnAnd resolves the 'Fn::And' AWS CloudFormation intrinsic function. See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-conditions.html#intrinsic-function-reference-conditions-and

func FnBase64

func FnBase64(name string, input interface{}, template interface{}) interface{}

FnBase64 resolves the 'Fn::Base64' AWS CloudFormation intrinsic function. See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-base64.htmlpackage intrinsics

func FnEquals

func FnEquals(name string, input interface{}, template interface{}) interface{}

FnEquals resolves the 'Fn::Equals' AWS CloudFormation intrinsic function. See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-conditions.html#intrinsic-function-reference-conditions-equals

func FnFindInMap

func FnFindInMap(name string, input interface{}, template interface{}) interface{}

FnFindInMap resolves the 'Fn::FindInMap' AWS CloudFormation intrinsic function. See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-findinmap.html

func FnGetAZs

func FnGetAZs(name string, input interface{}, template interface{}) interface{}

FnGetAZs resolves the 'Fn::GetAZs' AWS CloudFormation intrinsic function. See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getavailabilityzones.html

func FnGetAtt

func FnGetAtt(name string, input interface{}, template interface{}) interface{}

FnGetAtt is not implemented, and always returns nil. See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html

func FnIf

func FnIf(name string, input interface{}, template interface{}) interface{}

FnIf resolves the 'Fn::If' AWS CloudFormation intrinsic function. See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-conditions.html#intrinsic-function-reference-conditions-if

func FnJoin

func FnJoin(name string, input interface{}, template interface{}) interface{}

FnJoin resolves the 'Fn::Join' AWS CloudFormation intrinsic function. See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-join.html

func FnNot

func FnNot(name string, input interface{}, template interface{}) interface{}

FnNot resolves the 'Fn::Not' AWS CloudFormation intrinsic function. See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-conditions.html#intrinsic-function-reference-conditions-not

func FnOr

func FnOr(name string, input interface{}, template interface{}) interface{}

FnOr resolves the 'Fn::Or' AWS CloudFormation intrinsic function. See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-conditions.html#intrinsic-function-reference-conditions-or

func FnSelect

func FnSelect(name string, input interface{}, template interface{}) interface{}

FnSelect resolves the 'Fn::Select' AWS CloudFormation intrinsic function. See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-select.html

func FnSplit

func FnSplit(name string, input interface{}, template interface{}) interface{}

FnSplit resolves the 'Fn::Split' AWS CloudFormation intrinsic function. See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-split.html

func FnSub

func FnSub(name string, input interface{}, template interface{}) interface{}

ResolveFnSub resolves the 'Fn::Sub' AWS CloudFormation intrinsic function. See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-sub.html

func FnTransform

func FnTransform(name string, input interface{}, template interface{}) interface{}

func ProcessJSON

func ProcessJSON(input []byte, options *ProcessorOptions) ([]byte, error)

ProcessJSON recursively searches through a byte array of JSON data for all AWS CloudFormation intrinsic functions, resolves them, and then returns the resulting interface{} object.

func ProcessYAML

func ProcessYAML(input []byte, options *ProcessorOptions) ([]byte, error)

ProcessYAML recursively searches through a byte array of JSON data for all AWS CloudFormation intrinsic functions, resolves them, and then returns the resulting interface{} object.

func Ref

func Ref(name string, input interface{}, template interface{}) interface{}

Ref resolves the 'Ref' AWS CloudFormation intrinsic function. Currently, this only resolves against CloudFormation Parameter default values See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html

func Sub

func Sub(value string) string

NewSub substitutes variables in an input string with values that you specify. In your templates, you can use this function to construct commands or outputs that include values that aren't available until you create or update a stack.

Types

type IntrinsicHandler

type IntrinsicHandler func(string, interface{}, interface{}) interface{}

IntrinsicHandler is a function that applies an intrinsic function and returns the response that should be placed in it's place. An intrinsic handler function is passed the name of the intrinsic function (e.g. Fn::Join), and the object to apply it to (as an interface{}), and should return the resolved object (as an interface{}).

type ProcessorOptions

type ProcessorOptions struct {
	IntrinsicHandlerOverrides map[string]IntrinsicHandler
	ParameterOverrides        map[string]interface{}
	NoProcess                 bool
	EvaluateConditions        bool
}

ProcessorOptions allows customisation of the intrinsic function processor behaviour. This allows disabling the processing of intrinsics, overriding of the handlers for each intrinsic function type, and overriding template parameters.