如何用Terraform为已有DynamoDB表添加GSI？遇资源占用报错

问题描述 #

之前通过Python的boto3 update_table 接口给已有DynamoDB表添加了GSI，现在想改用Terraform管理该表，要求不丢失数据、不手动操作，但执行Terraform时一直报错：

Error: error creating DynamoDB Table: ResourceInUseException: Table already exists

已知Terraform默认不允许直接修改未纳入其状态管理的已有DynamoDB表。

用户的Terraform配置代码如下：

# Create a DynamoDB table with GSIs.
resource "aws_dynamodb_table" "table" {
  name         = var.function_name
  billing_mode = "PAY_PER_REQUEST"
  hash_key     = "PK" # partition key
  range_key    = "SK" # sort key

  # Partition Key.
  attribute {
    name = "PK"
    type = "S"
  }

  # Sort Key (datetime in UTC).
  attribute {
    name = "SK"
    type = "S"
  }

  # Date (no time).
  attribute {
    name = "date"
    type = "S"
  }

  # Define a GSI.
  global_secondary_index {
    name            = "date-index"
    hash_key        = "date" # partition key
    range_key       = "SK"
    projection_type = "ALL"
  }
}

解决方案 #

1. 将已有表导入Terraform状态 #

Terraform报错是因为它未识别到该表已存在，需先将表导入到Terraform的状态管理中：

terraform import aws_dynamodb_table.table <你的DynamoDB表名>

替换命令中的<你的DynamoDB表名>为实际表名（即配置中var.function_name对应的具体值）。

2. 核对配置与实际表状态 #

导入完成后，执行以下命令检查配置与实际表的差异：

terraform plan

• 若配置与实际表（包括已添加的GSI）完全一致，命令会显示No changes. Your infrastructure matches the configuration.，此时即可通过Terraform正常管理该表。
• 若存在差异（比如GSI是之前通过boto3添加，现在才写入配置），Terraform会自动计划对齐配置，此过程为在线操作，DynamoDB后台同步数据，不会丢失现有数据。

3. 后续注意事项 #

• 导入前务必确保Terraform配置中的表属性、主键、GSI等信息与实际表完全匹配，避免触发不必要的变更。
• 导入后，所有对该表的修改都需通过Terraform执行，禁止再使用boto3或控制台手动修改，否则会导致Terraform状态与实际资源不一致（状态漂移）。

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