如何在Terraform中将Cognito的sms_configuration设为可选？

要解决这个问题，核心是只在需要短信功能时生成完整的sms_configuration配置块，不需要时完全不生成该块——直接传空值或null块会触发AWS的必填字段校验，这是因为Terraform会把空块识别为你要配置该功能但参数不全。

方法1：用动态块（推荐） #

这是Terraform处理可选配置块的标准方式，灵活性更高：

1. 先在模块里定义变量：

variable "enable_sms" {
  type        = bool
  default     = false
  description = "开关：是否启用Cognito短信功能"
}

variable "sms_config" {
  type = object({
    sns_caller_arn = string
    external_id    = optional(string) # 可选参数根据实际需求添加
  })
  default     = null
  description = "短信配置参数，仅当enable_sms为true时需传入有效值"
}

2. 在用户池资源中使用动态块生成配置：

resource "aws_cognito_user_pool" "main" {
  # 其他用户池必填配置...

  dynamic "sms_configuration" {
    # 只有enable_sms为true时，才生成这个配置块
    for_each = var.enable_sms ? [var.sms_config] : []
    content {
      sns_caller_arn = sms_configuration.value.sns_caller_arn
      external_id    = sms_configuration.value.external_id
    }
  }
}

当enable_sms设为false时，动态块不会生成，相当于完全移除了sms_configuration配置，自然不会触发必填校验；设为true时，会传入完整的配置块并校验参数。

方法2：直接用条件赋值（适合简单场景） #

如果你的配置逻辑简单，也可以直接通过条件判断控制sms_configuration的值：

resource "aws_cognito_user_pool" "main" {
  # 其他用户池必填配置...

  sms_configuration = var.enable_sms ? {
    sns_caller_arn = var.sns_caller_arn
    external_id    = var.external_id
  } : null
}

这里把sms_configuration设为null时，Terraform会完全忽略这个配置项，效果和手动移除块一致。但要注意，对应的sns_caller_arn等变量需要设为可选（比如用optional(string)），避免在不启用短信时被要求传值。

避坑提醒 #

• 绝对不要传入空的sms_configuration块（比如{}），这会被Terraform识别为“要配置短信功能但参数不全”，直接触发AWS的必填字段报错。
• 实现可选性的核心是让配置块完全不出现，而不是给块内参数传空值。

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