VPC設計の変更は、数行のコードの変更でも本番ネットワーク構成を大きく変えます。
サブネットのCIDRブロックを誤ると、後からスタックの再作成が必要になる場合があります。
この記事では、AWS CDKで書いたVPC設計のインフラコードをGitHubのプルリクエストで管理・レビューする手順を解説します。Amazon Linux 2023 / RHEL 9系を想定環境として説明します。
この記事のポイント
・ cdk diff コマンドでプルリクエスト前に変更差分を確認できる
・ main / develop / feature のブランチ戦略でVPC設計変更を安全に管理する
・ GitHub ActionsでPR作成時にcdk diffを自動出力してレビュー効率を上げる
・ レビューチェックポイントはAZ数・サブネット種別・NATゲートウェイの3点が核心
でも安心してください。プロのエンジニアはコマンドを暗記していません。
「現場で使える型」を効率よく使いこなしているだけです。
AWS CDKでVPC設計をコードで管理する意味
AWSのVPC設計をコンソールから手作業で変更すると、変更の記録が残りません。「誰が、いつ、なぜサブネットを追加したか」が追えなくなります。
AWS CDKを使うと、VPC構成をTypeScriptなどのコードで記述できます。
GitHubで管理することで、変更履歴が残り、プルリクエストによるレビューが可能になります。
CDKで定義したVPCスタックをGitHubに置く設計には、次の3つの効果があります。
・変更内容がコードの差分(diff)として可視化される
・プルリクエストでチームメンバーがレビューできる
・GitHub Actionsと連携してcdk diffを自動出力できる
CDKを使う前にAWSでのサーバー構築の基礎を押さえておきたい場合は、Amazon LinuxでのAWSサーバー構築の基礎も参考にしてください。
GitHubリポジトリの構成とブランチ戦略
1. CDKプロジェクトのディレクトリ構成
cdk init コマンドで生成したTypeScriptプロジェクトは次の構成になります。# CDKプロジェクトの基本構成(cdk init app --language typescript で生成) my-vpc-cdk/ ├── bin/ │ └── my-vpc-cdk.ts # エントリーポイント ├── lib/ │ └── my-vpc-cdk-stack.ts # VPCスタック定義 ├── test/ │ └── my-vpc-cdk.test.ts # テストコード ├── cdk.json # CDK設定ファイル ├── package.json └── tsconfig.json
コードレビューの対象は、主にこのファイルになります。
2. ブランチの運用ルール
VPC設計の変更を安全に管理するため、次のブランチ構成を使います。・main ブランチ:本番環境にデプロイ済みのコード。直接コミットは禁止
・develop ブランチ:検証環境にデプロイするコード。featureブランチのマージ先
・feature ブランチ:VPC設計の変更作業用。PRをdevelopに向けて作成する
GitHubのブランチ保護ルールで、mainとdevelopへの直接プッシュを禁止することをお勧めします。
プルリクエストの作成とレビューの手順
1. feature ブランチでVPC設計を変更する
新しいブランチを作成してVPCの設計を変更します。# featureブランチを作成してチェックアウト git checkout -b feature/add-private-subnet # TypeScriptでVPCを定義する例(lib/my-vpc-cdk-stack.ts) import * as ec2 from 'aws-cdk-lib/aws-ec2'; import { Stack, StackProps } from 'aws-cdk-lib'; import { Construct } from 'constructs'; export class MyVpcCdkStack extends Stack { constructor(scope: Construct, id: string, props?: StackProps) { super(scope, id, props); const vpc = new ec2.Vpc(this, 'MainVpc', { maxAzs: 2, # マルチAZ(2つのAZ) cidr: '10.0.0.0/16', subnetConfiguration: [ { cidrMask: 24, name: 'Public', subnetType: ec2.SubnetType.PUBLIC, }, { cidrMask: 24, name: 'Private', subnetType: ec2.SubnetType.PRIVATE_WITH_EGRESS, }, ], }); } }
subnetConfiguration で Public(インターネット向け)と Private(内部向け)のサブネットを定義しています。
2. cdk diff で変更内容を確認する
プルリクエストを作成する前に、cdk diff でデプロイ前の変更差分を確認します。# CDKの変更差分を確認する npx cdk diff MyVpcCdkStack # 出力例(環境により異なります) Stack MyVpcCdkStack Resources [+] AWS::EC2::Subnet MainVpc/PrivateSubnet1Subnet (追加) [+] AWS::EC2::Subnet MainVpc/PrivateSubnet2Subnet (追加) [+] AWS::EC2::RouteTable MainVpc/PrivateSubnet1RouteTable (追加) [+] AWS::EC2::NatGateway MainVpc/PublicSubnet1NatGateway (追加)
特に NatGateway の追加は費用が発生するため、レビュー時に必ず確認します。
3. プルリクエストを作成してレビューを依頼する
変更内容を確認したら、GitHubにプッシュしてプルリクエストを作成します。# リモートブランチにプッシュ git add lib/my-vpc-cdk-stack.ts git commit -m "feat: プライベートサブネットをマルチAZ構成に追加" git push origin feature/add-private-subnet
PRの説明文にcdk diffの出力結果を貼り付けると、レビュアーが変更内容を把握しやすくなります。
VPC設計変更のコードレビュー チェックポイント
プルリクエストのレビューでは、次のポイントを確認します。【チェック1】AZ数(maxAzs)の妥当性
本番環境は maxAzs: 2 以上に設定します。1 のままだと、AZの障害時にサービスが停止します。
開発環境では maxAzs: 1 にしてコスト削減することを検討してもよいですが、本番環境には必ず2以上を設定します。
【チェック2】サブネット種別とCIDRブロック
PUBLIC / PRIVATE_WITH_EGRESS / PRIVATE_ISOLATED の3種別の用途を確認します。・PUBLIC:インターネットゲートウェイ経由の通信が可能。フロントエンドや踏み台サーバーに使用
・PRIVATE_WITH_EGRESS:NATゲートウェイ経由のアウトバウンド通信が可能。アプリサーバーに使用
・PRIVATE_ISOLATED:インターネットへの通信なし。DBやバッチ処理サーバーに使用
CIDRブロックは他のVPCや他のサブネットと重複しないか、/16 ~ /28 の範囲に収まっているかを確認します。
【チェック3】NATゲートウェイの配置
PRIVATE_WITH_EGRESS を使うと、AZごとに NatGateway が1つ作成されます。費用対効果を考慮して、開発環境では natGateways: 1 に変更することを検討します。
# 開発環境向け:NATゲートウェイを1つに削減する設定 const vpc = new ec2.Vpc(this, 'MainVpc', { maxAzs: 2, cidr: '10.0.0.0/16', natGateways: 1, # デフォルトはmaxAzs分作成される(本番は2以上推奨) subnetConfiguration: [ { cidrMask: 24, name: 'Public', subnetType: ec2.SubnetType.PUBLIC, }, { cidrMask: 24, name: 'Private', subnetType: ec2.SubnetType.PRIVATE_WITH_EGRESS, }, ], });
【チェック4】VPCフローログの有無
セキュリティ監査のため、フローログを有効化するコードが含まれているかを確認します。フローログは後から追加できますが、CDKコードに記述しておくことで設定漏れを防げます。
GitHub ActionsでPRにcdk diffを自動追加する
プルリクエスト作成時にcdk diffを自動実行してPRコメントに追記するGitHub Actionsのワークフローを設定します。# .github/workflows/cdk-diff.yml name: CDK Diff on PR on: pull_request: branches: - develop jobs: cdk-diff: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - name: Node.jsをセットアップする uses: actions/setup-node@v4 with: node-version: '20' - name: 依存パッケージをインストールする run: npm ci - name: AWS認証情報を設定する uses: aws-actions/configure-aws-credentials@v4 with: aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }} aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }} aws-region: ap-northeast-1 - name: cdk diffを実行してPRコメントに追記する run: | DIFF=$(npx cdk diff 2>&1 || true) gh pr comment ${{ github.event.pull_request.number }} \ --body "## CDK Diff$(printf '\n\n```\n%s\n```' "$DIFF")" env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
このワークフローが動作すると、developブランチへのPR作成時に自動でcdk diffの結果がPRコメントとして追記されます。
レビュアーはPRページで変更されるAWSリソースをその場で確認できます。
本記事のまとめ
AWS CDKのVPC設計コードをGitHubのプルリクエストで管理・レビューする手順をまとめました。| やりたいこと | コマンド・手順 |
|---|---|
| featureブランチを作成する | git checkout -b feature/vpc-change |
| VPCスタックの変更差分を確認する | npx cdk diff MyVpcCdkStack |
| 変更をリモートにプッシュする | git push origin feature/vpc-change |
| PRにcdk diffを自動追加する | GitHub Actions(cdk-diff.yml)を設定する |
| AZ数を設定する | コードで maxAzs の値を設定する |
| NATゲートウェイの費用を削減する | コードで natGateways: 1 に変更する |
次のステップとして、cdk synthを使ったCloudFormationテンプレートの事前確認も組み合わせることをお勧めします。
AWS・Amazon Linuxの基礎から始めるサーバー構築の全体像を学べる入門コンテンツをまとめています。
>>Amazon LinuxでAWSサーバー構築を始める
3,100名以上が実践した「型」を無料で公開中
プロのエンジニアはコマンドを暗記していません。
「現場で使える型」を効率よく使いこなしているだけです。
その「型」を図解60Pにまとめた入門マニュアルを、完全無料でプレゼントしています。
姓・名・メールの3つだけ/30秒/解除は3秒 / 詳細はこちら
- 前のページへ:AWS CDKのインストールと初期設定でVPCスタックを構成する実践手順|Linux環境向け
- この記事の属するカテゴリ:AWS(Amazon Linux)へ戻る

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