これは v2 AWS CDK デベロッパーガイドです。古い CDKv1 は 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 テンプレートは CloudFormation に送信されて AWS リソースをプロビジョニングします。

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

CDK デプロイの前提条件

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

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

CDK を使用するには CLI とやり取りするには 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アプリケーションに少なくとも 1 つのスタックが含まれている必要があります。

CDK アプリ合成

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

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

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

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

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

アプリの実行

CDK CLI は、CDKアプリの実行方法を知っている必要があります。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"
}

を使用してプロジェクトを作成しなかった場合 CDK CLI、または で指定されたコマンドラインを上書きする場合は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。 ただし、クラウドアセンブリ形式を読み取ることができる任意のツールを使用してアプリケーションをデプロイできます。

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

アプリケーションをデプロイするには、 CDKCLI cdk deploy デプロイを開始する、または自動デプロイを設定する コマンド。

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

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

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

デプロイのアクセス許可

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