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

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

# CDK Toolkit Library の使用を開始する
<a name="toolkit-library-gs"></a>

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

## 前提条件
<a name="toolkit-library-gs-prerequisites"></a>

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

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

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

詳細については、「[AWS CDK の前提条件](prerequisites.md)」を参照してください。

## ステップ 1: CDK Toolkit Library をインストールする
<a name="toolkit-library-gs-install"></a>

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

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

## ステップ 2: CDK Toolkit Library を初期化する
<a name="toolkit-library-gs-initialize"></a>

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

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

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

CDK Toolkit インスタンスは、作成時にカスタマイズできます。手順については、「[CDK Toolkit インスタンスの設定](toolkit-library-configure.md)」を参照してください。

## ステップ 3: CDK アプリのクラウドアセンブリソースを作成する
<a name="toolkit-library-gs-ca"></a>

クラウドアセンブリソースは、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();
   });
   ```

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

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

詳細については、「[クラウドアセンブリソースの設定](toolkit-library-configure-ca.md)」を参照してください。

## ステップ 4: CDK アプリのプログラムによるアクションを定義する
<a name="toolkit-library-gs-define"></a>

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 をさらにカスタマイズする
<a name="toolkit-library-gs-customize"></a>

CDK Toolkit は、ニーズに合わせてさらに設定およびカスタマイズできます。
+  **メッセージとインタラクション** - CDK Toolkit がユーザーやアプリケーションと通信する方法を設定します。[メッセージとインタラクションの設定](toolkit-library-configure-messages.md)を参照してください。
+  **エラー処理** - CDK オペレーションの構造化エラー処理を実装します。「[エラー処理を設定する](toolkit-library-configure.md#toolkit-library-configure-errors)」を参照してください。。

## その他のリソース
<a name="toolkit-library-gs-resources"></a>

CDK Toolkit Library `npm` パッケージの詳細については、「*@aws-cdk/toolkit-lib* `npm` パッケージ」の「[ReadMe](https://www.npmjs.com/package/@aws-cdk/toolkit-lib)」を参照してください。

API リファレンス情報については、「[CDK Toolkit Library API リファレンス](https://docs.aws.amazon.com/cdk/api/toolkit-lib/)」を参照してください。