TerraformのHCL型制約とvalidationブロックでモジュール入力を安全に設計する方法｜object・list・mapのtype constraintと実践パターン

この記事のポイント

・型制約なし変数はterraform validateで型ミスを検出できない
・object({})でモジュール入力を厳密に定義し、apply前にエラーを止める
・validationブロックで値の範囲・パターンをコードに落とし込める
・optional()（Terraform 1.3以降）でデフォルト付き省略可能フィールドを作れる

# variables.tf

variable "environment" {
  type        = string
  description = "デプロイ環境名（dev/stg/prod）"
}

variable "instance_count" {
  type        = number
  description = "EC2インスタンス数"
  default     = 1
}

variable "enable_https" {
  type        = bool
  description = "HTTPSを有効化するか"
  default     = true
}

variable "allowed_cidrs" {
  type        = list(string)
  description = "許可するCIDRのリスト"
  default     = ["10.0.0.0/16", "172.16.0.0/12"]
}

variable "subnet_ids" {
  type        = set(string)
  description = "使用するサブネットIDの集合（重複なし）"
}

variable "tags" {
  type        = map(string)
  description = "リソースに付与するタグ"
  default     = {}
}

# RDSインスタンスの設定をひとまとめにする例
variable "rds_config" {
  type = object({
    instance_class    = string
    allocated_storage = number
    multi_az          = bool
    engine_version    = string
  })
  description = "RDSインスタンスの設定"
}

# 呼び出し側（terraform.tfvarsまたはmodule呼び出し）
rds_config = {
  instance_class    = "db.t3.medium"
  allocated_storage = 100
  multi_az          = true
  engine_version    = "8.0"
}

variable "network_config" {
  type = object({
    vpc_cidr = string
    subnets  = list(object({
      cidr = string
      az   = string
    }))
  })
}

# 呼び出し例
network_config = {
  vpc_cidr = "10.0.0.0/16"
  subnets = [
    { cidr = "10.0.1.0/24", az = "ap-northeast-1a" },
    { cidr = "10.0.2.0/24", az = "ap-northeast-1c" },
  ]
}

variable "environment" {
  type = string

  validation {
    condition     = contains(["dev", "stg", "prod"], var.environment)
    error_message = "environment は dev / stg / prod のいずれかを指定してください。"
  }
}

variable "app_port" {
  type = number

  validation {
    condition     = var.app_port >= 1024 && var.app_port <= 65535
    error_message = "app_port は 1024 から 65535 の間で指定してください。"
  }
}

variable "vpc_cidr" {
  type = string

  validation {
    condition     = can(cidrhost(var.vpc_cidr, 0))
    error_message = "vpc_cidr は有効なCIDR表記（例: 10.0.0.0/16）で指定してください。"
  }
}

# 不正な環境名を渡した場合
$ terraform plan -var="environment=test"

│ Error: Invalid value for variable
│
│   on variables.tf line 1:
│    1: variable "environment" {
│     ├────────────────
│     │ var.environment is "test"
│
│ environment は dev / stg / prod のいずれかを指定してください。
│
│ This was checked by the validation rule at variables.tf:4,3-13.
╵

variable "db_config" {
  type = object({
    instance_class    = string                       # 必須
    allocated_storage = number                       # 必須
    multi_az          = optional(bool, false)        # 省略時は false
    backup_retention  = optional(number, 7)          # 省略時は 7（日）
    parameter_group   = optional(string)             # 省略時は null
  })
}

# 最小構成で渡す例（必須項目のみ）
db_config = {
  instance_class    = "db.t3.small"
  allocated_storage = 20
}

# modules/alb_listener/variables.tf

variable "environment" {
  type        = string
  description = "デプロイ環境（dev/stg/prod）"

  validation {
    condition     = contains(["dev", "stg", "prod"], var.environment)
    error_message = "environment は dev / stg / prod を指定してください。"
  }
}

variable "listener_config" {
  type = object({
    protocol         = string
    port             = number
    ssl_policy       = optional(string, "ELBSecurityPolicy-TLS13-1-2-2021-06")
    certificate_arn  = optional(string)
  })
  description = "ALBリスナーの設定"

  validation {
    condition     = contains(["HTTP", "HTTPS"], var.listener_config.protocol)
    error_message = "protocol は HTTP または HTTPS を指定してください。"
  }

  validation {
    condition     = var.listener_config.protocol != "HTTPS" || var.listener_config.certificate_arn != null
    error_message = "protocol が HTTPS の場合は certificate_arn を指定してください。"
  }
}

variable "target_group_arns" {
  type        = list(string)
  description = "転送先ターゲットグループARNのリスト"

  validation {
    condition     = length(var.target_group_arns) >= 1
    error_message = "target_group_arns には最低1つのARNを指定してください。"
  }
}