CDK Toolkit Library の使用を開始する - AWS Cloud Development Kit (AWS CDK) v2
前提条件ステップ 1: CDK Toolkit Library をインストールするステップ 2: CDK Toolkit Library を初期化するステップ 3: CDK アプリのクラウドアセンブリソースを作成するステップ 4: CDK アプリのプログラムによるアクションを定義するステップ 5: CDK Toolkit をさらにカスタマイズするその他のリソース

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

CDK Toolkit Library の使用を開始する

AWS CDK Toolkit Library を使用して開始し、コードで合成やデプロイなどの CDK アクションをプログラムで実行します。

前提条件

  1. サポートされているバージョンの Node.js がインストールされました。

  2. AWS 認証情報が設定されています。

  3. AWS CDK の基本的な知識。

詳細については、「AWS CDK の前提条件」を参照してください。

ステップ 1: CDK Toolkit Library をインストールする

以下を実行して、プロジェクトの開発環境に CDK Toolkit Library パッケージをインストールします。

npm install --save @aws-cdk/toolkit-lib

ステップ 2: CDK Toolkit Library を初期化する

CDK Toolkit インスタンスを作成して、CDK アプリでプログラムによるアクションを実行します。

import { Toolkit } from '@aws-cdk/toolkit-lib';

const toolkit = new Toolkit({
    // Optional configuration options go here
});

CDK Toolkit インスタンスは、作成時にカスタマイズできます。手順については、「CDK Toolkit インスタンスの設定」を参照してください。

ステップ 3: CDK アプリのクラウドアセンブリソースを作成する

クラウドアセンブリソースは、CDK アプリから CloudFormation テンプレートを生成する手順を提供します。複数の方法で 1 つを作成できます。以下に、いくつかの例を示します。

  1. インラインアセンブリビルダー関数:

    import * as cdk from 'aws-cdk-lib';

const cloudAssemblySource = await toolkit.fromAssemblyBuilder(async () => {
  const app = new cdk.App();
  new MyStack(app, 'MyStack');
  return app.synth();
});

  2. 既存の CDK アプリファイル:

    const cloudAssemblySource = await toolkit.fromCdkApp("ts-node app.ts");

詳細については、「クラウドアセンブリソースの設定」を参照してください。

ステップ 4: CDK アプリのプログラムによるアクションを定義する

CDK Toolkit インスタンスとクラウドアセンブリソースを作成したので、プログラムによるアクションの定義を開始できます。MyStack スタックのデプロイを作成する基本的な例を次に示します。

import { StackSelectionStrategy } from '@aws-cdk/toolkit-lib';

await toolkit.deploy(cloudAssemblySource, {
  stacks: {
    strategy: StackSelectionStrategy.PATTERN_MUST_MATCH, // Deploy only stacks that exactly match the provided patterns
    patterns: ["MyStack"],
  },
});

ステップ 5: CDK Toolkit をさらにカスタマイズする

CDK Toolkit は、ニーズに合わせてさらに設定およびカスタマイズできます。

その他のリソース

CDK Toolkit Library npm パッケージの詳細については、「@aws-cdk/toolkit-lib npm パッケージ」の「ReadMe」を参照してください。

API リファレンス情報については、「CDK Toolkit Library API リファレンス」を参照してください。