如何在Terraform中向JSON文件插入变量？附示例代码

我正在用Terraform部署AWS Step Functions，模块包含machine_definition.json配置文件和Terraform代码。

machine_definition.json内容如下：

{
  "Comment": "A Hello World example of the Amazon States Language using Pass states",
  "StartAt": "Hello",
  "States": {
    "Hello": {
      "Type": "Pass",
      "Result": "Hello",
      "Next": "World"
    },
    "World": {
      "Type": "${var.test}",
      "Result": "World",
      "End": true
    }
  }
}

我尝试在JSON里插入Terraform变量var.test，但JSON无法识别该变量。对应的Step Function Terraform模块代码：

module "step-functions" {
  source  = "terraform-aws-modules/step-functions/aws"
  name = "env-${var.environment}-state-machine"
  definition = file("${path.module}/machine_definition.json")
  tags = var.tags
  service_integrations = {
    xray = {
      xray = true 
    }
  }

  cloudwatch_log_group_name = "env-${var.environment}-state-machine-logGroup"
  attach_policies = true
  number_of_policies = 2
  policies = ["arn:aws:iam::aws:policy/AmazonS3FullAccess", "arn:aws:iam::aws:policy/AWSLambda_FullAccess"]
}

请问如何让JSON文件识别我的Terraform变量？

方法1：用templatefile解析变量占位符 #

Terraform的file函数仅读取文件内容，不会解析变量。改用templatefile函数可以处理文件中的变量占位符：

1. 修改machine_definition.json里的占位符，把"Type": "${var.test}"改成"Type": "${test}"
2. 更新Terraform模块的definition字段：

definition = templatefile("${path.module}/machine_definition.json", {
  test = var.test
})

templatefile会将文件中的${test}替换为var.test的实际值，生成合法的JSON内容。

方法2：将状态机定义转为Terraform Map结构 #

直接在Terraform代码中用Map定义状态机，再通过jsonencode转成JSON格式，这样可以直接引用变量：

module "step-functions" {
  source  = "terraform-aws-modules/step-functions/aws"
  name = "env-${var.environment}-state-machine"
  definition = jsonencode({
    Comment = "A Hello World example of the Amazon States Language using Pass states"
    StartAt = "Hello"
    States = {
      Hello = {
        Type = "Pass"
        Result = "Hello"
        Next = "World"
      }
      World = {
        Type = var.test
        Result = "World"
        End = true
      }
    }
  })
  tags = var.tags
  service_integrations = {
    xray = {
      xray = true 
    }
  }

  cloudwatch_log_group_name = "env-${var.environment}-state-machine-logGroup"
  attach_policies = true
  number_of_policies = 2
  policies = ["arn:aws:iam::aws:policy/AmazonS3FullAccess", "arn:aws:iam::aws:policy/AWSLambda_FullAccess"]
}

这种方式不需要单独维护JSON文件，变量引用更直接，适合状态机定义不复杂的场景。

方法3：用replace函数手动替换字符串 #

如果不想修改JSON文件格式，可以用replace函数手动替换指定占位符：

definition = replace(
  file("${path.module}/machine_definition.json"),
  "${var.test}",
  var.test
)

该方法仅适合简单的单变量替换，多变量场景下维护成本较高。

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