【CloudFormation/SAM】デプロイ時の環境変数を参照する方法

記事タイトルとURLをコピーする

こんにちは、サービス開発部のくればやしです。

今回は、AWS SAM CLI（以下SAM CLI）で実行環境の環境変数をテンプレート内で展開する方法を解説します。

解説

例えば別のIaCツールである Serverless Framework の場合は以下のようにテンプレートファイルの中で指定するだけで参照が可能になります。

provider:
  environment:
    API_KEY: ${env:API_KEY}

SAM CLIの場合は、一度 Parameters として外部から入力される値として定義した上で、参照する必要があるため、例えば以下のように定義したうえで、

Parameters:
  ApiKey: # 英数字のみ(アンダースコア不可)
    Type: String
    NoEcho: true
Globals:
  Function:
    Environment:
      Variables:
        API_KEY: !Ref ApiKey

sam deploy コマンド時にパラメータとして渡す必要があります。

sam deploy --parameter-overrides ApiKey=$ApiKey

設定ファイル( samconfig.toml )内でもパラメータを定義することは可能ですが、この時は環境変数を参照することは出来ず、固定値しか設定できないため注意が必要です。例えば、samconfig.toml 内で、以下のように記述するとCloudFormationテンプレートには $ApiKey という文字列が展開されてしまいます。