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

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

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

context

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

deploy

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

destroy

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

diff

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プロジェクトを継続的に監視します。

グローバルオプション

以下のオプションは、すべての と互換性があります。 CDKCLI コマンド。

--app, -a STRING

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

必須: はい

--asset-metadata BOOLEAN

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

必須: いいえ

デフォルト値: true

--build STRING

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

必須: いいえ

--ca-bundle-path STRING

HTTPS リクエストの検証に使用する CA 証明書へのパス。

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

必須: はい

--ci BOOLEAN

以下を示します。 CDKCLI コマンドは、継続的統合 (CI) 環境で実行されています。

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

このオプションを指定すると、ログは stdoutの代わりに に送信されますstderr。

必須: いいえ

デフォルト値: false

--context, -c ARRAY

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

--debug BOOLEAN

詳細なデバッグ情報を有効にします。このオプションでは、 CDKCLI は舞台裏でやっています。

必須: いいえ

デフォルト値: false

--ec2creds, -i BOOLEAN

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

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

必須: いいえ

デフォルト値: false

--help, -h BOOLEAN

のコマンドリファレンス情報を表示する CDK CLI.

必須: いいえ

デフォルト値: false

--ignore-errors BOOLEAN

合成エラーを無視します。合成エラーは、無効な出力を生成する可能性があります。

必須: いいえ

デフォルト値: false

--json, -j BOOLEAN

標準出力 () に印刷される AWS CloudFormation テンプレートYAMLには、 JSONの代わりに を使用しますstdout。

必須: いいえ

デフォルト値: 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

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

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

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

必須: いいえ

--profile STRING

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

必須: はい

--proxy STRING

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

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

必須: はい

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

--role-arn, -r STRING

が使用するIAMロールARNの 。 CDKCLI は、 を操作するときに を引き受けます AWS CloudFormation。

必須: いいえ

--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設定ファイルで設定できます。複数の設定ソースを使用する場合、 CDKCLI は、次の優先順位に従います。

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

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

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

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

ブール値の渡す

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

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

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

  • オプションのカウンターパートを指定する – false値を指定noするために を追加してオプション名を変更します。以下に例を示します。

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

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