CDK 工具包库入门 - AWS Cloud Development Kit (AWS CDK) v2

这是 AWS CDK v2 开发者指南。旧版 CDK v1 于 2022 年 6 月 1 日进入维护阶段,并于 2023 年 6 月 1 日终止支持。

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

CDK 工具包库入门

开始使用 AWS CDK 工具包库以编程方式在代码中执行 CDK 操作,例如合成和部署。

先决条件

  1. 安装了支持的 Node.js 版本。

  2. AWS 已配置凭据。

  3. 对 AWS CDK 有基本的熟悉程度。

有关更多信息,请参阅 AWS CDK 先决条件

步骤 1:安装 CDK 工具包库

通过运行以下命令在项目的开发环境中安装 CDK Toolkit 库包:

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

步骤 2:初始化 CDK 工具包库

创建 CDK 工具包实例,以便在您的 CDK 应用程序上执行编程操作。

import { Toolkit } from '@aws-cdk/toolkit-lib'; const toolkit = new Toolkit({ // Optional configuration options go here });

您可以在创建过程中自定义 CDK 工具包实例。有关说明,请参阅配置 CDK 工具包实例

第 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 工具包

您可以根据需要进一步配置和自定义 CDK 工具包:

  • 消息和交互-配置 CDK 工具包与用户和应用程序的通信方式。请参阅配置消息和互动

  • 错误处理-为 CDK 操作实现结构化错误处理。请参见配置错误处理

其他资源

有关 CDK 工具包库npm包的更多信息,请参阅 @aws-cdk/toolkit- npm lib 软件包ReadMe中的。

有关 API 参考信息,请参阅 CDK 工具包库 API 参考