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 Access Key、Secret Access Key、默认区域和输出格式。

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 账户。

Bootstrap（仅首次部署）

cdk bootstrap

准备环境资源，例如用于资产存储的 S3 存储桶。

---

最佳实践

• 在开始工作前始终激活虚拟环境。
• 在部署前运行 cdk diff 以预览更改。
• 使用开发账户进行测试。
• 遵循 Pythonic 命名和目录约定。
• 保持 requirements.txt 锁定版本以确保构建一致。

---

故障排除提示

如果出现问题，请检查：

• AWS 凭证已正确配置。
• 默认区域已正确设置。
• Node.js 和 Python 版本满足最低要求。
• 运行 cdk doctor 以诊断环境问题。