AWS CDK アプリ - AWS クラウド開発キット (AWS CDK) v2
CDK アプリの作成方法コンストラクトツリー

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

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

AWS CDK アプリ

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

CDK アプリの作成方法

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

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 コマンドで、アプリケーション内にスタックの一部またはすべてをデプロイできます。

コンストラクトツリー

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

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

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

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

重要

技術的には、コンストラクトをインスタンス化する場合、this 以外のスコープを渡すことができます。ツリー内の任意の場所、または同じアプリ内の別のスタックにコンストラクトを追加できます。たとえば、引数として渡されるスコープにコンストラクトを追加するミックスインスタイルの関数を記述できます。ここでの実際的な難点は、コンストラクトに選択した ID が他のユーザーのスコープ内で一意であることを簡単に確認できないことです。また、このプラクティスにより、コードの理解、維持、再利用の難しさが増してしまいます。したがって、コンストラクトツリーの一般的な構造を使用することをお勧めします。

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

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

  1. node.children – コンストラクトの直接の子。

  2. node.id – スコープ内のコンストラクトの識別子。

  3. node.path – すべての親の ID を含む、コンストラクトの完全なパス。

  4. node.root – コンストラクトツリー (アプリケーション) のルート。

  5. node.scope – コンストラクトのスコープ (親)、またはノードがルートの場合は未定義。

  6. node.scopes – ルートまでのコンストラクトのすべての親。

  7. node.uniqueId – ツリー内のこのコンストラクトの一意の英数字識別子 (デフォルトでは、node.path および ハッシュから生成されます)。

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

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

AWS CDK は、コンストラクトツリー内のすべてのノードを訪問し、それぞれに対して操作を実行する簡単な方法を提供します。詳細については、の「アスペクトと AWS CDK」を参照してください。