Terraform中EC2实例变量默认值未继承的问题求助

问题场景 #

我通过对象列表类型的变量迭代创建EC2实例，希望在.tfvars中只定义需要自定义的属性，其余自动继承variable块中设置的默认值，但实际操作中报错提示缺失多个必填属性，即使简化变量定义后问题依然存在。

原变量定义（简化前） #

variable "ec2_instances" {
  type = list(object({
    name                                         = string
    prefix                                       = string
    disable_api_termination                      = bool
    # ... 其余大量属性定义
  }))
  default = [
    {
      name                    = null
      prefix                  = "app"
      disable_api_termination = true
      # ... 其余默认属性值
    }
  ]
}

.tfvars配置示例 #

ec2_instances = [
  {
    name                    = "1234"
    custom_ami              = true
    instance_type           = "t3.small"
    # 仅定义需要修改的属性
  }]

报错信息 #

The resolved value of variable "ec2_instances" is not appropriate: element
0: attributes "additional_data_volume_delete_on_termination",
"additional_data_volume_size", "additional_ip_address_ranges",
"keep_subnet", "metadata_options", "network_volume_size", "port_ranges",
"prefix", "public_port_ranges", and "root_volume_size" are required.

简化复现场景 #

变量定义：

variable "ec2_instances" {
  type = list(object({
    name   = string
    prefix = optional(string)
  }))
  default = [
    {
      name   = null
      prefix = "A"
    }
  ]
}

.tfvars配置：

ec2_instances = [
  {
    name = "example"
  }]

依然报错prefix值为null，默认值未生效。

原因分析 #

1. 变量默认值的作用范围：你给ec2_instances设置的default是整个列表的默认值，当在.tfvars中指定该变量的值时，会完全覆盖默认列表，不会自动合并列表中单个对象的属性。
2. optional属性的使用误区：仅标记optional(string)但未指定默认值时，Terraform会将未传入的属性设为null，而非继承变量默认列表中对象的属性值。

解决方案 #

方案1：给单个属性直接指定默认值 #

修改变量类型定义，给每个需要默认值的属性标记为optional()并直接设置默认值，而非依赖整个列表的默认对象：

variable "ec2_instances" {
  type = list(object({
    name                                         = string
    prefix                                       = optional(string, "app")
    disable_api_termination                      = optional(bool, true)
    os_type                                      = optional(string, "ubuntu-bionic")
    metadata_options                             = optional(map(string), {
      "http_endpoint" = "enabled"
      "http_tokens"   = "required"
    })
    # ... 其余属性依次添加optional标记和默认值
  }))
  default = [] # 变量默认值设为空列表，或按需设置
}

此时在.tfvars中仅传入需要自定义的属性，未传入的属性会自动使用optional()中定义的默认值。

方案2：使用默认模板+merge函数合并配置 #

如果需要维护一个完整的默认配置模板，再与传入的实例配置合并，可以通过本地值实现：

1. 定义默认配置模板：

locals {
  default_ec2_template = {
    prefix                  = "app"
    disable_api_termination = true
    os_type                 = "ubuntu-bionic"
    metadata_options = {
      "http_endpoint" = "enabled"
      "http_tokens"   = "required"
    }
    instance_count                               = 1
    root_volume_size                             = 120
    # ... 所有需要默认值的属性
  }

  # 合并传入的实例配置与默认模板
  merged_ec2_instances = [
    for instance in var.ec2_instances : merge(local.default_ec2_template, instance)
  ]
}

2. 修改模块调用，使用合并后的配置：

module "aws_instances" {
  for_each = {
    for index, ec2 in local.merged_ec2_instances : tonumber(index) => ec2
  }
  source                                       = "../modules/instance"
  account                                      = var.account
  repo                                         = var.repo
  environment                                  = var.environment
  zone                                         = var.zone
  name                                         = each.value.name
  prefix                                       = each.value.prefix
  # ... 其余参数保持不变
}

这种方式下，var.ec2_instances的类型可以根据需求调整，既可以保留必填属性（通过merge确保有值），也可以标记为optional，灵活性更高。

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