AWS CDKのインストールと初期設定でVPCスタックを構成する実践手順|Linux環境向け

運営:リナックスマスター.JP(代表 宮崎智広)
HOME > Linux技術 リナックスマスター.JP(Linuxマスター.JP) > AWS(Amazon Linux) > AWS CDKのインストールと初期設定でVPCスタックを構成する実践手順|Linux環境向け
「AWS CDKをLinuxに入れたいが、どこから手をつければよいか分からない」
「cdk bootstrapって何をするためにあるのか」

Infrastructure as Code(IaC)ツールの中でも、TypeScriptやPythonでAWSリソースを定義できるAWS CDKは、近年の構成管理で注目されています。

この記事では、Linux環境(Amazon Linux 2023想定)でのaws cdk インストールから、cdk bootstrapによる初期設定、実際にVPCスタックを作成してデプロイするまでの手順を解説します。
コマンドの実行結果には出力例(環境により異なります)を添えて、手順を追いやすくしています。

この記事のポイント

・aws cdk インストールはnpm install -g aws-cdk コマンド1本で完了する
・cdk bootstrapはCDKがデプロイ時に使うS3バケット等をAWSに作成する初期設定
・VPCスタックはTypeScriptで定義し、cdk diff→cdk deployで反映する
・Amazon Linux 2023でのNode.js準備はnvmを使うのが確実


「このままじゃマズい」と感じていませんか?
参考書を開く気力もない、同年代に取り残される不安——
でも安心してください。プロのエンジニアはコマンドを暗記していません。
「現場で使える型」を効率よく使いこなしているだけです。
姓・名・メールの3つだけ/30秒/解除は3秒 / 詳細はこちら

AWS CDKとは何か

AWS CDK(Cloud Development Kit)は、TypeScript・Python・Javaなどのプログラミング言語でAWSリソースを定義できるIaCツールです。
TerraformやCloudFormationとの大きな違いは、プログラミング言語のクラスやメソッドとしてAWSリソースを記述できる点です。

VPCの構成も、コンストラクト(Construct)と呼ばれる部品単位で宣言でき、ループや条件分岐を使った柔軟な設計が可能です。
CDKで書いたコードは最終的にCloudFormationテンプレートに変換され、AWSにデプロイされます。

「TerraformはあるのになぜCDKが必要か」と疑問に思う方もいます。
CDKの強みは、プログラミング言語の抽象化を活かしてコンストラクトを再利用できる点にあります。
同じVPC構成を複数の環境に適用したい場合、コードで部品化できるためDRY原則を守りやすくなります。

前提条件: Node.jsのインストール

AWS CDKはNode.js上で動作します。
Amazon Linux 2023でNode.jsを管理するには、nvmを使う方法が確実です。

1. nvmのインストール

nvmはNode.jsのバージョンマネージャーです。
次のコマンドでインストールします。

# nvmをインストールする(バージョンは最新に合わせて調整する) curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash # シェルの設定を再読み込みする source ~/.bashrc

インストール後、nvmコマンドが使えることを確認します。

nvm --version

出力例(環境により異なります):

0.40.1

2. Node.jsのインストール

AWS CDKはNode.js 18以上を推奨しています。
nvmで安定版(LTS)をインストールします。

# Node.js LTS版をインストールする nvm install --lts # 有効にする nvm use --lts

バージョンを確認します。

node --version npm --version

出力例(環境により異なります):

v22.11.0 10.9.0

aws cdk インストール手順

Node.jsの準備ができたら、npmでAWS CDKをグローバルにインストールします。

1. グローバルインストール

npm install -g aws-cdk

インストールが完了したら、バージョンを確認します。

cdk --version

出力例(環境により異なります):

2.168.0 (build xxxxxxx)

バージョン番号が表示されればインストール完了です。

2. グローバルパッケージとプロジェクト用パッケージの使い分け

グローバルにインストールした`aws-cdk`はcdkコマンドとして利用します。
一方、各CDKプロジェクトのTypeScriptコードで参照する`aws-cdk-lib`はプロジェクトごとに`npm install aws-cdk-lib`でローカルインストールします。

この2つは役割が異なります。
・aws-cdk(グローバル): cdkコマンド本体
・aws-cdk-lib(ローカル): TypeScriptコードでAWSリソースを定義するライブラリ

混同しやすいポイントなので、最初に押さえておいてください。

AWS CDKの初期設定

1. AWS CLIの設定確認

CDKを使うには、デプロイ先AWSアカウントへの認証情報が必要です。
AWS CLIのプロファイルが設定済みかを確認します。

aws sts get-caller-identity

出力例(環境により異なります):

{ "UserId": "AIDA...", "Account": "123456789012", "Arn": "arn:aws:iam::123456789012:user/deploy-user" }

アカウントIDとIAMユーザーが表示されればAWS CLIの認証情報は正常です。
エラーが出る場合は`aws configure`で認証情報を設定します。 AWSのLinux環境構築をより体系的に学びたい方は、Amazon LinuxでAWSのLinux環境構築を学ぶも参考にしてください。

2. cdk bootstrapの実行

cdk bootstrapは、CDKがデプロイ時に使うS3バケットやIAMロール等をAWSアカウント・リージョンに作成するコマンドです。
1つのAWSアカウント×リージョンの組み合わせに対して、原則1回だけ実行します。

# アカウントIDとリージョンを指定してブートストラップを実行する cdk bootstrap aws://123456789012/ap-northeast-1

出力例(環境により異なります):

Bootstrapping environment aws://123456789012/ap-northeast-1... Trusted accounts for deployment: (none) Using default execution policy of 'arn:aws:iam::aws:policy/AdministratorAccess' CDKToolkit: creating CloudFormation changeset... Environment aws://123456789012/ap-northeast-1 bootstrapped.

「bootstrapped」と表示されれば初期設定は完了です。

cdk bootstrapを実行しないままcdk deployを試みると、「This CDK deployment requires bootstrap」のエラーが出ます。
インストール直後はcdk bootstrapを忘れずに実行してください。

VPCスタックのプロジェクトを作成する

1. プロジェクトディレクトリの作成と初期化

CDKプロジェクトはcdk initコマンドで初期化します。
TypeScriptで作成する手順を説明します。

# プロジェクト用ディレクトリを作成する mkdir my-vpc-stack && cd my-vpc-stack # TypeScriptテンプレートでCDKプロジェクトを初期化する cdk init app --language typescript

出力例(環境により異なります):

Applying project template app for typescript # Welcome to your CDK TypeScript project ... All done!

2. 生成されたファイルの構成

cdk initで次のようなファイルが生成されます。

my-vpc-stack/ ├── bin/ │ └── my-vpc-stack.ts # エントリーポイント(AppとStackを紐付ける) ├── lib/ │ └── my-vpc-stack-stack.ts # スタック本体のコードを書く場所 ├── cdk.json # CDK設定ファイル ├── package.json └── tsconfig.json

スタックの定義は`lib/my-vpc-stack-stack.ts`に記述します。

3. aws-cdk-libのインストール

npm install aws-cdk-lib constructs

VPCスタックのコードを書く

1. VPCスタックの定義

`lib/my-vpc-stack-stack.ts`を次のように編集します。

import * as cdk from 'aws-cdk-lib'; import { aws_ec2 as ec2 } from 'aws-cdk-lib'; import { Construct } from 'constructs'; export class MyVpcStackStack extends cdk.Stack { constructor(scope: Construct, id: string, props?: cdk.StackProps) { super(scope, id, props); // VPCを作成する(マルチAZ・パブリック・プライベートサブネット) new ec2.Vpc(this, 'MyVpc', { maxAzs: 2, // 使用するアベイラビリティゾーン数 natGateways: 1, // NATゲートウェイの数 subnetConfiguration: [ { cidrMask: 24, name: 'Public', subnetType: ec2.SubnetType.PUBLIC, }, { cidrMask: 24, name: 'Private', subnetType: ec2.SubnetType.PRIVATE_WITH_EGRESS, }, ], }); } }

`maxAzs: 2`でマルチAZ構成になります。
`subnetConfiguration`でパブリックサブネットとプライベートサブネットの両方を定義しています。

L2コンストラクト(`ec2.Vpc`)を使うことで、ルートテーブルやインターネットゲートウェイの関連付けなど、VPCに必要な付属リソースもCDKが自動生成します。

2. エントリーポイントへのenv設定

デプロイ先のアカウントとリージョンを明示するため、`bin/my-vpc-stack.ts`を次のように編集します。

import * as cdk from 'aws-cdk-lib'; import { MyVpcStackStack } from '../lib/my-vpc-stack-stack'; const app = new cdk.App(); new MyVpcStackStack(app, 'MyVpcStackStack', { env: { account: process.env.CDK_DEFAULT_ACCOUNT, region: process.env.CDK_DEFAULT_REGION, }, });

差分確認とデプロイ

1. TypeScriptのビルド確認

npm run build

エラーなく終了すれば構文に問題はありません。

2. 差分確認(cdk diff)

実際にデプロイする前に、どのリソースが作成・変更されるかを確認します。

cdk diff

出力例(環境により異なります):

Stack MyVpcStackStack IAM Statement Changes ... Resources [+] AWS::EC2::VPC MyVpc/Resource ... [+] AWS::EC2::Subnet MyVpc/PublicSubnet1/Subnet ... [+] AWS::EC2::Subnet MyVpc/PublicSubnet2/Subnet ... [+] AWS::EC2::Subnet MyVpc/PrivateSubnet1/Subnet ... [+] AWS::EC2::Subnet MyVpc/PrivateSubnet2/Subnet ... ...

`[+]`は新規作成されるリソースです。
作成されるリソースを事前に把握してからデプロイするのが確実です。

3. デプロイ(cdk deploy)

cdk deploy

IAMポリシーの変更確認が出た場合は`y`を入力して続行します。
デプロイ完了後、AWSコンソールのVPCページで作成されたリソースを確認してください。

作成したリソースを削除する場合は`cdk destroy`を実行します。
検証用の環境は、使い終わったら`cdk destroy`で削除しておくと余分なコストを防げます。

トラブルシュート・よくあるエラー

「cdk: command not found」が出た場合

nvmでNode.jsをインストールした場合、シェルセッションを新しく開いたときにnvmのパスが読み込まれていないことがあります。
次のコマンドで設定を再読み込みしてから、再度試してください。

# nvmの設定を再読み込みする source ~/.bashrc # グローバルインストールされたcdkの場所を確認する npm list -g aws-cdk

「You must specify your account/region」が出た場合

cdk deployやcdk diffを実行する際に、アカウントIDとリージョンが解決できていない状態です。
bin/以下のエントリーポイントファイルでenvを明示的に指定します(前のセクション「エントリーポイントへのenv設定」参照)。

または、シェルの環境変数として直接指定する方法もあります。

export CDK_DEFAULT_ACCOUNT=123456789012 export CDK_DEFAULT_REGION=ap-northeast-1

「CDKToolkit stack version 'N' is not compatible」が出た場合

CDKのバージョンアップ後にブートストラップが古くなっているサインです。
再度`cdk bootstrap`を実行してCDKToolkitスタックを更新します。

cdk bootstrap aws://アカウントID/ap-northeast-1

「EACCES: permission denied, mkdir」が出た場合

nvmを使わずにシステム側のNode.jsで`npm install -g`を実行した場合に発生します。
nvmで管理したNode.jsで実行するか、次のように明示的にnvmのnpmを指定します。

# nvmのnpmを使っているか確認する which npm # 期待値: /home/ユーザー名/.nvm/versions/node/vxx.xx.x/bin/npm

本記事のまとめ

やりたいこと コマンド
Node.jsをインストールする(nvm経由) nvm install --lts && nvm use --lts
AWS CDKをインストールする npm install -g aws-cdk
CDKのバージョンを確認する cdk --version
AWS環境を初期化する cdk bootstrap aws://アカウントID/リージョン
CDKプロジェクトを作成する cdk init app --language typescript
変更内容を確認する cdk diff
AWSにデプロイする cdk deploy
作成したリソースを削除する cdk destroy
現場で通用する安全なLinuxサーバー構築の「型」を体系的に身につけたい方へ、

AWS CDKを使ったインフラ管理もLinuxの基礎力があってこそ安定します。
コマンドの意味・権限・ネットワークの仕組みから体系的に学べる、Amazon Linux対応のAWS入門コースをまとめています。

>>Amazon LinuxでAWSのLinux環境構築を学ぶ

無料メルマガで学習を続ける

Linuxの実践スキルをメールで毎週お届け。
登録は30秒、解除もいつでも可。

登録無料・いつでも解除できます

暗記不要・1時間後にはサーバーが動く

3,100名以上が実践した「型」を無料で公開中

プロのエンジニアはコマンドを暗記していません。
「現場で使える型」を効率よく使いこなしているだけです。
その「型」を図解60Pにまとめた入門マニュアルを、完全無料でプレゼントしています。

姓・名・メールの3つだけ/30秒/解除は3秒 / 詳細はこちら

Linux無料マニュアル(図解60P) 名前とメールで30秒登録

運営

リナックスマスター.JP(代表 宮崎智広)

株式会社イーネットマーキュリーが運営するLinux教育サイトです。代表の宮崎智広は現役のLinuxサーバー管理者として20年以上の実務経験を持ち、累計3,100名以上のエンジニアを指導してきました。実践型のLinuxセミナーや無料マニュアルの配布を通じてLinux人材の育成に取り組んでいます。