cdk synthesize - AWS Cloud Development Kit (AWS CDK) V2

這是 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 堆疊邏輯識別碼

從您的應用程序進行合成的 CDK 堆棧的邏輯 ID。

類型:字串

必要:否

選項

如需與所有 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

範例

使用 logial ID 為 CDK 堆棧合成雲程序集, MyStackName 並將模板輸出到標準輸出 CloudFormation

$ cdk synth MyStackName

為 CDK 應用程序中的所有堆棧合成雲程序集並將其保存到 cdk.out 中

$ cdk synth

合成雲程序集 MyStackName,但不包括依賴關係

$ cdk synth MyStackName --exclusively

合成雲程序集 MyStackName,但不要將 CloudFormation 模板輸出到標準輸出

$ cdk synth MyStackName --quiet