こういう状況はよくあります。
aws cdk docsには情報量が多く、L1 ConstructとL2 Constructが並んで表示されるため、最初はどちらを参照すればいいか判断に迷います。
VpcクラスひとつをとってもプロパティはVpcPropsインターフェースに20種類以上あり、全部を暗記するより引き方を身につけるほうが実務では速く動けます。
この記事では、CDK v2(TypeScript)でVPCを設計することを想定して、aws cdk docsのAPI Referenceの構造とVPC関連クラスの探し方・読み方を説明します。
L1・L2 Constructの見分け方から、VpcPropsのプロパティ一覧、SubnetConfigurationとNatProviderのリファレンス確認方法まで取り上げます。
この記事のポイント
・aws cdk docsはaws-cdk-lib.aws_ec2モジュールからVPC関連クラスを探す
・L2 VpcクラスのPropsはVpcPropsインターフェースで確認する
・SubnetType・SubnetConfiguration・NatProviderをセットで参照する
・@deprecated表示のあるプロパティは使わずに代替を確認する
でも安心してください。プロのエンジニアはコマンドを暗記していません。
「現場で使える型」を効率よく使いこなしているだけです。
なぜCDK docsの引き方を覚えると設計が速くなるのか
AWS CDKを使ってVPCを設計するとき、コードのほとんどはAPIリファレンスに書かれているプロパティ名とその型を参照しながら書いていきます。VpcクラスのプロパティはVpcPropsインターフェースに定義されていて、maxAzs・subnetConfiguration・natGateways・natGatewayProviderなど20種類以上あります。
そのすべてを暗記するより、必要なときにaws cdk docsから正確な型と使い方を引けるほうが実務では速く動けます。
「ドキュメントを読む時間がかかる」と感じている場合、たいていリファレンスの構造を把握していないことが原因です。
最初に構造を把握しておくと、次からの参照は数十秒で終わります。
AWS CDK docsの全体構造を把握する
1. API Referenceへのアクセス方法
AWS CDK docsのAPI Referenceは、以下のURLからアクセスできます。https://docs.aws.amazon.com/cdk/api/v2/
トップページには言語ごとのリンクが並んでいます。TypeScript・Python・Java・C#・Goから選べます。
VPC設計をTypeScriptで進める場合は「TypeScript」を選びます。
その後、左サイドバーに「aws-cdk-lib」の項目があります。
ここをクリックすると、全モジュールの一覧が展開されます。
2. モジュール一覧からVPC関連クラスを探す
VPCに関連するクラスはすべて「aws-cdk-lib.aws_ec2」モジュールにあります。サイドバーの検索欄に「aws_ec2」と入力すると、このモジュールへ直接移動できます。
aws_ec2のページを開くと、クラスの一覧が表示されます。
「Vpc」「VpcLookupOptions」「SubnetConfiguration」などVPC設計で使うクラスが確認できます。
ページ内検索(Ctrl+F または Cmd+F)で「Vpc」と入力すると、VPC関連のクラスを素早く絞り込めます。
VPC設計で使うクラス一覧の読み方
1. L1 ConstructとL2 Constructの見分け方
aws cdk docsでVPC関連クラスを開くと、2種類のクラスが混在しています。・CfnVPC(Cfn から始まるクラス)→ L1 Construct
・Vpc(通常の名前のクラス)→ L2 Construct
L1 ConstructはCloudFormationのリソースをそのままPropとして持つクラスです。
プロパティ名もCloudFormationのものと同じなので、設計の自由度は高い反面、記述量が増えます。
L2 ConstructはCDKが提供する高レベルなAPIです。
VPC設計で主に参照するのはL2のVpcクラスです。
マルチAZ構成やサブネット設計をシンプルな記述でまとめられます。
2. VpcクラスのプロパティをCDK docsで確認する
VpcクラスのAPIページは、次の構成になっています。・クラスの説明(Summary)
・コンストラクタのシグネチャ(new Vpc(scope, id, props))
・VpcProps インターフェースのプロパティ一覧
・メソッド一覧
VPC設計で最初に参照するのは「VpcProps」の欄です。
マルチAZ冗長設計に使う主なプロパティを以下にまとめます。
| プロパティ名 | 型 | 説明 |
|---|---|---|
| maxAzs | number | 使用するAZの最大数(デフォルト: 3) |
| subnetConfiguration | SubnetConfiguration[] | サブネットの種類・CIDR・名前の配列 |
| natGateways | number | NATゲートウェイの数(デフォルト: AZ数と同じ) |
| natGatewayProvider | NatProvider | NAT方式(NatProvider.gateway() か NatProvider.instance()) |
| ipAddresses | IIpAddresses | CIDRブロックの割り当て方式(v2.3.0以降はこちらを使う) |
| enableDnsHostnames | boolean | DNSホスト名の有効化(デフォルト: true) |
| enableDnsSupport | boolean | DNSサポートの有効化(デフォルト: true) |
3. SubnetConfigurationをリファレンスから確認する
SubnetConfigurationはVPC内のサブネット設計を定義するインターフェースです。aws cdk docsでは「SubnetConfiguration interface」として記載されています。
主なプロパティは以下のとおりです。
・name:サブネットの論理名(PublicやPrivateなど)
・subnetType:SubnetType.PUBLIC / PRIVATE_WITH_EGRESS / ISOLATEDの3種
・cidrMask:サブネットのCIDRプレフィックス(/24ならば24と記述する)
・reserved:将来のAZ拡張のために予約するか(boolean)
subnetTypeは列挙型(enum)です。
CDK docsのSubnetTypeのページで、各値の説明を確認できます。
PRIVATE_WITH_EGRESSはNATゲートウェイ経由でインターネットに出られるプライベートサブネット、ISOLATEDは完全にインターネットから切り離されたサブネットです。
マルチAZ冗長設計でよく参照するAPIの組み合わせ
VPC設計でマルチAZ構成を組む場合、CDK docsで次のクラスをセットで参照します。以下はVpcPropsの基本構成の例です(環境により設定値は異なります)。
# VpcProps の構成例(TypeScript) { maxAzs: 2, natGateways: 1, subnetConfiguration: [ { name: 'Public', subnetType: SubnetType.PUBLIC, cidrMask: 24, }, { name: 'Private', subnetType: SubnetType.PRIVATE_WITH_EGRESS, cidrMask: 24, }, { name: 'Isolated', subnetType: SubnetType.ISOLATED, cidrMask: 28, }, ], }
ただし特定のAZでNATゲートウェイが停止すると、他のAZのプライベートサブネットからのアウトバウンド通信にも影響が出ます。
本番環境ではmaxAZsと同数にするかどうかを設計段階で判断します。
NatProvider.instance()を使うとEC2インスタンスでNATを代替できます。
CDK docsの「NatProvider」ページで、instanceTypeやmachineImageなどのオプションを確認できます。
AWSのLinux環境でCDK構築の基礎から学びたい場合は、Amazon LinuxでAWSを使い始める手順のページで実践的な内容を確認できます。
CDK docsを参照する際のよくある落とし穴
1. deprecatedのプロパティを使ってしまう
CDK docsでは廃止予定のプロパティに「@deprecated」の注記が付いています。Vpcクラスのcidrプロパティは現在deprecatedで、代わりにipAddressesを使うよう誘導されています。
コードをそのままコピーした場合、deprecatedのプロパティを使ってしまうことがあります。
CDK docsを参照する際には、プロパティ行の横にdeprecatedの表示がないかを確認してください。
2. L1とL2の混在で意図しない動作になる場合
CfnVPC(L1)とVpc(L2)を同じスタックに並べると、スタックの合成時に意図しない動作になることがあります。L2 ConstructのVpcにはCfnVPCへのescapeハッチとしてnode.defaultChildプロパティが用意されています。
CDK docsのVpcクラスのページでnode.defaultChildの型を確認すると、CfnVPCにキャストして詳細設定を追加できることが分かります。
L1とL2を直接並べるより、L2を基点にして必要な箇所だけescapeハッチを使うほうが設計がシンプルになります。
3. API ReferenceとDeveloper Guideを混同する
AWS CDK docsにはAPI Referenceと「Developer Guide」の2つのセクションがあります。Developer Guideはチュートリアルや概念説明が中心です。
クラスのプロパティを確認するには、API Referenceを参照します。
URLが「docs.aws.amazon.com/cdk/api/v2/」から始まるページがAPI Referenceです。
「docs.aws.amazon.com/cdk/v2/guide/」から始まるページはDeveloper Guideです。
本記事のまとめ
AWS CDK docsでVPC設計に使う構成クラスを引くための要点をまとめます。| やりたいこと | 参照先・確認内容 |
|---|---|
| VPC関連クラスを探す | aws-cdk-lib.aws_ec2 モジュールのクラス一覧 |
| L2 VpcクラスのPropsを確認する | VpcProps インターフェースのプロパティ一覧 |
| サブネット種別を設定する | SubnetConfiguration interface + SubnetType enum |
| NAT方式を選ぶ | NatProvider.gateway() / NatProvider.instance() |
| マルチAZ構成のAZ数を制御する | VpcProps.maxAzs(デフォルト3) |
| 廃止プロパティを避ける | @deprecated 表示がないプロパティを選ぶ |
まずVpcPropsのページをブックマークして、設計のたびにプロパティ型を参照する習慣を作ると、実装のスピードが上がります。
AWSを含むLinuxサーバーの設計・構築・運用スキルを体系的に習得できるセミナーを開催しています。
>>Amazon Linux でAWSサーバー構築を始める
3,100名以上が実践した「型」を無料で公開中
プロのエンジニアはコマンドを暗記していません。
「現場で使える型」を効率よく使いこなしているだけです。
その「型」を図解60Pにまとめた入門マニュアルを、完全無料でプレゼントしています。
姓・名・メールの3つだけ/30秒/解除は3秒 / 詳細はこちら
- 前のページへ:AWS監視ツールを活用したVPCマルチAZ構成変更の検知と通知設定手順|CloudTrailとSNS
- この記事の属するカテゴリ:AWS(Amazon Linux)へ戻る

無料メルマガで学習を続ける
Linuxの実践スキルをメールで毎週お届け。
登録は30秒、解除もいつでも可。
登録無料・いつでも解除できます