aws-cdk-python-setup

AWS CDK Python セットアップ手順

このスキルでは、Python を使用して AWS CDK（Cloud Development Kit） プロジェクトに取り組むためのセットアップ方法を説明します。

---

前提条件

開始する前に、以下のツールがインストールされていることを確認してください。

• Node.js ≥ 14.15.0 — AWS CDK CLI に必要です
• Python ≥ 3.7 — CDK コードの記述に使用します
• AWS CLI — 認証情報とリソースを管理します
• Git — バージョン管理とプロジェクト管理に使用します

---

インストール手順

1. AWS CDK CLI をインストールする

npm install -g aws-cdk
cdk --version

2. AWS 認証情報を設定する

# Install AWS CLI (if not installed)
brew install awscli

# Configure credentials
aws configure

プロンプトに従って、AWS アクセスキー、シークレットアクセスキー、デフォルトリージョン、出力形式を入力してください。

3. 新しい CDK プロジェクトを作成する

mkdir my-cdk-project
cd my-cdk-project
cdk init app --language python

プロジェクトには以下が含まれます。

• app.py — メインアプリケーションのエントリーポイント
• my_cdk_project/ — CDK スタックの定義
• requirements.txt — Python の依存関係
• cdk.json — 設定ファイル

4. Python 仮想環境をセットアップする

# macOS/Linux
source .venv/bin/activate

# Windows
.venv\Scripts\activate

5. Python の依存関係をインストールする

pip install -r requirements.txt

主な依存関係：

• aws-cdk-lib — CDK のコアコンストラクト
• constructs — 基本コンストラクトライブラリ

---

開発ワークフロー

CloudFormation テンプレートを合成する

cdk synth

CloudFormation テンプレートを含む cdk.out/ を生成します。

AWS にスタックをデプロイする

cdk deploy

設定済みの AWS アカウントへのデプロイ内容を確認し、承認します。

ブートストラップ（初回デプロイ時のみ）

cdk bootstrap

アセット保存用の S3 バケットなど、環境リソースを準備します。

---

ベストプラクティス

• 作業を始める前に、必ず仮想環境を有効化してください。
• デプロイ前に cdk diff を実行して、変更内容を確認してください。
• テストには開発用アカウントを使用してください。
• Python らしい命名規則とディレクトリ構成に従ってください。
• ビルドの一貫性を保つため、requirements.txt のバージョンを固定してください。

---

トラブルシューティングのヒント

問題が発生した場合は、以下を確認してください。

• AWS 認証情報が正しく設定されていること。
• デフォルトリージョンが適切に設定されていること。
• Node.js と Python のバージョンが最小要件を満たしていること。
• cdk doctor を実行して、環境の問題を診断してください。