AWS CDK CLI コマンドリファレンス - AWS Cloud Development Kit (AWS CDK) v2
使用方法コマンドグローバルオプションオプションの提供と設定コマンドラインでオプションを渡す

これは AWS CDK v2 開発者ガイドです。旧版の CDK v1 は 2022 年 6 月 1 日にメンテナンスを開始し、2023 年 6 月 1 日にサポートを終了しました。

AWS CDK CLI コマンドリファレンス

このセクションでは、AWS Cloud Development Kit (AWS CDK) コマンドラインインタフェイス (CLI) のコマンドのリファレンス情報が記載されています。CDK CLI は CDK Toolkit とも呼ばれます。

使用方法

$ cdk <command> <arguments> <options>

コマンド

acknowledge, ack

発行番号で通知を確認し、再度表示しないようにします。

bootstrap

CDKToolkit という名前の CDK ブートストラップスタックを AWS 環境にデプロイし、CDK デプロイ用の AWS 環境を準備します。

context

CDK アプリケーションのキャッシュされたコンテキスト値を管理します。

deploy

AWS 環境に 1 つ以上の CDK スタックをデプロイします。

destroy

AWS 環境から 1 つ以上の CDK スタックを削除します。

diff

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

docs, doc

ブラウザで CDK ドキュメントを開きます。

doctor

ローカル CDK プロジェクトおよび開発環境に関する便利な情報の検査および表示します。

import

AWS CloudFormation リソースインポートを使用し、既存の AWS リソースを CDK スタックにインポートします。

init

テンプレートから新しい CDK プロジェクトを作成します。

list, ls

CDK アプリからのすべての CDK スタックおよびその依存関係を一覧表示します。

metadata

CDK スタックに関連付けられたメタデータを表示します。

migrate

AWS リソース、AWS CloudFormation スタック、AWS CloudFormation テンプレートを新しい CDK プロジェクトに移行します。

notices

CDK アプリケーションの通知を表示します。

synthesize, synth

CDK アプリを合成し、各スタックの AWS CloudFormation テンプレートを含むクラウドアセンブリを作成します。

watch

ローカル CDK プロジェクトの変更を継続的に監視し、デプロイおよびホットスワップを実行します。

グローバルオプション

次のオプションは、すべての CDK CLI コマンドと互換性があります。

--app, -a STRING

アプリまたはクラウドアセンブリのディレクトリを実行するコマンドを指定します。

必須: はい

--asset-metadata BOOLEAN

アセットを使用するリソースに aws:asset:* AWS CloudFormation メタデータを含めます。

必須: いいえ

デフォルト値: true

--build STRING

事前合成ビルドを実行するコマンド。

必須: いいえ

--ca-bundle-path STRING

HTTPS 要求の検証に使用する CA 証明書へのパス。

このオプションが指定されない場合、CDK CLI は AWS_CA_BUNDLE 環境変数から読み取ります。

必須: はい

--ci BOOLEAN

CDK CLI コマンドが継続的インテグレーション (CI) 環境で実行されていることを示します。

このオプションは、CI パイプラインで一般的な自動オペレーションにより適するように CDK CLI の動作を変更します。

このオプションを指定するとき、ログは stderr ではなく、stdout に送信されます。

必須: いいえ

デフォルト値: false

--context, -c ARRAY

コンテキスト文字列パラメータをキーと値のペアとして追加します。

--debug BOOLEAN

詳細なデバッグ情報を有効にします。このオプションでは、CDK CLI がバックグラウンドで行っている動作に関する詳細を含む冗長出力が生成されます。

必須: いいえ

デフォルト値: false

--ec2creds, -i BOOLEAN

CDK CLI が Amazon EC2 インスタンス認証情報の取得を試行するように強制します。

デフォルトでは、CDK CLI は Amazon EC2 インスタンスのステータスを推測します。

必須: いいえ

デフォルト値: false

--help, -h BOOLEAN

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

必須: いいえ

デフォルト値: false

--ignore-errors BOOLEAN

合成エラーは有効でない出力を生成する可能性があるため、無視してください。

必須: いいえ

デフォルト値: false

--json, -j BOOLEAN

標準出力 (stdout) に出力される AWS CloudFormation テンプレートには、YAML ではなくて JSON を使用します。

必須: いいえ

デフォルト値: false

--lookups BOOLEAN

コンテキストルックアップを実行します。

この値が false であり、コンテキスト検索を実行する必要がある場合、合成は失敗します。

必須: いいえ

デフォルト値: true

--no-color BOOLEAN

コンソール出力から色やその他のスタイルを削除します。

必須: いいえ

デフォルト値: false

--notices BOOLEAN

関連する通知を表示します。

必須: いいえ

デフォルト値: false

--output, -o STRING

合成されたクラウドアセンブリを出力するディレクトリを指定します。

必須: はい

デフォルト値: cdk.out

--path-metadata BOOLEAN

各リソースに aws::cdk::path AWS CloudFormation メタデータを含めます。

必須: いいえ

デフォルト値: true

--plugin, -p ARRAY

CDK 機能を拡張する node パッケージの名前またはパス。このオプションは、1 つのコマンドで複数回指定できます。

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

{
   // ...
   "plugin": [
      "module_1",
      "module_2"
   ],
   // ...
}

必須: いいえ

--profile STRING

CDK CLI で使用する AWS 環境情報を含む AWS プロファイルの名前を指定します。

必須: はい

--proxy STRING

指定されたプロキシを使用します。

このオプションが指定されない場合、CDK CLI は HTTPS_PROXY 環境変数から読み取ります。

必須: はい

デフォルト値: HTTPS_PROXY 環境変数から読み取ります。

--role-arn, -r STRING

AWS CloudFormation を操作するとき、CDK CLI が引き受ける IAM ロールの ARN。

必須: いいえ

--staging BOOLEAN

アセットを出力ディレクトリにコピーします。

アセットが出力ディレクトリにコピーされないように、false を指定します。AWS SAM CLI がローカルデバッグを実行するとき、元のソースファイルを参照できるようになります。

必須: いいえ

デフォルト値: true

--strict BOOLEAN

警告を含むスタックを構築しないでください。

必須: いいえ

デフォルト値: false

--trace BOOLEAN

スタック警告のトレースを出力します。

必須: いいえ

デフォルト値: false

--verbose, -v COUNT

デバッグログを表示します。このオプションは複数回指定し、冗長性を増加することができます。

必須: いいえ

--version BOOLEAN

CDK CLI バージョン番号を表示します。

必須: いいえ

デフォルト値: false

--version-reporting BOOLEAN

合成された AWS CloudFormation テンプレートに AWS::CDK::Metadata リソースを含めます。

必須: いいえ

デフォルト値: true

オプションの提供と設定

コマンドライン引数を使用してオプションを渡すことができます。ほとんどのオプションは、cdk.json 設定ファイルで設定できます。複数の設定ソースを使用するとき、CDK CLI は次の優先順位に従います。

  1. コマンドライン値 – コマンドラインで提供されるオプションは、cdk.json ファイルで設定されたオプションを上書きします。

  2. プロジェクト設定ファイル – CDK プロジェクトのディレクトリ内の cdk.json ファイル。

  3. ユーザー設定ファイル – ローカルマシンの ~/.cdk.json にある cdk.json ファイル。

コマンドラインでオプションを渡す

ブール値を渡す

ブール値を受け入れるオプションは、次の方法で指定できます。

  • true および false 値の使用 — コマンドでブール値を指定します。以下に例を示します。

    $ cdk deploy --watch=true
$ cdk deploy --watch=false

  • オプションの対照物の指定 — no を追加してオプション名を変更し、false 値を指定します。以下に例を示します。

    $ cdk deploy --watch
$ cdk deploy --no-watch

  • デフォルトが true または false のオプションの場合、デフォルトから変更しない限り、オプションを指定する必要はありません。