阿里云资源编排Fn::Sub函数_资源编排(ROS)-阿里云帮助中心

调用内部函数Fn::Sub，将字符串中的变量（key）的值替换为您指定的值。

函数声明

JSON

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

YAML

完整函数名的语法。

Fn::Sub:
  - String
  - Var1Name: Var1Value
    Var2Name: Var2Value
    ...

缩写形式语法。

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

参数信息

String：一个能进行变量替换的字符串。
如果您以${VarName}的形式编写变量，变量可以为模板参数、伪参数、资源名称、资源属性或键值对映射中的变量名称等。如果您仅指定模板参数、伪参数、资源名称和资源属性，则不需要指定键值对映射，请参见特殊示例。
当您指定模板参数、伪参数或资源名称时（例如${MyParameter}），ROS返回的值与您使用Ref内部函数返回的值相同。当您指定资源属性（例如${MyInstance.InstanceId}），ROS返回的值与使用Fn::GetAtt内部函数返回的值相同。
说明
如果您想要保留变量不被替换，请在左大括号后添加英文感叹号（!）。例如${!Literal}，ROS会将该文本解析为${Literal}。
VarName：字符串中包含的变量名称。
VarValue：字符串中对应变量名称待替换的新值。

返回值

返回替换变量后的字符串。

特殊示例

如果您只需要引用模板参数、伪参数（Pseudo parameters）、资源名称以及资源属性，则不需要指定变量字典，您可以结合${}一起使用。

返回引用参数的对应值。

YAML

Fn::Sub: ${String}

JSON

{"Fn::Sub": "${String}"}

返回引用的字符串。
YAML
```
Fn::Sub: String
```
JSON
```
{"Fn::Sub": "String"}
```

示例：

YAML

ROSTemplateFormatVersion: '2015-09-01'
Outputs:
  StackId1:
    Value:
      Fn::Sub: ${ALIYUN::StackId}
  StackId2:
    Value:
      Fn::Sub: ALIYUN::StackId

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Outputs": {
    "StackId1": {
      "Value": {
        "Fn::Sub": "${ALIYUN::StackId}"
      }
    },
    "StackId2": {
      "Value": {
        "Fn::Sub": "ALIYUN::StackId"
      }
    }
  }
}

返回值：

StackId1：0f848ecd-c6fb-47aa-add5-910799c2****
StackId2：ALIYUN::StackId

完整使用示例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  VpcName:
    Type: String
    Default: vpc
Resources:
  Vpc:
    Type: ALIYUN::ECS::VPC
    Properties:
      VpcName:
        Ref: VpcName
      CidrBlock: 10.0.XX.XX
Outputs:
  Pseudo:
    Value:
      !Sub  
        - 'Var1: ${Var1}, Var2: ${Var2}, StackName: ${ALIYUN::StackName}, Region: ${ALIYUN::Region}'
        - Var1: Var1Value
          Var2: Var2Value       
  VpcId:
    Value:
      !Sub '资源的返回值：${Vpc.VpcId}, 资源ID: ${Vpc}'

JSON

{
 "ROSTemplateFormatVersion": "2015-09-01",
 "Parameters": {
 "VpcName": {
 "Type": "String",
 "Default": "vpc"
 }
 },
 "Resources": {
 "Vpc": {
 "Type": "ALIYUN::ECS::VPC",
 "Properties": {
 "VpcName": {
 "Ref": "VpcName"
 },
 "CidrBlock": "10.0.XX.XX"
 }
 }
 },
 "Outputs": {
 "Pseudo": {
 "Value": {
 "Fn::Sub": [
 "Var1: ${Var1}, Var2: ${Var2}, StackName: ${ALIYUN::StackName}, Region: ${ALIYUN::Region}",
 {
 "Var1": "Var1Value",
 "Var2": "Var2Value"
 }
 ]
 }
 },
 "VpcId": {
 "Value": {
 "Fn::Sub": "资源的返回值：${Vpc.VpcId}, 资源ID: ${Vpc}"
 }
 }
 }
}

返回值：

Var1: Var1Value, Var2: Var2Value, StackName: SubTest, Region: cn-hangzhou
资源的返回值：vpc-bp11eu7avmtvr37hl****, 资源ID: vpc-bp11eu7avmtvr37hl****

支持的函数

Fn::Indent