これは AWS CDK v2 デベロッパーガイドです。古い CDKv1 は 2022 年 6 月 1 日にメンテナンスを開始し、2023 年 6 月 1 日にサポートを終了しました。
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
cdk synthesize
CDK アプリを合成して、各スタックの AWS CloudFormation テンプレートを含むクラウドアセンブリを作成します。
クラウドアセンブリは、アプリケーションを AWS 環境にデプロイするために必要なものをすべて含むファイルです。例えば、アプリ内の各スタックの CloudFormation テンプレートと、アプリで参照するファイルアセットまたはDockerイメージのコピーが含まれます。
アプリケーションに 1 つのスタックが含まれている場合、または 1 つのスタックが引数として指定されている場合、 CloudFormation テンプレートは標準出力 (stdout
) にも YAML 形式で表示されます。
アプリケーションに複数のスタックが含まれている場合、 cdk synth
はクラウドアセンブリを に合成しますcdk.out
。
使用方法
$
cdk synthesize
<arguments>
<options>
引数
- CDK スタック論理 ID
-
合成するアプリケーションからの 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
例
ログ ID を使用して CDK スタックのクラウドアセンブリを合成 MyStackName し、 CloudFormation テンプレートを stdout に出力します。
$
cdk synth MyStackName
CDK アプリ内のすべてのスタックのクラウドアセンブリを合成し、cdk.out に保存します。
$
cdk synth
のクラウドアセンブリを合成しますが MyStackName、依存関係は含まれません
$
cdk synth MyStackName --exclusively
のクラウドアセンブリを合成しますが MyStackName、 CloudFormation テンプレートを stdout に出力しないでください。
$
cdk synth MyStackName --quiet