如何通过AWS CDK更新已有手动创建的DynamoDB表并支持跨区部署

问题原因 #

你遇到的错误是因为CloudFormation无法直接接管手动创建的资源——即使你覆盖了Logical ID，该表不属于当前CloudFormation栈的管理范围，CDK部署时会尝试创建同名表，导致冲突。

正确解决方案：资源导入（推荐） #

要让CDK接管已存在的手动表，需使用CloudFormation的资源导入功能，将手动表纳入栈的管理，之后就能正常通过CDK更新表结构，新区域部署时自动创建新表。步骤如下：

1. 确保CDK表定义与手动表完全一致
   检查并匹配以下属性：

   • 分区键/排序键
   • 全局二级索引（GSI）/本地二级索引（LSI）
   • 加密设置（默认/客户管理密钥）
   • 读写模式（按需/预置吞吐量）
   • 流设置（如果有）
     示例CDK代码（保持属性完全匹配）：

   import { Table, AttributeType, BillingMode } from 'aws-cdk-lib/aws-dynamodb';
   import { Stack, Construct } from 'aws-cdk-lib';
   
   const TABLE_NAME = 'YourExistingTableName';
   
   export class YourStack extends Stack {
     constructor(scope: Construct, id: string) {
       super(scope, id);
   
       this.table = new Table(this, 'ManagedDynamoTable', {
         tableName: TABLE_NAME,
         partitionKey: { name: 'id', type: AttributeType.STRING },
         billingMode: BillingMode.PAY_PER_REQUEST,
         // 其他属性严格匹配手动表
       });
       // 不需要覆盖Logical ID，保持CDK自动生成的即可
     }
   }
   

2. 生成CloudFormation模板
   执行命令生成栈的模板文件：

   cdk synth > template.yaml
   

3. 导入手动表到CloudFormation栈
   可以通过AWS控制台或CLI执行导入：

   • CLI方式：

     aws cloudformation import-resources \
       --stack-name YourStackName \
       --resources '[{"ResourceType": "AWS::DynamoDB::Table", "LogicalResourceId": "ManagedDynamoTable", "ResourceIdentifier": {"TableName": "'$TABLE_NAME'"}}]' \
       --template-body file://template.yaml
     

     注意：LogicalResourceId是CDK代码中定义的表的构造ID（示例中的ManagedDynamoTable），不是表名。
   • 控制台方式：进入CloudFormation控制台，选择目标栈，点击「导入资源」，按照提示选择模板、指定表名完成导入。

4. 后续部署
   导入完成后，后续执行cdk deploy即可正常更新表结构；新区域部署时，因为没有同名表，CDK会自动创建符合定义的新表。

备选方案：条件导入/创建（仅适用于只读引用场景） #

如果只需要在CDK代码中引用表，不需要通过CDK修改表结构，可以通过自定义资源检查表是否存在，存在则导入，不存在则创建。但这种方式无法通过CDK更新表结构：

import { Table, AttributeType } from 'aws-cdk-lib/aws-dynamodb';
import { Stack, Construct, CustomResource, Duration } from 'aws-cdk-lib';
import { Provider } from 'aws-cdk-lib/custom-resources';
import { Runtime } from 'aws-cdk-lib/aws-lambda';
import * as path from 'path';

const TABLE_NAME = 'YourTableName';

export class YourStack extends Stack {
  constructor(scope: Construct, id: string) {
    super(scope, id);

    // 创建自定义资源Lambda，检查表是否存在
    const checkTableExistsProvider = new Provider(this, 'CheckTableExistsProvider', {
      onEventHandler: {
        runtime: Runtime.NODEJS_18_X,
        code: path.join(__dirname, 'check-table-exists'),
        handler: 'index.handler',
        timeout: Duration.seconds(10),
      },
    });

    const tableExists = new CustomResource(this, 'TableExistsCheck', {
      serviceToken: checkTableExistsProvider.serviceToken,
      properties: {
        TableName: TABLE_NAME,
      },
    });

    // 根据检查结果选择导入或创建表
    const table = tableExists.getAttString('Exists') === 'true'
      ? Table.fromTableName(this, 'ExistingTable', TABLE_NAME)
      : new Table(this, 'NewTable', {
          tableName: TABLE_NAME,
          partitionKey: { name: 'id', type: AttributeType.STRING },
          // 其他属性匹配需求
        });
  }
}

对应的Lambda代码（check-table-exists/index.js）：

const { DynamoDB } = require('aws-sdk');
const dynamodb = new DynamoDB();

exports.handler = async (event) => {
  const { TableName } = event.ResourceProperties;
  try {
    await dynamodb.describeTable({ TableName }).promise();
    return { PhysicalResourceId: TableName, Data: { Exists: 'true' } };
  } catch (err) {
    if (err.code === 'ResourceNotFoundException') {
      return { PhysicalResourceId: TableName, Data: { Exists: 'false' } };
    }
    throw err;
  }
};

注意事项 #

• 资源导入是一次性操作，导入后表完全由CloudFormation/CDK管理，不能再手动修改表结构（否则会导致栈漂移）
• 新区域部署时，无需额外操作，CDK会自动创建符合定义的表
• 表名严格匹配应用需求，确保CDK定义的tableName与应用使用的名称一致

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