[Cloudformation]Fn::Subを使って文字列内に変数をいれる

こんにちは、ちゃりおです。

今回は、Cloudfomation書くときに便利なFn::Subについて書いてみます。

ちゃりお

組み込み関数 Subについてです！

Contents

Fn::Subとは

この組み込み関数 Fn::Sub は特定した値の入力文字列にある変数の代わりになります。テンプレートで、スタックを作成または更新するまで使用できない値を含むコマンドまたは出力を作成するために、この関数を使用できます。

Cloudformationの組み込み関数の一つで、テンプレート上で変数を表示したいときに使います。

Name: !Sub
  - web001.${Domain}
  - Domain:
      !Ref DomainName

DomainNameの値が、「exameple.com」だった場合
Nameにはweb001.example.comが入ります。

また、複数の値を設定することもできます。

Name: !Sub
  - ${Env}-web001.${Domain}
  - Env:
      !Ref Env
    Domain: 
      !Ref DomainName

Envに「stg」が入っていて、DomainNameに「example.com」入っていた場合
Nameはstg-web001.example.comとなります。

ImportValueやGetAttで値をとってくることもできます。
ネストさせることもできるので、柔軟に使えます。

ImportValueでとってくるパターンも割と使うと思うので載せておきます。

Name: !Sub
  - web001.${Domain}
  - Domain:
        Fn::ImportValue: !Sub '${Env}-HostedZone-Private-Name'

今回は、Fn::Subの使い方についてでした。
公式ドキュメントでまとまっているので割と書くことありませんでしたw
よく使われるパターンを書いてみたので、参考になればと思います。