CDK Toolkit Library 入門 - AWS 雲端開發套件 (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. 內嵌組件建置器函數：

    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 如何與使用者和應用程式通訊。請參閱設定訊息和互動。

  • 錯誤處理 - 實作 CDK 操作的結構化錯誤處理。請參閱設定錯誤處理。

其他資源

如需 CDK Toolkit Library npm套件的詳細資訊，請參閱 @aws-cdk/toolkit-lib npm套件中的 ReadMe。

如需 API 參考資訊，請參閱 CDK Toolkit Library API 參考。