如何将Terraform中templatefile函数转为YAML格式（聚焦definition字段）

问题背景 #

我有一段定义AWS Step Functions状态机的Terraform代码：

resource "aws_sfn_state_machine" "sfn_state_machine_for_slack_workflow_sm" {
  name = Step_Fucntion_name_for_slack_workflow_SM
  role_arn = aws_iam_role.Step_Function_Role.arn
  definition = templatefile("${path.module}/defination_slack_workflow_sm.tftpl", {Lambdaarn_OF_CallbackSlack="${var.LambdaARN_OF_CallbackSlack}"})
}

需要将其转换为YAML格式，重点处理其中的definition字段，查过相关文档和社区内容没找到明确方案，求解决办法。

解决方案 #

1. 核心字段对应关系

Terraform的aws_sfn_state_machine和AWS CloudFormation的AWS::StepFunctions::StateMachine资源一一对应，YAML需覆盖以下核心字段：

• Name：对应Terraform的name
• RoleArn：对应Terraform的role_arn
• DefinitionString：对应Terraform的definition（CloudFormation中字段名是DefinitionString）

2. 重点处理definition字段

Terraform里的templatefile是读取模板并替换变量，转换到YAML时需完成两步：

• 打开defination_slack_workflow_sm.tftpl模板文件，将${Lambdaarn_OF_CallbackSlack}占位符替换为实际Lambda ARN；或者用CloudFormation的变量替换函数保留动态逻辑
• 将替换后的完整状态机JSON定义作为字符串嵌入YAML的DefinitionString中

3. 完整YAML示例

方式一：直接嵌入替换后的状态机定义

假设你的tftpl模板是如下JSON结构：

{
  "Comment": "Slack Workflow State Machine",
  "StartAt": "CallbackSlack",
  "States": {
    "CallbackSlack": {
      "Type": "Task",
      "Resource": "${Lambdaarn_OF_CallbackSlack}",
      "End": true
    }
  }
}

替换变量后的YAML写法：

Resources:
  SfnStateMachineForSlackWorkflowSm:
    Type: AWS::StepFunctions::StateMachine
    Properties:
      Name: Step_Fucntion_name_for_slack_workflow_SM
      RoleArn: !GetAtt StepFunctionRole.Arn
      DefinitionString: |
        {
          "Comment": "Slack Workflow State Machine",
          "StartAt": "CallbackSlack",
          "States": {
            "CallbackSlack": {
              "Type": "Task",
              "Resource": "arn:aws:lambda:us-east-1:123456789012:function:your-callback-slack-lambda",
              "End": true
            }
          }
        }

方式二：用CloudFormation !Sub实现动态变量替换

如果想保留变量替换逻辑，不用硬编码ARN，可使用CloudFormation的!Sub函数：

Parameters:
  LambdaARNOfCallbackSlack:
    Type: String
    Description: ARN of the CallbackSlack Lambda function

Resources:
  StepFunctionRole:
    Type: AWS::IAM::Role
    # 此处省略角色具体定义，与原Terraform的aws_iam_role对应

  SfnStateMachineForSlackWorkflowSm:
    Type: AWS::StepFunctions::StateMachine
    Properties:
      Name: Step_Fucntion_name_for_slack_workflow_SM
      RoleArn: !GetAtt StepFunctionRole.Arn
      DefinitionString: !Sub |
        {
          "Comment": "Slack Workflow State Machine",
          "StartAt": "CallbackSlack",
          "States": {
            "CallbackSlack": {
              "Type": "Task",
              "Resource": "${LambdaARNOfCallbackSlack}",
              "End": true
            }
          }
        }

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