cdk synthesize - AWS Cloud Development Kit (AWS CDK) v2
使用量参数Options示例

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

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

cdk synthesize

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

云程序集是包含将应用程序部署到 AWS 环境所需的所有内容的文件。例如，它包括应用程序中每个堆栈的 CloudFormation 模板，以及您在应用程序中引用的文件资产或Docker图像的副本。

如果您的应用程序包含单个堆栈或提供单个堆栈作为参数，则 CloudFormation 模板也将以 YAML 格式显示在标准输出 (stdout) 中。

如果您的应用程序包含多个堆栈，则cdk synth会将云程序集合成到。cdk.out

使用量

$ cdk synthesize <arguments> <options>

参数

CDK 堆栈逻辑 ID

您的应用程序中要合成的 CDK 堆栈的逻辑 ID。

类型：字符串

必需：否

Options

有关适用于所有 CDK CLI 命令的全局选项的列表，请参阅全球期权。

--exclusively, -e BOOLEAN

仅合成请求的堆栈，不包括依赖关系。

--help, -h BOOLEAN

显示命令的cdk synthesize命令参考信息。

--quiet, -q BOOLEAN

不要将 CloudFormation 模板输出到stdout。

可以在 CDK 项目的cdk.json文件中配置此选项。以下是 示例：

{
   "quiet": true
}

默认值：false

--validation BOOLEAN

合成后通过执行其他检查来验证生成的 CloudFormation 模板。

您也可以通过validateOnSynth属性或CDK_VALIDATION环境变量配置此选项。

默认值：true

示例

合成带有逻辑 ID 的 CDK 堆栈的云组件， MyStackName 然后将模板输出到 stdout CloudFormation 

$ cdk synth MyStackName

在 CDK 应用程序中合成所有堆栈的云端程序集并将其保存到 cdk.out

$ cdk synth

合成云程序集 MyStackName，但不包括依赖关系

$ cdk synth MyStackName --exclusively

合成云程序集 MyStackName，但不要将 CloudFormation 模板输出到 stdout

$ cdk synth MyStackName --quiet