如何在现有TypeScript项目中使用CDK for Terraform部署基础设施？

1. 补充依赖安装 #

除了yarn add cdktf，还需要安装以下内容：

• cdktf CLI：全局安装用于执行生成、部署等操作，命令：yarn global add cdktf-cli 或 npm install -g cdktf-cli
• TypeScript相关依赖（项目未配置时）：yarn add typescript ts-node @types/node --dev
• 对应云厂商的Provider包：比如AWS环境安装yarn add @cdktf/provider-aws，阿里云安装yarn add @cdktf/provider-alicloud

2. 手动创建并配置cdktf.json #

无需执行cdktf init，直接在项目根目录新建cdktf.json，核心配置示例如下：

{
  "language": "typescript",
  "app": "ts-node ./src/infra/main.ts", // 替换为你的TS入口文件路径
  "terraformProviders": [], // 若已通过npm安装Provider包，此字段可留空；如需手动声明版本，比如["aws@~>5.0"]
  "terraformModules": [],
  "codeMakerOutput": "cdktf.out",
  "projectId": "your-project-unique-id" // 自定义唯一标识，比如项目名称
}

关键字段说明：

• app：指定cdktf执行时要运行的TS入口文件，必须能通过ts-node直接执行
• codeMakerOutput：生成的Terraform配置文件存放目录，默认即可

3. 编写基础cdktf代码 #

在你的TS入口文件中，需要包含cdktf的基础初始化逻辑，示例：

import { Construct } from "constructs";
import { App, TerraformStack } from "cdktf";
// 引入对应Provider的资源（以AWS为例）
import { AwsProvider, S3Bucket } from "@cdktf/provider-aws";

class MyInfraStack extends TerraformStack {
  constructor(scope: Construct, name: string) {
    super(scope, name);

    // 配置云厂商Provider
    new AwsProvider(this, "AWS", { region: "us-east-1" });
    // 定义基础设施资源（比如S3桶）
    new S3Bucket(this, "MyStorageBucket", { bucket: "my-unique-bucket-name-123" });
  }
}

// 初始化cdktf应用并生成配置
const app = new App();
new MyInfraStack(app, "my-project-infra");
app.synth();

4. 核心操作命令 #

• 生成Provider类型绑定：若手动在cdktf.json声明了Provider，执行cdktf get生成对应的TypeScript类型定义
• 生成Terraform配置：cdktf synth，会在cdktf.out目录生成可执行的Terraform文件
• 部署基础设施：cdktf deploy，执行前确保本地已配置好云厂商的访问凭证（比如AWS的~/.aws/credentials）

5. 额外配置注意事项 #

• 确保项目tsconfig.json配置符合要求：至少设置"target": "ES6"、"module": "CommonJS"，开启"esModuleInterop": true
• 若使用monorepo或yarn workspaces，需确保cdktf能正确识别依赖路径，可调整cdktf.json中的app字段为相对项目根目录的路径
• 可在package.json中添加快捷脚本：

  "scripts": {
    "infra:synth": "cdktf synth",
    "infra:deploy": "cdktf deploy"
  }
  

内容的提问来源于stack exchange，提问作者Sabo Boz