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

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

AWS CDK アプリ

AWS Cloud Development Kit (AWS CDK) アプリケーションは、1 つ以上の CDK スタックのコレクションです。スタックは、 AWS リソースとプロパティを定義する 1 つ以上のコンストラクトのコレクションです。したがって、スタックとコンストラクトの全体的なグループ化は CDK アプリと呼ばれます。

アプリケーションの定義

プロジェクト のアプリケーションファイルでアプリケーションインスタンスを定義して、アプリケーションを作成しますAWS CDK プロジェクト。これを行うには、 Appコンストラクトライブラリから AWS コンストラクトをインポートして使用します。App コンストラクトには初期化引数は必要ありません。ルートとして使用できるコンストラクトはこれだけです。

Construct Library の AWS Appおよび Stack クラスは、一意のコンストラクトです。他のコンストラクトと比較すると、リソース AWS は単独で設定されません。代わりに、他のコンストラクトのコンテキストを提供するために使用されます。 AWS リソースを表すすべてのコンストラクトは、Stackコンストラクトの範囲内で直接または間接的に定義する必要があります。 Stackコンストラクトはコンストラクトの範囲内で定義されますApp。

その後、アプリケーションが合成され、スタックの AWS CloudFormation テンプレートが作成されます。以下に例を示します。

TypeScript

const app = new App();
new MyFirstStack(app, 'hello-cdk');
app.synth();

JavaScript

const app = new App();
new MyFirstStack(app, 'hello-cdk');
app.synth();

Python

app = App()
MyFirstStack(app, "hello-cdk")
app.synth()

Java

App app = new App();
new MyFirstStack(app, "hello-cdk");
app.synth();

C#

var app = new App();
new MyFirstStack(app, "hello-cdk");
app.Synth();

Go

app := awscdk.NewApp(nil)
            
MyFirstStack(app, "MyFirstStack", &MyFirstStackProps{
  awscdk.StackProps{
    Env: env(),
  },
})

app.Synth(nil)

1 つのアプリケーション内のスタックは、相互のリソースとプロパティを簡単に参照できます。は、スタック間の依存関係を AWS CDK 推測して、正しい順序でデプロイできるようにします。1 つのcdk deployコマンドで、アプリケーション内の一部またはすべてのスタックをデプロイできます。

コンストラクトツリー

コンストラクトは、すべてのコンストラクトに渡される scope引数を使用して他のコンストラクトの内部で定義され、 App クラスをルートとして使用します。このようにして、 AWS CDK アプリケーションはコンストラクトツリー と呼ばれるコンストラクトの階層を定義します。

このツリーのルートは、 Appクラスのインスタンスであるアプリです。アプリ内で、1 つ以上のスタックをインスタンス化します。スタック内では、 コンストラクトをインスタンス化します。それ自体がリソースやその他のコンストラクトをインスタンス化する場合などに、ツリーの下に置かれます。

コンストラクトは、常に別のコンストラクトの範囲内で明示的に定義され、コンストラクト間の関係を作成します。ほとんどの場合、スコープとして this (Python では self) を渡し、新しいコンストラクトが現在のコンストラクトの子であることを示します。意図したパターンは、 からコンストラクトを導き出しConstruct、コンストラクターで使用するコンストラクトをインスタンス化することです。

スコープを明示的に渡すと、各コンストラクトはツリーにそれ自体を追加でき、この動作はConstruct基本クラス に完全に含まれています。これは、 でサポートされているすべての言語で同じように機能 AWS CDK し、追加のカスタマイズは必要ありません。

AWS CDK は、ツリーのルートから各子コンストラクトへのパス内のすべてのコンストラクトの IDs を使用して、 に必要な一意の IDs を生成します AWS CloudFormation。このアプローチでは、コンストラクト IDsは、ネイティブ のようにスタック全体ではなく、スコープ内で一意である必要があるだけです AWS CloudFormation。ただし、コンストラクトを別のスコープに移動すると、生成されたスタック固有の ID が変更され、同じリソースと見な AWS CloudFormation されません。

コンストラクトツリーは、 AWS CDK コードで定義したコンストラクトとは別のものです。ただし、ツリー内のそのコンストラクトを表すノードへの参照である任意のコンストラクトの node 属性からアクセスできます。各ノードは、ツリーのルートとノードの親スコープおよび子へのアクセスを提供する の属性であるNodeインスタンスです。

コンストラクトツリーは、コンストラクトが最終的な AWS CloudFormation テンプレートのリソースに合成される暗黙的な順序を定義します。あるリソースを別のリソースの前に作成する必要がある場合、 AWS CloudFormation または Construct Library AWS は一般的に依存関係を推測します。次に、リソースが正しい順序で作成されていることを確認します。

を使用して、2 つのノード間に明示的な依存関係を追加することもできますnode.addDependency()。詳細については、 AWS CDK API リファレンスの「依存関係」を参照してください。

AWS CDK は、コンストラクトツリー内のすべてのノードにアクセスし、各ノードに対してオペレーションを実行する簡単な方法を提供します。詳細については、「側面」を参照してください。

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

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

AWS CDK アプリケーションは、ライフサイクルの次のフェーズを実行します。

AWS CloudFormation デプロイフェーズが開始されるまでに、 AWS CDK アプリケーションはすでに終了し、終了しています。これにより、以下の影響があります。

クラウドアセンブリ

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

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

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

アプリケーションの実行

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

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

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

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