如何使用AWS CDK检查DynamoDB表是否已存在？

你可以通过两种常见方式实现创建'cars'表前的存在性检查，以下是具体代码示例和说明：

方法1：CDK Synth阶段导入表并捕获异常 #

利用CDK的Table.fromTableName方法尝试导入现有表，若表不存在则会抛出异常，捕获异常后创建新表。这种方式在模板生成阶段（synth）执行检查：

import { RemovalPolicy } from "aws-cdk-lib";
import { AttributeType, BillingMode, Table, TableProps } from "aws-cdk-lib/aws-dynamodb";
import { Construct } from "constructs";

export class MyTables extends Construct {
  public readonly cars: Table;

  constructor(scope: Construct, id: string) {
    super(scope, id);
    
    let targetTable: Table;
    try {
      // 尝试导入名为'cars'的现有表
      targetTable = Table.fromTableName(this, 'ExistingCarsTable', 'cars');
    } catch (err) {
      // 表不存在时创建新表
      targetTable = this.createTable('cars');
    }
    
    this.cars = targetTable;
  }

  private createTable(tableName: string): Table {
    // 这里补充你的表配置逻辑
    const tableProps: TableProps = {
      tableName: tableName,
      partitionKey: { name: 'id', type: AttributeType.STRING },
      billingMode: BillingMode.PAY_PER_REQUEST,
      removalPolicy: RemovalPolicy.RETAIN,
      // 添加你需要的其他配置，比如排序键、流设置等
    };
    return new Table(this, `${tableName}Table`, tableProps);
  }
}

注意点 #

• 此方法仅能检测已部署的表，若目标表属于同一个未部署的CDK栈，会被判定为不存在。
• 需要确保CDK执行角色拥有dynamodb:DescribeTable权限，否则导入操作会失败。

方法2：部署阶段通过自定义资源检查 #

使用CDK自定义资源（Custom Resource）调用AWS SDK的DescribeTable API，在实际部署阶段执行检查，结果更准确：

import { RemovalPolicy, Duration } from "aws-cdk-lib";
import { AttributeType, BillingMode, Table, TableProps } from "aws-cdk-lib/aws-dynamodb";
import { Construct } from "constructs";
import { AwsCustomResource, AwsCustomResourcePolicy, PhysicalResourceId } from "aws-cdk-lib/custom-resources";

export class MyTables extends Construct {
  public readonly cars: Table;

  constructor(scope: Construct, id: string) {
    super(scope, id);

    // 创建自定义资源调用DynamoDB API检查表是否存在
    const tableChecker = new AwsCustomResource(this, 'CheckCarsTable', {
      onCreate: {
        service: 'DynamoDB',
        action: 'describeTable',
        parameters: {
          TableName: 'cars'
        },
        physicalResourceId: PhysicalResourceId.of(`check-cars-table-${Date.now()}`),
      },
      policy: AwsCustomResourcePolicy.fromSdkCalls({
        resources: AwsCustomResourcePolicy.ANY_RESOURCE,
      }),
      timeout: Duration.minutes(5),
    });

    let targetTable: Table;
    try {
      // 尝试获取表信息，失败则表示表不存在
      tableChecker.getResponseField('Table.TableName');
      targetTable = Table.fromTableName(this, 'ExistingCarsTable', 'cars');
    } catch (err) {
      targetTable = this.createTable('cars');
    }

    this.cars = targetTable;
  }

  private createTable(tableName: string): Table {
    const tableProps: TableProps = {
      tableName: tableName,
      partitionKey: { name: 'id', type: AttributeType.STRING },
      billingMode: BillingMode.PAY_PER_REQUEST,
      removalPolicy: RemovalPolicy.RETAIN,
    };
    return new Table(this, `${tableName}Table`, tableProps);
  }
}

注意点 #

• 自定义资源会创建一个临时Lambda函数执行检查，需确保该Lambda角色拥有dynamodb:DescribeTable权限。
• 此方法适用于跨栈、跨账号或由外部流程创建的表的检查场景，结果更贴近实际部署状态。

额外提示 #

如果'cars'表始终由当前CDK栈管理，通常无需手动检查——CDK会自动处理资源的生命周期，避免重复创建。仅当表可能由外部流程创建，或需要跨环境引用时，才需要添加此类检查逻辑。

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