Terraform创建aws_subnet报The given key does not identify an element错误如何解决

错误根本原因 #

当前配置中私有子网的创建数量由var.cidr_subnet_private的长度决定，但访问可用区参数var.azs时没有做索引边界处理，当私有子网CIDR的数量超过可用区的数量时，就会触发索引越界报错。

排查步骤 #

• 验证两个变量的长度差异，可临时添加如下输出配置后执行terraform plan查看结果，确认var.cidr_subnet_private的长度是否大于var.azs的长度：

output "subnet_cidr_count" {
  value = length(var.cidr_subnet_private)
}
output "az_count" {
  value = length(var.azs)
}

• 确认业务逻辑：判断是要求私有子网数量和可用区数量严格对齐，还是允许单个可用区下部署多个私有子网。

修复方案 #

场景1：要求私有子网数量和可用区数量严格对齐 #

方案A：限制count最大取值

取两个变量长度的最小值作为count的取值，从运行层面避免索引越界：

resource "aws_subnet" "private" {
  vpc_id = aws_vpc.mod.id
  cidr_block = var.cidr_subnet_private[count.index]
  availability_zone = var.azs[count.index]
  count = min(length(var.cidr_subnet_private), length(var.azs))
  tags = {
    Name = "msi${var.environment}pvt${var.azs[count.index]}"
  }
}

方案B：添加变量校验规则

在variables.tf中添加参数校验逻辑，配置提交阶段就提前抛出不合法的参数错误：

variable "cidr_subnet_private" {
  type = list(string)
  description = "私有子网CIDR列表"
  validation {
    condition     = length(var.cidr_subnet_private) <= length(var.azs)
    error_message = "私有子网CIDR的数量不能超过可用区azs的数量。"
  }
}

场景2：允许单个可用区部署多个私有子网 #

使用取模运算或者Terraform内置element函数，让索引自动循环适配可用区列表的长度：

resource "aws_subnet" "private" {
  vpc_id = aws_vpc.mod.id
  cidr_block = var.cidr_subnet_private[count.index]
  // 两种写法二选一即可，效果一致
  availability_zone = var.azs[count.index % length(var.azs)]
  # availability_zone = element(var.azs, count.index)
  count = length(var.cidr_subnet_private)
  tags = {
    Name = "msi${var.environment}pvt${element(var.azs, count.index)}"
  }
}

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