

這是 AWS CDK v2 開發人員指南。較舊的 CDK v1 已於 2022 年 6 月 1 日進入維護，並於 2023 年 6 月 1 日結束支援。

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# `cdk synthesize`
<a name="ref-cli-cmd-synth"></a>

合成 CDK 應用程式以產生雲端組件，包括每個堆疊的 an AWS CloudFormation 範本。

雲端組件是包含將應用程式部署至 AWS 環境所需的一切檔案。例如，它包含應用程式中每個堆疊的 CloudFormation 範本，以及您在應用程式中參考的檔案資產或 Docker 映像的副本。

如果您的應用程式包含單一堆疊，或提供單一堆疊做為引數，CloudFormation 範本也會以 YAML 格式顯示在標準輸出 (`stdout`) 中。

如果您的應用程式包含多個堆疊， `cdk synth`會將雲端組件合成為 `cdk.out`。

## 使用方式
<a name="ref-cli-cmd-synth-usage"></a>

```
cdk synthesize <arguments> <options>
```

## 引數
<a name="ref-cli-cmd-synth-args"></a><a name="ref-cli-cmd-synth-args-stack-name"></a>

 **CDK 堆疊 ID**   
要合成之應用程式中 CDK 堆疊的建構 ID。  
 *類型：*字串  
 *必要*：否

## 選項
<a name="ref-cli-cmd-synth-options"></a>

如需適用於所有 CDK CLI 命令的全域選項清單，請參閱[全域選項](ref-cli-cmd.md#ref-cli-cmd-options)。<a name="ref-cli-cmd-synth-options-exclusively"></a>

 `--exclusively, -e <BOOLEAN>`   
僅合成請求的堆疊，不包含相依性。<a name="ref-cli-cmd-synth-options-help"></a>

 `--help, -h <BOOLEAN>`   
顯示命令的`cdk synthesize`命令參考資訊。<a name="ref-cli-cmd-synth-options-quiet"></a>

 `--quiet, -q <BOOLEAN>`   
請勿將 CloudFormation 範本輸出至 `stdout`。  
此選項可在 CDK 專案的 `cdk.json`檔案中設定。以下是範例：  

```
{
   "quiet": true
}
```
 *預設值*：`false`<a name="ref-cli-cmd-synth-options-validation"></a>

 `--validation <BOOLEAN>`   
執行其他檢查，在合成後驗證產生的 CloudFormation 範本。  
您也可以透過 `validateOnSynth` 屬性或`CDK_VALIDATION`環境變數來設定此選項。  
 *預設值*：`true`

## 範例
<a name="ref-cli-cmd-synth-examples"></a>

### 使用邏輯 ID MyStackName 合成 CDK 堆疊的雲端組件，並將 CloudFormation 範本輸出至 stdout
<a name="ref-cli-cmd-synth-examples-1"></a>

```
$ cdk synth MyStackName
```

### 合成 CDK 應用程式中所有堆疊的雲端組件，並將其儲存至 cdk.out
<a name="ref-cli-cmd-synth-examples-2"></a>

```
$ cdk synth
```

### 合成 MyStackName 的雲端組件，但不包含相依性
<a name="ref-cli-cmd-synth-examples-3"></a>

```
$ cdk synth MyStackName --exclusively
```

### 合成 MyStackName 的雲端組件，但不要將 CloudFormation 範本輸出至 stdout
<a name="ref-cli-cmd-synth-examples-4"></a>

```
$ cdk synth MyStackName --quiet
```