Fn።FindInMap、Fn።ImportValue、またはその他のサポートされている関数を使用して AWS CloudFormation で Fn።Sub 関数を使用するにはどうすればよいですか?

簡単な説明

Fn::Sub 組み込み関数を使用して、サポートされている関数を置き換えたり、入力文字列内の変数を指定した値に置き換えたりできます。

サポートされている関数の値を置き換えるには、以下に示すように、変数マップを名前および値とともに使用する必要があります。

JSON:

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

YAML:

!Sub
  - String
  - Var1Name: Var1Value
    Var2Name: Var2Value

解決方法

Ref 関数での Fn::Sub の使用

次の例では、マッピングを使用して、Domain 変数を Ref 関数の結果の値に置き換えます。

JSON:

{
  "Parameters": {
    "RootDomainName": {
      "Type": "String",
      "Default": "example123.com"
    }
  },
  "Resources": {
    "DNS": {
      "Type": "AWS::Route53::HostedZone",
      "Properties": {
        "Name": {
          "Fn::Sub": [
            "www.${Domain}",
            {
              "Domain": {
                "Ref": "RootDomainName"
              }
            }
          ]
        }
      }
    }
  }
}

YAML:

Parameters:
  RootDomainName:
    Type: String
    Default: example123.com
Resources:
  DNS:
    Type: 'AWS::Route53::HostedZone'
    Properties:
      Name: !Sub 
        - 'www.${Domain}'
        - Domain: !Ref RootDomainName

Fn::FindInMap 関数での Fn::Sub の使用

次の例では、マッピングを使用して、log_group_name 変数を Fn::FindInMap 関数の結果の値に置き換えます。

JSON:

{
  "Mappings": {
    "LogGroupMapping": {
      "Test": {
        "Name": "test_log_group"
      },
      "Prod": {
        "Name": "prod_log_group"
      }
    }
  },
  "Resources": {
    "myLogGroup": {
      "Type": "AWS::Logs::LogGroup",
      "Properties": {
        "LogGroupName": {
          "Fn::Sub": [
            "cloud_watch_${log_group_name}",
            {
              "log_group_name": {
                "Fn::FindInMap": [
                  "LogGroupMapping",
                  "Test",
                  "Name"
                ]
              }
            }
          ]
        }
      }
    }
  }
}

YAML:

Mappings:
  LogGroupMapping:
    Test:
      Name: test_log_group
    Prod:
      Name: prod_log_group
Resources:
  myLogGroup:
    Type: 'AWS::Logs::LogGroup'
    Properties:
      LogGroupName: !Sub 
        - 'cloud_watch_${log_group_name}'
        - log_group_name: !FindInMap 
            - LogGroupMapping
            - Test
            - Name

Fn::ImportValue 関数での Fn::Sub の使用

次の例では、マッピングを使用して、Domain 変数を Fn::ImportValue 関数の結果の値に置き換えます。

注:「DomainName」は、別の CloudFormation スタックによってエクスポートされた出力の名前です。

JSON:

{
  "Resources": {
    "DNS": {
      "Type": "AWS::Route53::HostedZone",
      "Properties": {
        "Name": {
          "Fn::Sub": [
            "www.${Domain}",
            {
              "Domain": {
                "Fn::ImportValue": "DomainName"
              }
            }
          ]
        }
      }
    }
  }
}

YAML:

Resources:
  DNS:
    Type: 'AWS::Route53::HostedZone'
    Properties:
      Name: !Sub 
        - 'www.${Domain}'
        - Domain: !ImportValue DomainName

---