Fn::GetStackOutput

内置函数 Fn::GetStackOutput 返回由另一个堆栈输出的值。与 Fn::ImportValue 不同，此函数不需要被引用堆栈显式导出输出值。它还支持跨账户和跨区域引用。

当您需要跨 AWS 账户或区域引用堆栈输出，或者希望在不管理显式导出的情况下引用输出时，请使用此函数。

声明

{
  "Fn::GetStackOutput": {
    "StackName": "stack-name",
    "OutputName": "output-name",
    "Region": "region",
    "RoleArn": "role-arn"
  }
}

Fn::GetStackOutput:
  StackName: stack-name
  OutputName: output-name
  Region: region
  RoleArn: role-arn

!GetStackOutput
  StackName: stack-name
  OutputName: output-name
  Region: region
  RoleArn: role-arn

# Do not use
!GetStackOutput
  StackName: !Ref MyStackNameParam
  OutputName: VpcId

# Use this instead
Fn::GetStackOutput:
  StackName: !Ref MyStackNameParam
  OutputName: VpcId

参数

返回值

被引用堆栈中指定输出的值。

示例

同一个账户，同一个区域

以下示例引用同一账户和区域中名为 ProducerStack 的堆栈的 VpcId 输出。由于未指定 Region 或 RoleArn ，CloudFormation 使用当前堆栈的区域和执行角色。

{
  "Fn::GetStackOutput": {
    "StackName": "ProducerStack",
    "OutputName": "VpcId"
  }
}

Fn::GetStackOutput:
  StackName: ProducerStack
  OutputName: VpcId

同一个账户，不同的区域

以下示例引用 ProducerStack 部署在 us-west-2 中的 VpcId 输出，而使用该引用的堆栈位于不同的区域。Region 参数指示 CloudFormation 在 us-west-2 中查找被引用的值。

{
  "Fn::GetStackOutput": {
    "StackName": "ProducerStack",
    "OutputName": "VpcId",
    "Region": "us-west-2"
  }
}

Fn::GetStackOutput:
  StackName: ProducerStack
  OutputName: VpcId
  Region: us-west-2

跨账户

以下示例引用账户 111111111111 中 ProducerStack 的VpcId 输出。使用引用的堆栈位于账户 222222222222 中。RoleArn 参数指定了账户 111111111111 中具有 cloudformation:DescribeStacks 权限的角色，该角色必须可以被使用引用的堆栈的执行角色代入。

{
  "Fn::GetStackOutput": {
    "StackName": "ProducerStack",
    "OutputName": "VpcId",
    "RoleArn": "arn:aws:iam::111111111111:role/GetStackOutputRole"
  }
}

Fn::GetStackOutput:
  StackName: ProducerStack
  OutputName: VpcId
  RoleArn: arn:aws:iam::111111111111:role/GetStackOutputRole

跨账户和跨区域集群

以下示例引用不同账户和不同区域中堆栈的输出。同时指定了参数 RoleArn 和 Region。

{
  "Fn::GetStackOutput": {
    "StackName": "ProducerStack",
    "OutputName": "VpcId",
    "RoleArn": "arn:aws:iam::111111111111:role/GetStackOutputRole",
    "Region": "us-west-2"
  }
}

Fn::GetStackOutput:
  StackName: ProducerStack
  OutputName: VpcId
  RoleArn: arn:aws:iam::111111111111:role/GetStackOutputRole
  Region: us-west-2

IAM 角色配置

在跨账户引用中使用 RoleArn 参数时，IAM 角色必须具有描述被引用堆栈所在账户中堆栈的权限：

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "cloudformation:DescribeStacks"
      ],
      "Resource": "*"
    }
  ]
}

该角色必须具有授予使用引用的堆栈执行角色以 AssumeRole 权限的信任策略：

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Principal": {
        "AWS": "arn:aws:iam::222222222222:role/CloudFormationExecutionRole"
      },
      "Action": "sts:AssumeRole"
    }
  ]
}

支持的函数

以下函数可以在 Fn::GetStackOutput 的参数值内部使用（例如，用于构造 StackName 或 RoleArn）。这些函数的值无法依赖资源。

Fn::GetStackOutput本身可以在以下模板位置中使用：

有关尚不支持的位置，请参阅下方的 已知限制条件 说明。

例如，您可以使用 Ref 将参数值作为堆栈名称传递：

Parameters:
  SourceStackName:
    Type: String

Resources:
  MyResource:
    Type: AWS::EC2::Instance
    Properties:
      SubnetId:
        Fn::GetStackOutput:
          StackName: !Ref SourceStackName
          OutputName: SubnetId

已知限制条件

以下使用模式在本版本中不受支持。均会返回 InternalFailure 错误。后续更新中将添加对这些模式的支持。

请直接将 Fn::GetStackOutput 用作资源属性值，或将其包裹在 Fn::Join、Fn::If 或 Fn::Select 内部。

错误处理

CloudFormation 会在堆栈创建或更新操作期间验证 Fn::GetStackOutput 引用。以下是您可能遇到的常见错误：

us-east-1 与选择加入区域之间的引用

当您在 us-east-1 区域与选择加入区域之间实现引用时，可能会遇到错误。为避免此类错误，请遵循本指南更新全局 STS 端点的令牌兼容性。

将 Fn::GetStackOutput 与 AWS Cloud Development Kit (AWS CDK) 配合使用

AWS Cloud Development Kit (AWS CDK) (CDK) 通过 Fn.getStackOutput() 方法支持 Fn::GetStackOutput。当 CDK 堆栈之间存在跨区域或跨账户引用时，CDK 现在可以直接使用 Fn::GetStackOutput，而不再需要使用 SSM 参数生成自定义资源。这简化了合成后的模板，并消除了之前 crossRegionReferences 变通方法的需求。

有关更多信息，请参阅 CDK API 参考。

与 Fn::ImportValue 的对比

当您需要在同一账户和区域内使用强引用完整性时，请使用 Fn::ImportValue。当您需要跨账户或跨区域引用，或希望避免管理显式导出时，请使用 Fn::GetStackOutput。

最佳实践