AWS CDK CLI 命令参考 - AWS Cloud Development Kit (AWS CDK) v2
使用量命令全球期权提供和配置选项在命令行传递选项

这是 AWS CDK v2 开发者指南。较旧的 CDK v1 于 2022 年 6 月 1 日进入维护阶段，并于 2023 年 6 月 1 日终止支持。

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

AWS CDK CLI 命令参考

本节包含命令行界面 (CLI) 的 AWS Cloud Development Kit (AWS CDK) 命令参考信息。CDK 也CLI被称为 CDK 工具包。

使用量

$ cdk <command> <arguments> <options>

命令

acknowledge, ack

按问题编号确认通知，然后将其隐藏，以免再次显示。

bootstrap

通过将 CDK 引导堆栈（名为）部署到 AWS 环境中CDKToolkit，为 CDK 部署做好准备。 AWS

context

管理 CDK 应用程序的缓存上下文值。

deploy

将一个或多个 CDK 堆栈部署到您的 AWS 环境中。

destroy

从您的 AWS 环境中删除一个或多个 CDK 堆栈。

diff

执行差异以查看 CDK 堆栈之间的基础架构变化。

docs, doc

在浏览器中打开 CDK 文档。

doctor

检查并显示有关您的本地 CDK 项目和开发环境的有用信息。

import

使用 AWS CloudFormation 资源导入将现有 AWS 资源导入 CDK 堆栈。

init

使用模板创建新的 CDK 项目。

list, ls

列出 CDK 应用程序中的所有 CDK 堆栈及其依赖关系。

metadata

显示与 CDK 堆栈关联的元数据。

migrate

将 AWS 资源、 AWS CloudFormation 堆栈和 AWS CloudFormation 模板迁移到新的 CDK 项目中。

notices

显示您的 CDK 应用程序的通知。

synthesize, synth

合成 CDK 应用程序以生成云程序集，包括每个堆栈的 AWS CloudFormation 模板。

watch

持续关注本地 CDK 项目是否有更改以执行部署和热交换。

全球期权

以下选项与所有 CDK CLI 命令兼容。

--app, -a STRING

提供用于运行应用程序或云程序集目录的命令。

必需：是

--asset-metadata BOOLEAN

包括使用资产的资源的aws:asset:* AWS CloudFormation 元数据。

必需：否

默认值：true

--build STRING

用于运行合成前版本的命令。

必需：否

--ca-bundle-path STRING

验证 HTTPS 请求时要使用的 CA 证书的路径。

如果未提供此选项，CDK CLI 将从AWS_CA_BUNDLE环境变量中读取。

必需：是

--ci BOOLEAN

表明 CDK CLI 命令正在持续集成 (CI) 环境中运行。

此选项修改 CDK 的行为，CLI以更好地适应 CI 管道中常见的自动化操作。

当您提供此选项时，日志将发送到stdout而不是stderr。

必需：否

默认值：false

--context, -c ARRAY

将上下文字符串参数添加为键值对。

--debug BOOLEAN

启用详细的调试信息。此选项会生成详细输出，其中包含有关 CDK CLI 在幕后所做的事情的更多细节。

必需：否

默认值：false

--ec2creds, -i BOOLEAN

强制 CDK CLI 尝试获取 Amazon EC2 实例证书。

默认情况下，CDK 会CLI猜测 Amazon EC2 实例的状态。

必需：否

默认值：false

--help, -h BOOLEAN

显示 CDK CLI 的命令参考信息。

必需：否

默认值：false

--ignore-errors BOOLEAN

忽略合成错误，这可能会产生无效的输出。

必需：否

默认值：false

--json, -j BOOLEAN

对于打印到标准输出的 AWS CloudFormation 模板，请使用 JSON 而不是 YAML (stdout)。

必需：否

默认值：false

--lookups BOOLEAN

执行上下文查找。

如果此值为，false并且需要执行上下文查找，则合成将失败。

必需：否

默认值：true

--no-color BOOLEAN

从控制台输出中删除颜色和其他样式。

必需：否

默认值：false

--notices BOOLEAN

显示相关通知。

必需：否

默认值：false

--output, -o STRING

指定要将合成云集输出到的目录。

必需：是

默认值：cdk.out

--path-metadata BOOLEAN

包括每种资源的aws::cdk::path AWS CloudFormation 元数据。

必需：否

默认值：true

--plugin, -p ARRAY

扩展 CDK 功能的node软件包的名称或路径。可以在单个命令中多次提供此选项。

您可以在项目cdk.json文件中或本地开发计算机~/.cdk.json上配置此选项：

{
   // ...
   "plugin": [
      "module_1",
      "module_2"
   ],
   // ...
}

必需：否

--profile STRING

指定要与 CDK CLI 一起使用的 AWS 配置文件的名称，其中包含您的 AWS 环境信息。

必需：是

--proxy STRING

使用指定的代理。

如果未提供此选项，CDK CLI 将从HTTPS_PROXY环境变量中读取。

必需：是

默认值：从HTTPS_PROXY环境变量读取。

--role-arn, -r STRING

CDK 在与之交互时CLI将担任的 IAM 角色的 ARN。 AWS CloudFormation

必需：否

--staging BOOLEAN

将资源复制到输出目录。

指定false以防止将资源复制到输出目录。这 AWS SAM CLI允许在执行本地调试时引用原始源文件。

必需：否

默认值：true

--strict BOOLEAN

不要构造包含警告的堆栈。

必需：否

默认值：false

--trace BOOLEAN

打印堆栈警告的跟踪。

必需：否

默认值：false

--verbose, -v COUNT

显示调试日志。您可以多次指定此选项以增加详细程度。

必需：否

--version BOOLEAN

显示 CDK CLI 版本号。

必需：否

默认值：false

--version-reporting BOOLEAN

将AWS::CDK::Metadata资源包含在合成 AWS CloudFormation 模板中。

必需：否

默认值：true

提供和配置选项

你可以通过命令行参数传递选项。对于大多数选项，您可以在配置文件中对其进行cdk.json配置。当您使用多个配置源时，CDK 会CLI遵循以下优先级：

  1. 命令行值-命令行中提供的任何选项都会覆盖文件中配置的选项。cdk.json

  2. 项目配置文件-CDK 项目目录中的cdk.json文件。

  3. 用户配置文件-位于本地计算机~/.cdk.json上的cdk.json文件。

在命令行传递选项

传递布尔值

对于接受布尔值的选项，您可以通过以下方式进行指定：

  • 使用true和false值-在命令中提供布尔值。以下是 示例：

    $ cdk deploy --watch=true
$ cdk deploy --watch=false

  • 提供选项的对应项-通过添加指定false值no来修改选项名称。以下是 示例：

    $ cdk deploy --watch
$ cdk deploy --no-watch

  • 对于默认为true或的选项false，除非要更改默认选项，否则不必提供该选项。