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

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

context

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

deploy

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

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 パイプラインで一般的な自動オペレーションCLIにより適するように CDK の動作を変更します。

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

必須: いいえ

デフォルト値: false

--context, -c ARRAY

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

--debug BOOLEAN

詳細なデバッグ情報を有効にします。このオプションでは、CDK がバックグラウンドで何をCLIしているのかについて、さらに詳しく説明する詳細な出力が生成されます。

必須: いいえ

デフォルト値: false

--ec2creds, -i BOOLEAN

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

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

必須: いいえ

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

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

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

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

必須: いいえ

--profile STRING

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

必須: はい

--proxy STRING

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

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

必須: はい

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

--role-arn, -r STRING

とのやり取り時に CDK がCLI引き受ける IAM ロールの ARN AWS CloudFormation。

必須: いいえ

--staging BOOLEAN

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

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

必須: いいえ

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

  • オプションの対応するものを指定する – を追加してfalse値noを指定することでオプション名を変更します。以下に例を示します。

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

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