「npm installのたびにCDKのバージョンが変わって、先週まで動いていたコードが動かなくなった」
こういった問題の多くは、aws cdk versionの管理が各プロジェクトでバラバラになっていることが原因です。
この記事では、AWS CDKのバージョンを確認・固定する手順と、VPC設計をプロジェクト間で統一して再利用するための構成パターンを解説します。Amazon Linux 2023を含むAmazon Linux環境を想定して説明します。
この記事のポイント
・aws cdk versionコマンドでCLIとライブラリのバージョンを確認できる
・package.jsonで「^」を外してバージョンを固定するとプロジェクト間の差異を防げる
・npm ciでpackage-lock.jsonを厳密に再現し、環境差異を排除する
・Vpc.fromLookup()でデプロイ済みのVPCを別スタックから参照してコードを再利用できる
でも安心してください。プロのエンジニアはコマンドを暗記していません。
「現場で使える型」を効率よく使いこなしているだけです。
なぜAWS CDKのバージョンが揃っていないと問題になるのか
AWS CDKは主に3つのパッケージで構成されています。・aws-cdk-lib:コンストラクトのライブラリ本体
・aws-cdk:cdk deployなどを実行するCLIツール
・constructs:aws-cdk-libが依存する基盤ライブラリ
この3つのバージョンが揃っていないと、デプロイ時に次のようなエラーが発生します。
# よくあるバージョン不一致エラー(出力例。環境により異なります) Error: This CDK CLI is not compatible with the CDK library used by your application. Expected: 2.100.0, but received: 2.95.1
3つのパッケージのバージョンを揃えることが、安定した運用の出発点になります。
aws cdk versionで現在のバージョンを確認する
まずCLIのバージョンを確認します。# CDK CLIのバージョンを確認する cdk --version
2.100.0 (build xxxxxxx)
# インストール済みの各パッケージバージョンを確認する npm list aws-cdk-lib npm list aws-cdk npm list constructs
my-vpc-project@ /home/ec2-user/my-vpc-project └── aws-cdk-lib@2.100.0
package.jsonでCDKバージョンを固定する手順
1. 現在のpackage.jsonを確認する
CDKのプロジェクトを作成すると、package.jsonのdependenciesに次のような記述があります。{ "dependencies": { "aws-cdk-lib": "^2.95.0", "constructs": "^10.0.0" }, "devDependencies": { "aws-cdk": "^2.95.0" } }
プロジェクトAとプロジェクトBで異なるバージョンがインストールされ、同じコードでも動作が変わる原因になります。
2. 「^」を外してバージョンを固定する
{ "dependencies": { "aws-cdk-lib": "2.100.0", "constructs": "10.3.0" }, "devDependencies": { "aws-cdk": "2.100.0" } }
3. package-lock.jsonを再生成する
package.jsonを変更したら、node_modulesとpackage-lock.jsonを削除して再インストールします。# node_modulesを削除して再インストールする rm -rf node_modules package-lock.json npm install # バージョンが固定されたことを確認する npm list aws-cdk-lib
npmのバージョンロックを徹底する(npm ci)
npm installはpackage.jsonの範囲内で最新バージョンを取得しますが、npm ciはpackage-lock.jsonに記録されたバージョンを厳密に再現します。CIツールや別の開発環境でセットアップするときは、npm installではなくnpm ciを使う習慣をつけると、バージョン不一致を防げます。
# package-lock.jsonに基づいて厳密にインストールする npm ci
Gitリポジトリにpackage-lock.jsonをコミットしておくことが前提です。
VPC設計をプロジェクト間で再利用する方法
バージョンを統一したあとの設計パターンを紹介します。VPC設計を「VPC専用スタック」として分離して、他のスタックから参照するパターンが保守しやすい構成です。
AWSのVPCとAmazon Linuxの基礎から習得したい場合は、AWSのAmazon Linuxセキュリティ設計・構築スキル習得ガイドも参考にしてください。
1. VPCスタックでVPC IDをエクスポートする
// vpc-stack.ts import * as cdk from 'aws-cdk-lib'; import * as ec2 from 'aws-cdk-lib/aws-ec2'; export class VpcStack extends cdk.Stack { public readonly vpc: ec2.Vpc; constructor(scope: cdk.App, id: string, props?: cdk.StackProps) { super(scope, id, props); this.vpc = new ec2.Vpc(this, 'MainVpc', { maxAzs: 2, subnetConfiguration: [ { name: 'Public', subnetType: ec2.SubnetType.PUBLIC }, { name: 'Private', subnetType: ec2.SubnetType.PRIVATE_WITH_EGRESS }, ], }); // VPC IDをCfnOutputでエクスポートする new cdk.CfnOutput(this, 'VpcId', { value: this.vpc.vpcId, exportName: 'SharedVpcId', }); } }
2. 別スタックからVpcを参照する
別プロジェクトや別スタックからは、Vpc.fromLookup()でデプロイ済みのVPCを参照できます。// app-stack.ts import * as cdk from 'aws-cdk-lib'; import * as ec2 from 'aws-cdk-lib/aws-ec2'; export class AppStack extends cdk.Stack { constructor(scope: cdk.App, id: string, props?: cdk.StackProps) { super(scope, id, props); // デプロイ済みのVPCを参照する const vpc = ec2.Vpc.fromLookup(this, 'ImportedVpc', { vpcId: 'vpc-xxxxxxxxxxxxxxxxx', }); // 参照したVPCを使ってEC2などのリソースを配置する } }
そのため、~/.aws/credentialsにプロファイルが設定されていない環境では動作しません。
3. cdk.jsonのcontextで環境ごとのVPC IDを管理する
VPC IDをコード内に直接記述すると環境ごとに書き換えが必要になります。cdk.jsonのcontextに記述しておくと、環境ごとに値を切り替えやすくなります。
// cdk.json { "context": { "vpcId": "vpc-xxxxxxxxxxxxxxxxx" } }
// スタック内でcontextの値を取得する const vpcId = this.node.tryGetContext('vpcId'); const vpc = ec2.Vpc.fromLookup(this, 'ImportedVpc', { vpcId });
CDKバージョン更新時のトラブルシュート
「This CDK CLI is not compatible」エラーへの対処
CLIとライブラリのバージョンが一致していない時に発生します。まずnpm list aws-cdk-libでライブラリバージョンを確認し、CLIを同じバージョンに更新します。
# ライブラリバージョンに合わせてCLIをインストールする npm install -g aws-cdk@2.100.0 # バージョンを確認する cdk --version
cdk synthでコンテキスト不一致エラーが出る場合
Vpc.fromLookup()はキャッシュをcdk.context.jsonに保存します。VPCを再作成した場合などはキャッシュが古くなるため、cdk.context.jsonを削除してから再実行します。
# コンテキストキャッシュを削除して再生成する rm cdk.context.json cdk synth
「Cannot find module 'aws-cdk-lib'」エラーへの対処
node_modulesが不完全な状態になっているケースがあります。npm ciで再インストールすると解消することが多いです。
# node_modulesを削除してpackage-lock.jsonから厳密に再インストールする rm -rf node_modules npm ci
本記事のまとめ
AWS CDKのバージョン管理とVPC設計の再利用について整理します。| やりたいこと | 手順・コマンド |
|---|---|
| CDK CLIのバージョンを確認する | cdk --version |
| ライブラリのバージョンを確認する | npm list aws-cdk-lib |
| バージョンを固定する | package.jsonから「^」を外してnpm install |
| 厳密なバージョンで再現インストールする | npm ci |
| デプロイ済みのVPCを参照する | ec2.Vpc.fromLookup(this, 'id', { vpcId }) |
| コンテキストキャッシュをリセットする | rm cdk.context.json && cdk synth |
VPC設計はVPCスタックに集約して、Vpc.fromLookup()で参照する。
この2点を運用の起点にすると、プロジェクト間での設計の再利用がしやすくなります。
AWSのセキュリティ設計からLinuxサーバー運用まで、体系的に習得できる学習ガイドを用意しています。
>>AWSのAmazon Linuxセキュリティ設計・構築スキル習得ガイドを見る
3,100名以上が実践した「型」を無料で公開中
プロのエンジニアはコマンドを暗記していません。
「現場で使える型」を効率よく使いこなしているだけです。
その「型」を図解60Pにまとめた入門マニュアルを、完全無料でプレゼントしています。
姓・名・メールの3つだけ/30秒/解除は3秒 / 詳細はこちら
- 前のページへ:AWS CDKとnpmバージョン管理でマルチAZ構成設計を始める方法|開発環境セットアップ
- この記事の属するカテゴリ:AWS(Amazon Linux)へ戻る

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