これは AWS CDK v2 デベロッパーガイドです。旧版の CDK v1 は 2022 年 6 月 1 日にメンテナンスを開始し、2023 年 6 月 1 日にサポートを終了しました。
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
# `cdk synthesize`
CDK アプリを合成し、各スタックの AWS CloudFormation テンプレートを含むクラウドアセンブリを作成します。
クラウドアセンブリは、アプリを AWS 環境にデプロイするために必要なすべてを含むファイルです。例えば、アプリ内の各スタックの CloudFormation テンプレート、ならびにアプリで参照するファイルアセットまたは Docker イメージのコピーが含まれます。
アプリに 1 つのスタックが含まれている場合、あるいは 1 つのスタックが引数として提供されている場合、CloudFormation テンプレートは YAML 形式で標準出力 (`stdout`) にも表示されます。
アプリに複数のスタックが含まれている場合、`cdk synth` はクラウドアセンブリを `cdk.out` に合成します。
## 使用
```
cdk synthesize
```
## 引数
**CDK スタック ID**
合成するアプの CDK スタックのコンストラクト ID。
*タイプ*: 文字列
*必須:* いいえ
## オプション
すべての CDK CLI コマンドで動作するグローバルオプションのリストについては、「[グローバルオプション](ref-cli-cmd.md#ref-cli-cmd-options)」を参照してください。
`--exclusively, -e `
要求されたスタックのみを合成し、依存関係を含めないでください。
`--help, -h `
`cdk synthesize` コマンドのコマンドリファレンス情報を表示します。
`--quiet, -q `
CloudFormation テンプレートを `stdout` に出力しないでください。
このオプションは、CDK プロジェクトの `cdk.json` ファイルで設定できます。以下に例を示します。
```
{
"quiet": true
}
```
*デフォルト値*: `false`
`--validation `
追加のチェックを実行し、合成後に生成された CloudFormation テンプレートを検証します。
`validateOnSynth` 属性または `CDK_VALIDATION` 環境変数を使用してこのオプションを設定することもできます。
*デフォルト値*: `true`
## 例
### 論理 ID MyStackName を使用して CDK スタックのクラウドアセンブリを合成し、CloudFormation テンプレートを stdout に出力します。
```
$ cdk synth MyStackName
```
### CDK アプリ内のすべてのスタックのクラウドアセンブリを合成し、cdk.out に保存します。
```
$ cdk synth
```
### MyStackName のクラウドアセンブリを合成しますが、依存関係は含めないでください
```
$ cdk synth MyStackName --exclusively
```
### MyStackName のクラウドアセンブリを合成しますが、CloudFormation テンプレートを stdout に出力しないでください
```
$ cdk synth MyStackName --quiet
```