テーマ別の解説テーマ:IaCとCloudFormation:構成・差分・ドリフト
CloudFormationテンプレートの読み方:論理ID・Ref・依存関係を図解
CloudFormationテンプレートは、AWS資源の種類・設定・参照関係を宣言するファイルです。 書いた順に処理する手順書ではありません。短いYAMLを、論理ID → 資源の種類 → 設定値 → 参照先の順に読み、作成順とアプリの動作確認を分けましょう。
Resourcesの宣言を数え、論理IDと実資源の識別子を区別し、RefとDependsOnから依存関係を説明できる。
VPCはネットワークの構成範囲、セキュリティグループは関連付けた資源の通信を制御する仕組みです。AWSアカウントやYAMLの実行は不要です。字下げは階層を表します。
テンプレート・スタック・資源を分ける
テンプレートは宣言のファイル、スタックはCloudFormationがまとめて管理する単位、資源はVPC等の個々の対象です。 ファイルをGitへ保存しただけでは、AWSへ資源は作られません。作成・更新には対象アカウントやリージョン、権限、入力値等の条件が関わります。
| 見出し | 何を書くか | 区別すること |
|---|---|---|
| Resources | 管理する資源の宣言。テンプレートで必須。 | ここに書いた資源数は、利用するAWS機能や料金項目の全数ではない。 |
| Parameters | 作成や更新に渡す入力値と制約。任意。 | 入力値の定義は、新しいAWS資源の宣言ではない。 |
| Outputs | スタックの出力値。任意。 | 値を表示する宣言は、アプリの起動・通信・安全性の証明ではない。 |
短いYAMLを、名前と階層から読む
Resources:
ReportGroup:
Type: AWS::EC2::SecurityGroup
Properties:
GroupDescription: Reading example
VpcId: !Ref ReportNetwork
SecurityGroupEgress:
- IpProtocol: tcp
FromPort: 443
ToPort: 443
CidrIp: 10.20.0.0/24
ReportNetwork:
Type: AWS::EC2::VPC
Properties:
CidrBlock: 10.20.0.0/24
Outputs:
NetworkId:
Value: !Ref ReportNetwork| 記述 | この例での意味 |
|---|---|
| ReportGroup / ReportNetwork | Resources直下の論理ID。テンプレート内で対象を指す名前。 |
| Type: AWS::EC2::SecurityGroup | ReportGroupがセキュリティグループの宣言であることを示す。 |
| Properties | その資源に設定する項目をまとめる。VpcIdとCidrBlockは別の資源の項目。 |
| VpcId: !Ref ReportNetwork | ReportNetworkを参照し、そのVPC IDを使う。 |
| Outputs → NetworkId → Value | VPC IDをスタックの出力値にする宣言。資源をもう一つ作る行ではない。 |
Resources直下の宣言は2個です。VPC作成に伴う既定の構成要素まで含めた実環境の総数ではありません。例にはアプリやサブネット、インターネットへの経路を定義していません。受信ルールはなく、送信ルールは例示のTCP443・10.20.0.0/24です。これはそのルールを全構成へ推奨したり、実際の通信・費用を検証したりする例ではありません。
論理IDとRefの戻り値を分ける
ReportNetworkはテンプレート内の論理IDです。作成後のVPC IDそのものではありません。 実資源の識別子は作成後の結果から確認します。論理IDを変える操作も、見た目のラベル変更だけと決めつけず、CloudFormationでの対象の扱いを変更前に確認します。
| 参照 | 戻り値の読み方 | 今回の条件 |
|---|---|---|
| !Ref ReportNetwork | VPC ID。 | AWS::EC2::VPCのRefを確認する。 |
| !Ref ReportGroup | この例ではセキュリティグループID。 | VpcIdを指定している。省略した場合のRefはグループ名となるため同一視しない。 |
| !GetAtt ReportGroup.GroupId | GroupId属性の値。 | RefとGetAttは常に同じ意味の記法ではない。 |
| !Ref Stage(入力パラメータの場合) | 例えばdevという入力値。 | その名前の資源を作る参照ではない。 |
参照から作成の依存関係をたどる
- ReportNetwork → ReportGroup.VpcId作成時はVPCが先。参照値を使う
- ReportNetwork → Outputs.NetworkId出力値として参照する
- ReportNetwork
- VPCの宣言。RefはVPC IDを返す
- ReportGroup.VpcId
- !Ref ReportNetworkの値を使う
- Outputs.NetworkId
- VPC IDを出力する宣言
コードではReportGroupが上にありますが、そのVpcIdがReportNetworkをRefで参照するため、VPCの作成が先になります。 出力のNetworkIdは、別のAWS資源ではありません。図の線は値の参照を表し、パケットがVPC→グループ→出力の順で流れるという意味ではありません。
Ref・GetAtt・Sub等による資源間の参照から、暗黙の依存関係が生まれます。DependsOnは、必要な先行関係を明示する属性です。全資源を直列化するために付けるものではなく、循環参照へ追記すれば解消するものでもありません。互いを待つA→B・B→Aなら、参照や資源の分け方を見直します。
入力値と出力値も、資源の宣言と分ける
Parameters:
Stage:
Type: String
AllowedValues: [dev, prod]Stageにdevを渡したなら、!Ref Stageはその値を参照します。AllowedValuesはこの入力の選択肢を制限しますが、全ての資源設定・権限・組合せを検証するものではありません。字下げや項目名だけが正しくても、対象環境での作成成功は別の確認です。
Outputsは参照した識別子等を表示できますが、秘密を隠す保存先ではありません。 パスワードを出力しないでください。入力にNoEchoを指定しても、Outputs等へ記載した情報まで保護されるわけではありません。スタック出力が得られたことから、アプリの全処理が成功したとも判断できません。
読む順番を、変更前の確認につなげる
- Resources直下の論理IDとTypeを拾い、宣言する対象を数える。
- Propertiesを資源ごとに分け、必須値・既定値・入力の出所を読む。
- Ref/GetAtt/SubとDependsOnの参照先をたどり、依存や循環を確かめる。
- ParametersとOutputsを資源数から分け、秘密の混入を確認する。
- 対象環境・権限・差分・置換や削除の影響を確認してから適用を判断する。
論理ID・参照・依存を読み分けてみる
選択すると、正誤と理由が表示されます。
確認して、自分の言葉で説明する
- 論理ID・Type・Propertiesを、最初のYAMLへ対応させる。
- ReportNetworkの参照先と作成依存を、図を使って説明する。
- Outputsへ出してよい値と、実際に適用する前の確認を整理する。
理解を確かめる: ReportGroupのVpcIdが!Ref ReportNetworkなら、何を説明でき、何はまだ分からない?
VPCを参照して作る依存関係と、VPC IDを使う設定を説明できる。実際の作成成功、アプリの起動・通信・費用は、この宣言だけでは確定しない。
値の参照・CloudFormationの操作結果・実際のサービス動作を、別の証拠として確認するため。
出典と確認した条件
説明に用いた公式資料を、確認した内容・条件と本文の参照箇所に分けてまとめています。専門家による監修・実際のAWSとの比較検証は行っていません。
確認した内容・条件Resourcesは必須。Parameters/Outputsは別の役割。テンプレートと実操作の成功を分ける。 一次資料の照合であり実AWS未検証。
参照した本文テンプレート・スタック・資源を分ける
確認した内容・条件論理ID・Type・Properties・物理IDを区別。論理IDを表示名だけとして変更しない。 一次資料の照合であり実AWS未検証。
参照した本文テンプレート・スタック・資源を分ける 短いYAMLを、名前と階層から読む 論理IDとRefの戻り値を分ける 入力値と出力値も、資源の宣言と分ける 読む順番を、変更前の確認につなげる 論理ID・参照・依存を読み分けてみる
確認した内容・条件入力とAllowedValuesの範囲、NoEchoからOutputs等が除外される条件。秘密を出力しない。 一次資料の照合であり実AWS未検証。
参照した本文テンプレート・スタック・資源を分ける 論理IDとRefの戻り値を分ける 入力値と出力値も、資源の宣言と分ける 読む順番を、変更前の確認につなげる 論理ID・参照・依存を読み分けてみる
確認した内容・条件出力値と資源を区別。Outputsは秘密を隠さず、アプリ成功の証明でもない。 一次資料の照合であり実AWS未検証。
参照した本文テンプレート・スタック・資源を分ける 短いYAMLを、名前と階層から読む 参照から作成の依存関係をたどる 入力値と出力値も、資源の宣言と分ける 読む順番を、変更前の確認につなげる 論理ID・参照・依存を読み分けてみる
確認した内容・条件CidrBlockとRefのVPC ID。固定例の宣言を実環境や料金の検証にしない。 一次資料の照合であり実AWS未検証。
参照した本文短いYAMLを、名前と階層から読む 論理IDとRefの戻り値を分ける 参照から作成の依存関係をたどる 論理ID・参照・依存を読み分けてみる
確認した内容・条件VpcId指定ありのRefはID、未指定時は名前。既定の送受信と明示egress、相互参照の循環を区別する。 一次資料の照合であり実AWS未検証。
参照した本文短いYAMLを、名前と階層から読む 論理IDとRefの戻り値を分ける 参照から作成の依存関係をたどる 論理ID・参照・依存を読み分けてみる
確認した内容・条件Refの値は参照対象による。パラメータ値と資源の戻り値を分け、常にARNとはしない。 一次資料の照合であり実AWS未検証。
参照した本文短いYAMLを、名前と階層から読む 論理IDとRefの戻り値を分ける 参照から作成の依存関係をたどる 論理ID・参照・依存を読み分けてみる
確認した内容・条件明示DependsOnとRef/GetAtt/Subの暗黙依存。行順やアプリの準備完了とは区別。 一次資料の照合であり実AWS未検証。