AWS Documentation » AWS CloudFormation » User Guide » Template Reference » Intrinsic Function Reference » Fn::Sub

Filter View: All JSON YAML

Fn::Sub

The intrinsic function Fn::Sub 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.

Declaration

The following sections show the function's syntax.

JSON

Copy
{ "Fn::Sub" : [ String, { Var1Name: Var1Value, Var2Name: Var2Value } ] }

If you're substituting only template parameters, resource logical IDs, or resource attributes in the String parameter, don't specify a variable map.

Copy
{ "Fn::Sub" : String }

YAML

Syntax for the full function name:

Copy
Fn::Sub:
  - String
  - { Var1Name: Var1Value, Var2Name: Var2Value }

Syntax for the short form:

Copy
!Sub
  - String
  - { Var1Name: Var1Value, Var2Name: Var2Value }

If you're substituting only template parameters, resource logical IDs, or resource attributes in the String parameter, don't specify a variable map.

Syntax for the full function name:

Copy
Fn::Sub: String

Syntax for the short form:

Copy
!Sub String

Parameters

String

A string with variables that AWS CloudFormation substitutes with their associated values at runtime. Write variables as ${MyVarName}. Variables can be template parameter names, resource logical IDs, resource attributes, or a variable in a key-value map. If you specify only template parameter names, resource logical IDs, and resource attributes, don't specify a key-value map.

If you specify template parameter names or resource logical IDs, such as ${InstanceTypeParameter}, AWS CloudFormation returns the same values as if you used the Ref intrinsic function. If you specify resource attributes, such as ${MyInstance.PublicIp}, AWS CloudFormation returns the same values as if you used the Fn::GetAtt intrinsic function.

To write a dollar sign and curly braces (${}) literally, add an exclamation point (!) after the open curly brace, such as ${!Literal}. AWS CloudFormation resolves this text as ${Literal}.

VarName

The name of a variable that you included in the String parameter.

VarValue

The value that AWS CloudFormation substitutes for the associated variable name at runtime.

Return Value

AWS CloudFormation returns the original string, substituting the values for all of the variables.

Examples

The following examples demonstrate how to use the Fn::Sub function.

UserData Commands

The following example uses Fn::Sub to substitute the AWS CloudFormation stack name and the AWS region pseudo parameters for the actual stack name and region at runtime.

JSON

For readability, the JSON example uses the Fn::Join function to separate each command, instead of specifying the entire user data script in a single string value.

Copy
"UserData": { "Fn::Base64": { "Fn::Join": ["\n", [
  "#!/bin/bash -xe",
  "yum update -y aws-cfn-bootstrap",
  { "Fn::Sub": "/opt/aws/bin/cfn-init -v --stack ${AWS::StackName} --resource LaunchConfig --configsets wordpress_install --region ${AWS::Region}" },
  { "Fn::Sub": "/opt/aws/bin/cfn-signal -e $? --stack ${AWS::StackName} --stack ${AWS::StackName} --resource WebServer --region ${AWS::Region}" }]]
}}

YAML

The YAML example uses a literal block to specify the user data script.

Copy
UserData:
  Fn::Base64:
    !Sub |
      #!/bin/bash -xe
      yum update -y aws-cfn-bootstrap
      /opt/aws/bin/cfn-init -v --stack ${AWS::StackName} --resource LaunchConfig --configsets wordpress_install --region ${AWS::Region}
      /opt/aws/bin/cfn-signal -e $? --stack ${AWS::StackName} --resource WebServerGroup --region ${AWS::Region}

Fn::Sub with a Mapping

The following example uses a mapping to substitute the ${Domain} variable with the resulting value from the Ref function.

JSON

Copy
{ "Fn::Sub": [ "www.${Domain}", { "Domain": {"Ref" : "RootDomainName" }} ]}

YAML

Copy
Name: !Sub
  - www.${Domain}
  - { Domain: !Ref RootDomainName }

Supported Functions

You can use the following functions in the Fn::Sub function:

• Fn::Base64

• Fn::FindInMap

• Fn::GetAtt

• Fn::GetAZs

• Fn::If

• Fn::Join

• Fn::Select

• Ref