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

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

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

cdk watch

ローカル AWS CDK プロジェクトにデプロイとホットスワップを実行するための変更がないか継続的に監視します。

このコマンドは に似ていますがcdk deploy、1 つのコマンドで継続的なデプロイとホットスワップを実行できます。

このコマンドは のショートカットですcdk deploy --watch。

cdk watch セッションを終了するには、 を押してプロセスを中断しますCtrl+C。

観察されるファイルは、cdk.jsonファイル内の "watch"設定によって決まります。1 つの文字列または文字列の配列"exclude"を受け入れる "include"と の 2 つのサブキーがあります。各エントリは、cdk.jsonファイルの場所を基準にしたパスとして解釈されます。* と の両方**が受け入れられます。

cdk init コマンドを使用してプロジェクトを作成する場合、プロジェクトの cdk.json ファイルcdk watchで に対して次のデフォルトの動作が設定されます。

  • "include" は に設定され"**/*"、プロジェクトのルート内のすべてのファイルとディレクトリが含まれます。

  • "exclude" はオプションです。ただし、デフォルトで既に無視されているファイルとフォルダを除きます。これは、、CDK 出力ディレクトリ.、および ディレクトリで始まるファイルとnode_modulesディレクトリで構成されます。

設定する最小設定は watchです"watch": {}。

CDK コードまたはアプリケーションコードのいずれかがデプロイ前にビルドステップを必要とする場合、 cdk watch は cdk.json ファイル内の "build" キーを使用します。

注記

このコマンドは実験的と見なされ、将来的に重大な変更が生じる可能性があります。

にも同じ制限cdk deploy --hotswapが適用されますcdk watch。詳細については、「cdk deploy --hotswap」を参照してください。

使用方法

$ cdk watch <arguments> <options>

引数

CDK スタック論理 ID

監視するアプリケーションからの CDK スタックの論理 ID。

タイプ: 文字列

必須: いいえ

オプション

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

--build-exclude, -E ARRAY

指定された ID でアセットを再構築しないでください。

このオプションは、1 つのコマンドで複数回指定できます。

デフォルト値: []

--change-set-name STRING

作成する CloudFormation 変更セットの名前。

--concurrency NUMBER

スタック間の依存関係を考慮しながら、複数のスタックを並行してデプロイしてホットスワップします。デプロイを高速化するには、このオプションを使用します。その他の AWS アカウント レート制限 CloudFormation も考慮する必要があります。

実行する同時デプロイの最大数 (依存関係の許可) を指定する数値を指定します。

デフォルト値: 1

--exclusively, -e BOOLEAN

リクエストされたスタックのみをデプロイし、依存関係は含まれません。

--force, -f BOOLEAN

テンプレートが同じであっても、常にスタックをデプロイします。

デフォルト値: false

--help, -h BOOLEAN

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

--hotswap BOOLEAN

デフォルトでは、 cdk watchは可能な場合はホットスワップデプロイを使用してリソースを更新します。CDK CLIはホットスワップデプロイの実行を試み、失敗してもフル CloudFormation デプロイにフォールバックしません。ホットスワップで更新できない変更は無視されます。

デフォルト値: true

--hotswap-fallback BOOLEAN

デフォルトでは、 はホットスワップデプロイの実行cdk watchを試み、 CloudFormation デプロイを必要とする変更を無視します。ホットスワップ CloudFormation デプロイが失敗した場合に--hotswap-fallbackフォールバックして完全なデプロイを実行するには、 を指定します。

--logs BOOLEAN

デフォルトでは、 はアプリケーション内のすべての CloudWatch ロググループをcdk watchモニタリングし、ログイベントを にローカルにストリーミングしますstdout。

デフォルト値: true

--progress STRING

CDK がデプロイの進行状況CLIを表示する方法を設定します。

  • bar — スタックデプロイイベントを進行状況バーとして表示し、リソースのイベントは現在デプロイされています。

  • events – すべての CloudFormation イベントを含む完全な履歴を提供します。

このオプションは、プロジェクトの cdk.json ファイルまたはローカル開発マシンの ~/.cdk.json で設定することもできます。

{
   "progress": "events"
}

有効な値:bar、events|

デフォルト値: bar

--rollback BOOLEAN

デプロイ中にリソースの作成または更新に失敗した場合、デプロイは CDK がCLI戻る前に最新の安定状態にロールバックされます。その時点までに行われたすべての変更は元に戻されます。作成されたリソースは削除され、更新はロールバックされます。

--no-rollback または -Rを使用して、この動作を無効にします。リソースの作成または更新に失敗した場合、CDK CLI はその時点までに行われた変更をそのままにして、 を返します。これは、すぐに反復する開発環境で役立つ場合があります。

注記

の場合false、リソースの置換を引き起こすデプロイは常に失敗します。この値は、新しいリソースを更新または作成するデプロイにのみ使用できます。

デフォルト値: true

--toolkit-stack-name STRING

既存の CDK Toolkit スタックの名前。

このオプションは、レガシー合成を使用する CDK アプリケーションにのみ使用されます。

例

論理 ID を持つ CDK スタックの変更 DevelopmentStack を監視する

$ cdk watch DevelopmentStack
Detected change to 'lambda-code/index.js' (type: change). Triggering 'cdk deploy'
DevelopmentStack: deploying...

 ✅  DevelopmentStack

変更をモニタリングする対象と除外する対象について cdk.json ファイルを設定する

{
   "app": "mvn -e -q compile exec:java",
   "watch": {
    "include": "src/main/**",
    "exclude": "target/*"
   }
}

cdk.json ファイルを設定して、デプロイJava前に を使用して CDK プロジェクトを構築する

{
  "app": "mvn -e -q exec:java",
  "build": "mvn package",
  "watch": {
    "include": "src/main/**",
    "exclude": "target/*"
  }
}