开始使用 AWS CDK - AWS 云开发工具包 (AWS CDK) v2

这是 AWS CDK v2 开发人员指南。旧版 CDK v1 于 2022 年 6 月 1 日进入维护阶段,并于 2023 年 6 月 1 日终止支持。

开始使用 AWS CDK

通过安装和配置 AWS CDK 命令行界面 (AWS CDK CLI) 开始使用 AWS 云开发工具包 (AWS CDK)。然后,使用 CDK CLI 创建第一个 CDK 应用程序,引导 AWS 环境并部署应用程序。

先决条件

在开始使用 AWS CDK 之前,请满足所有先决条件。对于不熟悉 AWS 或不熟悉编程的用户来说,这些先决条件是必需的。有关说明,请参阅 AWS CDK 先决条件

我们建议您对什么是 AWS CDK 有了基本的了解。有关更多信息,请参阅什么是 AWS CDK?了解 AWS CDK 核心概念

安装 AWS CDK CLI

使用 Node 程序包管理器安装 CDK CLI。我们建议您使用以下命令进行全局安装:

$ npm install -g aws-cdk

要安装 CDK CLI 的特定版本,请使用以下命令结构:

$ npm install -g aws-cdk@X.YY.Z

如果要使用多个版本的 AWS CDK,请考虑在各个 CDK 项目中安装匹配版本的 CDK CLI。为此,请从 npm install 命令中删除 -g 选项。然后,使用 npx aws-cdk 调用 CDK CLI。这将运行本地版本(如有)。否则,将使用全局安装的版本。

排查 CDK CLI 安装问题

如果遇到权限错误,并且在系统上拥有管理员访问权限,请运行以下命令:

$ sudo npm install -g aws-cdk

如果收到错误消息,请运行以下命令以尝试卸载 CDK CLI:

$ npm uninstall -g aws-cdk

然后,重复步骤以重新安装 CDK CLI。

验证 CDK CLI 安装是否成功

运行以下命令,以验证安装是否成功。AWS CDK CLI 应输出版本号:

$ cdk --version

配置 AWS CDK CLI

安装 CDK CLI 后,您可以开始使用它在本地机器上开发应用程序。要与 AWS 交互(例如部署应用程序时),您必须在本地机器上配置安全凭证,该凭证应拥有执行您启动的任何操作的权限。

要在本地机器上配置安全凭证,应使用 AWS CLI。如何配置安全凭证取决于您如何管理用户。有关说明,请参阅《AWS 命令行界面用户指南》中的身份验证和访问凭证

CDK CLI 将自动使用您使用 AWS CLI 配置的安全凭证。例如,如果您是 IAM Identity Center 用户,则可以使用 aws configure sso 命令配置安全凭证。如果您是 IAM 用户,则可以使用 aws configure 命令。AWS CLI 将指导您在本地机器上配置安全凭证,并将必要信息保存在 configcredentials 文件中。然后,当您使用 CDK CLI 时(例如使用 cdk deploy 部署应用程序时),CDK CLI 将使用您配置的安全凭证。

与 AWS CLI 一样,CDK CLI 将默认使用 default 配置文件。您可以使用 CDK CLI --profile 选项指定配置文件。有关将安全凭证与 CDK CLI 结合使用的更多信息,请参阅为 AWS CDK CLI 配置安全凭证

(可选)安装其他 AWS CDK 工具

AWS Toolkit for Visual Studio Code 是适用于 Visual Studio Code 的开源插件,有助于您在 AWS 上创建、调试和部署应用程序。该工具包针对开发 AWS CDK 应用程序提供了集成体验。其包含 AWS CDK Explorer 功能,可用于列出您的 AWS CDK 项目并浏览 CDK 应用程序的各种组件。有关说明,请参阅:

创建第一个 CDK 应用程序

现在您可以通过创建第一个 CDK 应用程序开始使用 AWS CDK 了。有关说明,请参阅教程:创建第一个 AWS CDK 应用程序