!FindInMapを!Subの中で使う

AWS CloudFormationで!FindInMapを!Sub内で使うやり方をまとめます。

はじめに
!FindInMapを!Subの中で使う
おわりに
参考

はじめに

こんにちは、@bioerrorlogです。

CloudFormationの!Subは値を代入/置換 ("substitute")できる関数、!FindInMapはMappingsから値を取得できる関数です。
(!SubはFn::Subの短縮記法、!FindInMapはFn::FindInMapの短縮記法)

典型的な使い方は、ざっくりこんな感じでしょうか：

# !Sub の使用例：
ExampleArn: !Sub 'arn:aws:ec2:${AWS::Region}:${AWS::AccountId}:instance/instance-id'
# -> ${AWS::Region}と${AWS::AccountId}が文字列に代入される

# !FindInMapの使用例：
Mappings: 
  RegionMap: 
    us-east-1: 
      "HVM64": "ami-0ff8a91507f77f867"
    us-west-1: 
      "HVM64": "ami-0bdb828fd58c52235"
Resources: 
  myEC2Instance: 
    Type: "AWS::EC2::Instance"
    Properties: 
      ImageId: !FindInMap [ RegionMap, !Ref 'AWS::Region', HVM64 ]
# -> Mappingsから該当の値が取得される

ここでこの二つの関数を組み合わせて、!FindInMapで取得した値を!Subで文字列に代入したくなるときがあります。

今回はそのやり方、!FindInMapを!Subの中で使う方法をメモします。

下記のようにして、!FindInMapで取得した値を!Subで代入できます。

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 ]
# ${log_group_name} が!FindInMap結果で置換される

!Subは単純に文字列内の${...}を置換する以外にも、リストの第一要素内の${...}を第二要素で置換する使い方ができます。

これを利用して、!Subのリスト第二要素に!FindInMapを定義すれば、これらを併用することができます。

該当部抜粋：

LogGroupName: !Sub 
  - 'cloud_watch_${log_group_name}'
  - log_group_name: !FindInMap [ LogGroupMapping, Test, Name ]
# ${log_group_name} が!FindInMap結果で置換される