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

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

LEARNINGEN

テーマ別の解説テーマ:AWS CDK:コードと合成物

AWS CDKのsynthとは?ConstructとCloudFormationの関係を図解

AWS CDKはプログラムで構成を表し、synthでCloudFormationテンプレートなどのデプロイ用のファイル一式を作ります。 合成できたことと、AWSに反映できたことは別です。短いコードを、包含関係・参照・変更の確認という三つの観点で読みます。

この教材で学ぶこと

App・Stack・Constructの関係を読み、合成物の確認とAWSへの適用を分けて説明する。

先に知っておくこと

CloudFormationのResources・論理ID・Refを知っていると読みやすい教材です。TypeScriptの細かな文法は知らなくても構いません。ここではコードを読むだけで、CDKやAWSを実行しません。

コードから合成物へ、その後にデプロイする

何を作り、何を確かめる段階か
段階扱うもの確認すること
記述プログラムで宣言した構成作る資源、参照、条件、既定値。
合成(synth)CloudFormationテンプレートやassets等のcloud assembly生成された資源とプロパティ、配布に必要な成果物。
適用と検証対象のAWS環境と実際の機能変更の影響と適用結果、その後の通信やアプリ。

cloud assemblyはテンプレートだけとは限りません。 アプリが必要とするファイルやイメージのassetsなども対象になります。コードレビューでは、プログラムの読みやすさに加えて、生成される構成を確認します。

App・Stack・Constructは、構成を組み立てる単位

包含関係を読む:矢印は通信ではない
包含関係を読む:矢印は通信ではない1: App — 含む — ReportStack. 2: ReportStack — 含む — ReportNetwork. 3: ReportStack — 含む — ReportGroup123AppReportStackReportNetworkReportGroup包含関係を読む:矢印は通信ではない1: App — 含む — ReportStack. 2: ReportStack — 含む — ReportNetwork. 3: ReportStack — 含む — ReportGroup123AppReportStackReportNetworkReportGroup
  1. App → ReportStack含む
  2. ReportStack → ReportNetwork含む
  3. ReportStack → ReportGroup含む
App
構成を組み立てるアプリ
ReportStack
この例のStack
ReportNetwork
VPCを宣言するL1
ReportGroup
SGを宣言するL1

Constructは構成を表す部品、StackはCloudFormationスタックとして扱うまとまり、Appはそれらを組み立てるアプリです。 図のSGからVPCへ通信する、という意味ではありません。資源同士の参照は、次のコードのプロパティで読みます。

固定例:VPCの参照をセキュリティグループへ渡す

TypeScriptの読解例:実行・合成結果ではない長い行は横スクロールで読めます。コード欄では左右キーを使えます。
import { App, Stack, aws_ec2 as ec2 } from 'aws-cdk-lib';

const app = new App();
const stack = new Stack(app, 'ReportStack');
const network = new ec2.CfnVPC(stack, 'ReportNetwork', {
  cidrBlock: '10.20.0.0/16'
});
new ec2.CfnSecurityGroup(stack, 'ReportGroup', {
  groupDescription: 'Illustrative group',
  vpcId: network.ref
});
app.synth();
文字列のIDと参照を混同しない
コード読み方
new Stack(app, 'ReportStack')appの内側にStackを置く。
new ec2.CfnVPC(stack, 'ReportNetwork', ...)Stack内にVPCを表すL1 Constructを置く。
vpcId: network.ref合成後にCloudFormationが解決するVPCのRefを渡す。
app.synth()アプリの構成から合成物を生成する。AWSでの適用成功を示す行ではない。

部品の抽象度と、資源の識別子を分ける

L1・L2・L3を読む目安
種類何を表すかレビューの観点
L1CloudFormation資源に直接対応する低水準の部品。Cfnから始まる型が目印。必要なプロパティを明示する。
L2使いやすいAPIや補助機能を持つ部品。既定値・権限など生成される設定も読む。
L3・パターン複数の部品を組み合わせた構成。省略した記述の裏で、何が作られるか確認する。
同じ「ID」でも役割が違う
種類役割
Construct ID同じscope内で部品を識別するコード上のID。
CloudFormation論理ID合成テンプレート内で資源を追跡するID。Constructのpathが生成に関わる。
実リソースの識別子作成された資源のIDや名前。コード上のIDと常に同じとは限らない。

Constructの移動やID変更は、論理IDを変え、資源の作り直しにつながることがあります。コードの整理を、必ず資源に影響しない変更と扱わないでください。生成物と差分で同一性や置換の有無を確認します。論理IDは名前だけから決めつけず、実際の生成物で照合します。

synthの成功だけで、安全性や適用成功を決めない

synthではアプリのコードが実行されます。環境値の取得(context lookup)やassetsの作成条件によっては、AWSへの問い合わせや別の処理が関係します。synthなら無条件にオフラインで無害、と考えないことが大切です。

  1. アプリと依存する部品を読み、実行時の処理とlookupの条件を確認する。
  2. 生成されたテンプレートとassetsを確認し、変更・権限・置換や削除の影響を読む。
  3. 対象の環境・権限・承認内容をそろえて適用し、結果と実際の機能を確認する。

構成の読み方を確かめる

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

synthが成功した。AWSでの反映も完了した?
答えと理由を読む

正解:いいえ。適用の結果は別に確認する · 合成成功は、対象で資源を作成・更新できた証拠ではありません。

App → Stack → Constructの図が示すものは?
答えと理由を読む

正解:構成を組み立てる包含関係 · App内にStack、その中に部品を置く関係です。通信の順番ではありません。

固定例のnetwork.refは、SGへ何を渡す?
答えと理由を読む

正解:CloudFormationで解決するVPCの参照 · vpcIdへ、VPCを表すRefを渡す固定例です。

見た目だけのコード整理なら、資源の同一性は確認不要?
答えと理由を読む

正解:いいえ。論理IDと差分を確認する · 意図しない置換や削除を見落とさないために確認します。

synthなら、アプリの中身を読まずに実行してよい?
答えと理由を読む

正解:いいえ。コード実行やlookupの条件を確認する · 合成でもアプリが動き、環境やassetsの処理が関係する場合があります。

高水準のConstructを1つ書いた。実資源も必ず1つ?
答えと理由を読む

正解:いいえ。生成される構成で確認する · 高水準の部品やパターンが何を組み立てるかを確認します。

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

  1. 包含図でApp・Stack・Constructを分ける。
  2. 固定コードのscopeとRefを読む。
  3. 設問と復習で、合成後の確認事項を説明する。
理解を確かめる: CDKのレビューで、コード以外に何を確認する?

生成されるテンプレートとassets、資源の参照と論理ID、権限や置換・削除の差分、対象環境と適用後の機能を確認する。

読みやすいコード、生成物、適用結果、実際の機能は別の確認対象だから。

出典と確認した条件

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