API Gateway Stage设置环境变量遇循环引用问题求解决方案

这个循环引用问题很常见——你试图在MyApiStage资源的配置里引用它自身的Ref，但CloudFormation会认为这个资源的创建依赖于它自己的输出，这就形成了无法打破的循环依赖，自然会报错。

下面给你几个可行的解决办法，核心思路都是把Stage的名称抽离成独立的、不依赖于该Stage资源的值：

方法1：使用参数定义Stage名称 #

把Stage名称定义成模板参数，然后在Stage的配置和环境变量里都引用这个参数，彻底避免循环：

{
  "AWSTemplateFormatVersion": "2010-09-09",
  "Transform": "AWS::Serverless-2016-10-31",
  "Description": "my POC.",
  "Parameters": {
    "MyStageName": {
      "Type": "String",
      "Default": "prod",
      "Description": "Name of the API Gateway Stage"
    }
  },
  "Resources": {
    "MyApiStage": {
      "Type": "AWS::ApiGateway::Stage",
      "Properties": {
        "StageName": {"Ref": "MyStageName"},
        "Variables": {
          "TAKE_ACTION": {"Ref": "MyStageName"}
        },
        // 补充你的其他必填属性，比如RestApiId、DeploymentId等
        "RestApiId": {"Ref": "MyApi"},
        "DeploymentId": {"Ref": "MyApiDeployment"}
      }
    }
  }
}

方法2：使用字符串常量或内置变量 #

如果不需要动态传入Stage名称，直接用硬编码的字符串，或者利用CloudFormation的内置变量（比如栈名称）来复用：

{
  "AWSTemplateFormatVersion": "2010-09-09",
  "Transform": "AWS::Serverless-2016-10-31",
  "Description": "my POC.",
  "Resources": {
    "MyApiStage": {
      "Type": "AWS::ApiGateway::Stage",
      "Properties": {
        // 用栈名称作为Stage名称，同时复用在环境变量里
        "StageName": {"Fn::Sub": "${AWS::StackName}"},
        "Variables": {
          "TAKE_ACTION": {"Fn::Sub": "${AWS::StackName}"}
        },
        // 其他必填属性
        "RestApiId": {"Ref": "MyApi"},
        "DeploymentId": {"Ref": "MyApiDeployment"}
      }
    }
  }
}

方法3：SAM模板简化写法（推荐） #

既然你用了SAM Transform，其实可以直接在AWS::Serverless::Api资源里配置Stage变量，同样遵循抽离名称的原则：

AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31
Description: my POC.

Parameters:
  MyStageName:
    Type: String
    Default: prod

Resources:
  MyApi:
    Type: AWS::Serverless::Api
    Properties:
      StageName: !Ref MyStageName
      StageVariables:
        TAKE_ACTION: !Ref MyStageName
      # 补充你的API定义，比如DefinitionUri或DefinitionBody

关键逻辑说明 #

无论哪种方法，本质都是切断循环依赖：我们不再尝试引用尚未创建完成的MyApiStage资源，而是使用一个预先存在的值（参数、常量、内置变量）来同步Stage名称和环境变量，这样CloudFormation就能正常处理资源创建顺序了。

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