INFRASTRUCTURE LEARNINGインフラ学習
インフラ大全インフラ大全IT INFRASTRUCTURE / LEARNING
インフラ学習ガイド
教材・演習を探す/

Escで閉じる · 検索語は送信しません

LEARNINGEN

テーマ別の解説テーマ: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を、名前と階層から読む

読解用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 / ReportNetworkResources直下の論理ID。テンプレート内で対象を指す名前。
Type: AWS::EC2::SecurityGroupReportGroupがセキュリティグループの宣言であることを示す。
Propertiesその資源に設定する項目をまとめる。VpcIdとCidrBlockは別の資源の項目。
VpcId: !Ref ReportNetworkReportNetworkを参照し、そのVPC IDを使う。
Outputs → NetworkId → ValueVPC IDをスタックの出力値にする宣言。資源をもう一つ作る行ではない。

Resources直下の宣言は2個です。VPC作成に伴う既定の構成要素まで含めた実環境の総数ではありません。例にはアプリやサブネット、インターネットへの経路を定義していません。受信ルールはなく、送信ルールは例示のTCP443・10.20.0.0/24です。これはそのルールを全構成へ推奨したり、実際の通信・費用を検証したりする例ではありません。

論理IDとRefの戻り値を分ける

ReportNetworkはテンプレート内の論理IDです。作成後のVPC IDそのものではありません。 実資源の識別子は作成後の結果から確認します。論理IDを変える操作も、見た目のラベル変更だけと決めつけず、CloudFormationでの対象の扱いを変更前に確認します。

Refは参照先によって意味が変わる
参照戻り値の読み方今回の条件
!Ref ReportNetworkVPC ID。AWS::EC2::VPCのRefを確認する。
!Ref ReportGroupこの例ではセキュリティグループID。VpcIdを指定している。省略した場合のRefはグループ名となるため同一視しない。
!GetAtt ReportGroup.GroupIdGroupId属性の値。RefとGetAttは常に同じ意味の記法ではない。
!Ref Stage(入力パラメータの場合)例えばdevという入力値。その名前の資源を作る参照ではない。

参照から作成の依存関係をたどる

この例の参照関係:線は通信経路ではありません
この例の参照関係:線は通信経路ではありません1: ReportNetwork — 作成時はVPCが先。参照値を使う — ReportGroup.VpcId. 2: ReportNetwork — 出力値として参照する — Outputs.NetworkId12ReportNetworkReportGroup.VpcIdOutputs.NetworkIdこの例の参照関係:線は通信経路ではありません1: ReportNetwork — 作成時はVPCが先。参照値を使う — ReportGroup.VpcId. 2: ReportNetwork — 出力値として参照する — Outputs.NetworkId12ReportNetworkReportGroup.VpcIdOutputs.NetworkId
  1. ReportNetwork → ReportGroup.VpcId作成時はVPCが先。参照値を使う
  2. 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なら、参照や資源の分け方を見直します。

入力値と出力値も、資源の宣言と分ける

追加の読解例:Stageは入力値。単独の完成テンプレートではありません長い行は横スクロールで読めます。コード欄では左右キーを使えます。
Parameters:
  Stage:
    Type: String
    AllowedValues: [dev, prod]

Stageにdevを渡したなら、!Ref Stageはその値を参照します。AllowedValuesはこの入力の選択肢を制限しますが、全ての資源設定・権限・組合せを検証するものではありません。字下げや項目名だけが正しくても、対象環境での作成成功は別の確認です。

Outputsは参照した識別子等を表示できますが、秘密を隠す保存先ではありません。 パスワードを出力しないでください。入力にNoEchoを指定しても、Outputs等へ記載した情報まで保護されるわけではありません。スタック出力が得られたことから、アプリの全処理が成功したとも判断できません。

読む順番を、変更前の確認につなげる

  1. Resources直下の論理IDとTypeを拾い、宣言する対象を数える。
  2. Propertiesを資源ごとに分け、必須値・既定値・入力の出所を読む。
  3. Ref/GetAtt/SubとDependsOnの参照先をたどり、依存や循環を確かめる。
  4. ParametersとOutputsを資源数から分け、秘密の混入を確認する。
  5. 対象環境・権限・差分・置換や削除の影響を確認してから適用を判断する。

論理ID・参照・依存を読み分けてみる

選択すると、正誤と理由が表示されます。

最初のYAMLのResources直下に、資源はいくつ宣言されている?
答えと理由を読む

正解:2個。ReportGroupとReportNetwork · NetworkIdはOutputsの宣言なので、Resources直下の数へ足しません。

ReportGroupが上に書かれている。この例で先に作成する依存先は?
答えと理由を読む

正解:ReportNetwork。VpcIdがRefで参照している · ReportGroupは作成時に、そのVPCの参照値を使います。

この例の!Ref ReportGroupを読むとき、正しいのは?
答えと理由を読む

正解:VpcId指定ありなので、この資源型のRefはグループID · この条件を資源別資料で確認します。VpcId省略時のグループ名と区別します。

AがBを参照しBがAを参照する循環がある。どう考える?
答えと理由を読む

正解:参照や資源の分け方を見直す · 互いを待つ依存を解く必要があります。行順だけを変えても解消しません。

Outputsへパスワードを入れ、入力だけNoEchoにした。秘密は保護される?
答えと理由を読む

正解:いいえ。Outputsへ秘密を出さない · 入力値のマスクと出力へ書いた情報の保護は同じではありません。

確認して、自分の言葉で説明する

  1. 論理ID・Type・Propertiesを、最初のYAMLへ対応させる。
  2. ReportNetworkの参照先と作成依存を、図を使って説明する。
  3. Outputsへ出してよい値と、実際に適用する前の確認を整理する。
理解を確かめる: ReportGroupのVpcIdが!Ref ReportNetworkなら、何を説明でき、何はまだ分からない?

VPCを参照して作る依存関係と、VPC IDを使う設定を説明できる。実際の作成成功、アプリの起動・通信・費用は、この宣言だけでは確定しない。

値の参照・CloudFormationの操作結果・実際のサービス動作を、別の証拠として確認するため。

出典と確認した条件

説明に用いた公式資料を、確認した内容・条件と本文の参照箇所に分けてまとめています。専門家による監修・実際のAWSとの比較検証は行っていません。