io.staticweb.cloudformation-templating — io.staticweb/cloudformation-templating 2.2.0

account-id clj

arn clj

(arn ref)

base64 clj

(base64 x)

The intrinsic function Fn::Base64 returns the Base64 representation of the input string. This function is typically used to pass encoded data to Amazon EC2 instances by way of the UserData property.

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

cidr clj

(cidr ip-block count cidr-bits)

The intrinsic function Fn::Cidr returns an array of CIDR address blocks. The number of CIDR blocks returned is dependent on the count parameter.

See https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-cidr.html

cloudfront-hosted-zone-id clj

This is always the hosted zone ID when you create an alias record (in Route 53) that routes traffic to a CloudFront distribution.

See https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html

deftemplate clj macro

(deftemplate name-sym & body)

equals clj

(equals x y)

Compares if two values are equal. Returns true if the two values are equal or false if they aren't.

See https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-conditions.html#intrinsic-function-reference-conditions-equals

find-in-map clj

(find-in-map map-name top-level-key second-level-key)

(find-in-map map-name top-level-key second-level-key default-value)

The intrinsic function Fn::FindInMap returns the value corresponding to keys in a two-level map that's declared in the Mappings section.

The 4-arity version with default-value requires the AWS::LanguageExtensions transform.

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

fn-and clj

(fn-and & conds)

Returns true if all the specified conditions evaluate to true, or returns false if any one of the conditions evaluates to false. Fn::And acts as an AND operator. The minimum number of conditions that you can include is 2, and the maximum is 10.

See https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-conditions.html#intrinsic-function-reference-conditions-and

fn-if clj

(fn-if cond then else)

Returns one value if the specified condition evaluates to true and another value if the specified condition evaluates to false. Currently, CloudFormation supports the Fn::If intrinsic function in the metadata attribute, update policy attribute, and property values in the Resources section and Outputs sections of a template. You can use the no-value pseudo parameter as a return value to remove the corresponding property.

See https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-conditions.html#intrinsic-function-reference-conditions-and

fn-not clj

(fn-not cond)

Returns true for a condition that evaluates to false or returns false for a condition that evaluates to true. Fn::Not acts as a NOT operator.

See https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-conditions.html#intrinsic-function-reference-conditions-not

fn-or clj

(fn-or & conds)

Returns true if any one of the specified conditions evaluate to true, or returns false if all the conditions evaluates to false. Fn::Or acts as an OR operator. The minimum number of conditions that you can include is 2, and the maximum is 10.

See https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-conditions.html#intrinsic-function-reference-conditions-or

for-each clj

(for-each loop-name id coll output-key output-val)

The Fn::ForEach intrinsic function takes a collection and a fragment, and applies the items in the collection to the identifier in the provided fragment.

Requires the AWS::LanguageExtensions transform.

loop-name must be globally unique within the template.

See https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-foreach.html

Example:

(ct/for-each
  :Topics
  :TopicName
  (ct/ref :pRepoARNs)
  "SnsTopic${TopicName}"
  {"Type" "AWS::SNS::Topic"
      "Properties"
      {"TopicName"
      (ct/join "." [(ct/ref :TopicName) "fifo"])
      "FifoTopic" true}})

full-name clj

(full-name x)

get-att clj

(get-att ref attr)

The Fn::GetAtt intrinsic function returns the value of an attribute from a resource in the template. When the AWS::LanguageExtensions transform transform is used, you can use intrinsic functions as a parameter to Fn::GetAtt.

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

get-azs clj

(get-azs & [region])

The intrinsic function Fn::GetAZs returns an array that lists Availability Zones for a specified Region in alphabetical order.

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

import-value clj

(import-value name)

The intrinsic function Fn::ImportValue returns the value of an output exported by another stack. You typically use this function to create cross-stack references.

See https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-importvalue.html

invalid-keyword? clj

(invalid-keyword? x)

join clj

(join separator coll)

The intrinsic function Fn::Join appends a set of values into a single value, separated by the specified delimiter. If a delimiter is the empty string, the set of values are concatenated with no delimiter.

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

length clj

(length array)

The intrinsic function Fn::Length returns the number of elements within an array or an intrinsic function that returns an array.

Requires the AWS::LanguageExtensions transform.

See https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-length.html

make-maps-sorted clj

(make-maps-sorted x)

no-value clj

Removes the corresponding resource property when specified as a return value in the fn-if intrinsic function.

See https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/pseudo-parameter-reference.html

not-equals clj

(not-equals x y)

The composition of fn-not and equals.

outputs clj

(outputs m)

Converts an output map from the format {LogicalId [Name Value Description]} to AWS's output format. Description is optional.

prefixed-outputs clj

(prefixed-outputs prefix m)

Converts a map from the format {LogicalId [Value Description]} to AWS's output format. Output names are prefixed with the given prefix.

Example: (prefixed-outputs "${AWS::StackName}-" {:VpcId [(ref :Vpc)]}) ;= {:VpcId {:Export {:Name {"Fn::Sub" "${AWS::StackName}-VpcId"}} :Value {"Ref" "Vpc"}}}

ref clj

(ref name)

The intrinsic function Ref returns the value of the specified parameter or resource. When the AWS::LanguageExtensions transform is used, you can use intrinsic functions as a parameter to Ref.

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

region clj

Returns a string representing the Region in which the encompassing resource is being created, such as us-west-2.

See https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/pseudo-parameter-reference.html#cfn-pseudo-param-region

select clj

(select index objects)

The intrinsic function Fn::Select returns a single object from a list of objects by index.

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

split clj

(split separator s)

To split a string into a list of string values so that you can select an element from the resulting string list, use the Fn::Split intrinsic function. Specify the location of splits with a delimiter, such as , (a comma). After you split a string, use the Fn::Select function to pick a specific element.

See https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-split.html

stack-id clj

Returns the ID of the stack as specified with the aws cloudformation create-stack command.

See https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/pseudo-parameter-reference.html#cfn-pseudo-param-stackid

stack-name clj

Returns the name of the stack as specified with the aws cloudformation create-stack command.

See https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/pseudo-parameter-reference.html#cfn-pseudo-param-stackname

sub clj

(sub s)

The intrinsic function Fn::Sub substitutes variables in an input string with values that you specify.

See https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-sub.html

tags clj

(tags & {:as m})

template clj

(template & body)

to-json-string clj

(to-json-string object-or-array)

The Fn::ToJsonString intrinsic function converts an object or array to its corresponding JSON string.

Requires the AWS::LanguageExtensions transform.

See https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ToJsonString.html

transform clj

(transform name parameters)

The intrinsic function Fn::Transform specifies a macro to perform custom processing on part of a stack template.

See https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-transform.html

unsorted-map? clj

(unsorted-map? x)

user-data clj

(user-data & data)