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

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

AWS CDK アプリケーションをデプロイする

AWS Cloud Development Kit (AWS CDK) デプロイとは、 でインフラストラクチャをプロビジョニングするプロセスです AWS。

AWS CDK デプロイの仕組み

は AWS CloudFormation サービス AWS CDK を利用してデプロイを実行します。デプロイする前に、CDKスタックを合成します。これにより、アプリケーション内のCDKスタックごとに CloudFormation テンプレートとデプロイアーティファクトが作成されます。デプロイは、ローカルの開発マシンまたは継続的インテグレーションと継続的デリバリー (CI/CD) 環境から開始されます。デプロイ中、アセットはブートストラップされたリソースにアップロードされ、CloudFormation テンプレートは に送信されて AWS リソース CloudFormation をプロビジョニングします。

デプロイを成功させるには、以下が必要です。

CDK デプロイの前提条件

AWS CDK アプリケーションをデプロイする前に、以下を完了する必要があります。

セキュリティ認証情報を設定する

を使用して CDKCLIを操作するには AWS、ローカルマシンでセキュリティ認証情報を設定する必要があります。手順については、のセキュリティ認証情報を設定する AWS CDKCLI を参照してください。

AWS 環境のブートストラップ

デプロイは常に 1 AWS つ以上の環境 に関連付けられます。デプロイする前に、まず環境をブートストラップする必要があります。ブートストラップは、 がデプロイの実行と管理CDKに使用する環境内のリソースをプロビジョニングします。これらのリソースには、アセットを保存および管理するための Amazon Simple Storage Service (Amazon S3) バケットと Amazon Elastic Container Registry (Amazon ECR) リポジトリが含まれます。これらのリソースには、開発およびデプロイ中にアクセス許可を付与するために使用される AWS Identity and Access Management （IAM) ロールも含まれます。

コマンド AWS CDK ラインインターフェイス (AWS CDK CLI) cdk bootstrap コマンドを使用して環境をブートストラップすることをお勧めします。必要に応じて、ブートストラップをカスタマイズしたり、環境でこれらのリソースを手動で作成したりできます。手順については、で使用する環境をブートストラップする AWS CDK を参照してください。

AWS 環境を設定する

各CDKスタックをデプロイする場所を決定するには、各スタックを環境に関連付ける必要があります。手順については、で使用する環境を設定する AWS CDK を参照してください。

CDK アプリの開発

CDK プロジェクト 内では、CDKアプリケーションを作成して開発します。アプリ内で、1 つ以上のCDKスタック を作成します。 AWS CDK スタックスタック内では、コンストラクトライブラリから AWS コンストラクトをインポートして使用してインフラストラクチャを定義します。デプロイする前に、CDKアプリケーションに少なくとも 1 つのスタックが含まれている必要があります。

CDK アプリ合成

合成を実行するには、 CDK CLI cdk synth コマンドを使用することをお勧めします。cdk deploy コマンドは、デプロイを開始する前に合成も実行します。ただし、 を使用するとcdk synth、デプロイを開始する前にCDKアプリを検証し、エラーを検出できます。

合成動作は、スタック用に設定したスタックシンセサイザーによって決まります。 CDKシンセサイザーを設定しない場合、 DefaultStackSynthesizerが使用されます。ニーズに合わせて合成を設定およびカスタマイズすることもできます。手順については、CDK スタック合成を設定して実行する を参照してください。

合成された CloudFormation テンプレートを環境に正常にデプロイするには、環境のブートストラップ方法と互換性がある必要があります。例えば、 CloudFormation テンプレートでアセットをデプロイする正しい Amazon S3 バケットを指定する必要があります。環境をブートストラップするデフォルトの方法を使用すると、デフォルトのスタックシンセサイザーが機能します。ブートストラップや合成のカスタマイズなど、CDK動作をカスタマイズすると、CDKデプロイ動作が異なる場合があります。

アプリケーションのライフサイクル

合成を実行すると、CDKアプリケーションはアプリケーションのライフサイクル と呼ばれる次のフェーズで実行されます。

アプリケーションの実行

は、CDKアプリケーションの実行方法を知るCDKCLI必要があります。cdk init コマンドを使用してテンプレートからプロジェクトを作成した場合、アプリケーションの cdk.json ファイルには appキーが含まれます。このキーは、アプリケーションが書き込まれる言語に必要なコマンドを指定します。言語にコンパイルが必要な場合、コマンドラインは、アプリを自動的に実行する前にこのステップを実行します。

TypeScript

{
  "app": "npx ts-node --prefer-ts-exts bin/my-app.ts"
}

JavaScript

{
  "app": "node bin/my-app.js"
}

Python

{
    "app": "python app.py"
}

Java

{
  "app": "mvn -e -q compile exec:java"
}

C#

{
  "app": "dotnet run -p src/MyApp/MyApp.csproj"
}

Go

{
  "app": "go mod download && go run my-app.go"
}

を使用してプロジェクトを作成しなかった場合CLI、または CDK で指定されたコマンドラインを上書きする場合はcdk.json、cdkコマンドの実行時に --appオプションを指定できます。

$ cdk --app 'executable' cdk-command ...

- executable コマンドの一部は、CDKアプリケーションを実行するために実行する必要があるコマンドを示します。これらのコマンドにはスペースが含まれているため、図のように引用符を使用します。- cdk-command は、 synthや のようなサブコマンドdeployで、アプリケーションでCDKCLI何をするかを に指示します。これに従い、そのサブコマンドに必要な追加オプションを指定します。

CDK CLI は、既に合成されたクラウドアセンブリと直接やり取りすることもできます。これを行うには、クラウドアセンブリが保存されているディレクトリを に渡します--app。次の例では、 に保存されているクラウドアセンブリで定義されているスタックを一覧表示します./my-cloud-assembly。

$ cdk --app ./my-cloud-assembly ls

クラウドアセンブリ

の呼び出しapp.synth()は、 がアプリケーションからクラウドアセンブリを合成 AWS CDK するように指示するものです。通常、クラウドアセンブリと直接やり取りすることはありません。これらは、アプリケーションをクラウド環境にデプロイするために必要なものをすべて含むファイルです。例えば、アプリケーション内の各スタックの AWS CloudFormation テンプレートが含まれます。また、アプリで参照するファイルアセットまたはDockerイメージのコピーも含まれます。

クラウドアセンブリのフォーマットの詳細については、クラウドアセンブリ仕様を参照してください。

AWS CDK アプリケーションが作成するクラウドアセンブリを操作するには、通常、 を使用します AWS CDK CLI。ただし、クラウドアセンブリ形式を読み取ることができるツールは、アプリのデプロイに使用できます。

アプリケーションをデプロイします

アプリケーションをデプロイするには、 CDK CLI cdk deploy コマンドを使用してデプロイを開始するか、自動デプロイを設定することをお勧めします。

を実行するとcdk deploy、 はデプロイcdk synthの準備CDKCLIを開始します。次の図は、デプロイのコンテキストにおけるアプリケーションのライフサイクルを示しています。

デプロイ中、 CDKCLIは合成によって生成されたクラウドアセンブリを受け取り、 AWS 環境にデプロイします。アセットは Amazon S3 と Amazon にアップロードECRされ、 CloudFormation テンプレートはデプロイ AWS CloudFormation のために に送信されます。

AWS CloudFormation デプロイフェーズが開始されるまでに、CDKアプリの実行と終了が既に完了しています。これにより、以下の影響があります。

デプロイ許可

デプロイを実行する前に、アクセス許可を確立する必要があります。次の図は、デフォルトのブートストラッププロセスとスタックシンセサイザーを使用する場合に、デフォルトのデプロイ中に使用されるアクセス許可を示しています。