cdk diff - AWS Cloud Development Kit (AWS CDK) v2
使用方法引数オプション例

これは AWS CDK v2 デベロッパーガイドです。古い CDK v1 は 2022 年 6 月 1 日にメンテナンスを開始し、2023 年 6 月 1 日にサポートを終了しました。

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

cdk diff

差分を実行して、 AWS CDK スタック間のインフラストラクチャの変更を確認します。

このコマンドは通常、ローカル CDK アプリのスタックの現在の状態とデプロイされたスタックの違いを比較するために使用されます。ただし、デプロイされたスタックを任意のローカル AWS CloudFormation テンプレートと比較することもできます。

使用方法

$ cdk diff <arguments> <options>

引数

CDK スタック論理 ID

差分を実行するアプリケーションからの CDK スタックの論理 ID。

タイプ: 文字列

必須: いいえ

オプション

すべての CDK CLI コマンドで動作するグローバルオプションのリストについては、「」を参照してくださいグローバルオプション。

--change-set BOOLEAN

リソースの置換を分析する変更セットを作成するかどうかを指定します。

の場合true、CDK CLIは AWS CloudFormation スタックに加えられる正確な変更を表示する変更セットを作成します。この出力には、リソースを更新または置き換えるかどうかが含まれます。CDK CLIは、ルックアップロールの代わりにデプロイロールを使用してこのアクションを実行します。

の場合false、 CloudFormation テンプレートを比較することで、より速く、精度の低い差分が実行されます。リソースの置換を必要とするプロパティに対して検出された変更は、リソースリファレンスをハードコードされた ARN に置き換えるなど、純粋に変更があった場合でも、リソースの置換として表示されます。

デフォルト値: true

--context-lines NUMBER

任意の JSON 差分レンダリングに含めるコンテキスト行の数。

デフォルト値: 3

--exclusively, -e BOOLEAN

リクエストされたスタックの差分のみ、依存関係は含まれません。

--fail BOOLEAN

差異が検出され1た場合は、 のコードで失敗して終了します。

--help, -h BOOLEAN

コマンドのcdk diffコマンドリファレンス情報を表示します。

--processed BOOLEAN

CloudFormation 変換が既に処理されているテンプレートと比較するかどうかを指定します。

デフォルト値: false

--quiet, -q BOOLEAN

変更が検出されstdoutない場合は、CDK スタック名とデフォルトcdk diffメッセージを に出力しないでください。

デフォルト値: false

--security-only BOOLEAN

セキュリティの変更が拡大された場合にのみ差分があります。

デフォルト値: false

--strict BOOLEAN

cdk diff 動作をより正確または厳密に変更します。true の場合、CDK CLIはAWS::CDK::Metadataリソースや読み取り不可能な非 ASCII 文字を除外しません。

デフォルト値: false

--template STRING

CDK スタックを比較する CloudFormation テンプレートへのパス。

例

という名前の現在デプロイされているスタックと異なる MyStackName

$ cdk diff MyStackName --app='node bin/main.js'

特定の CloudFormation テンプレートとの差分

$ cdk diff MyStackName --app='node bin/main.js' --template-path='./MyStackNameTemplate.yaml'

ローカルスタックとデプロイされたスタックを区別します。変更が検出されない場合、stdout に出力しない

$ cdk diff MyStackName --app='node bin/main.js' --quiet