これは AWS CDK v2 デベロッパーガイドです。古い v1 CDK は 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