aws-cloudformation - 访问堆栈中的输出数据

Question

我正在使用 CloudFormation 创建 REST API。在另一个 CloudFormation 堆栈中，我希望能够访问该 CloudFormation 脚本的输出部分(调用 URL)中的值。

这可能吗？如果可能的话，如何实现？

Answer 1

您可以导出输出。导出使它们可以被其他堆栈访问。

来自AWS Docs:

To export a stack's output value, use the Export field in the Output section of the stack's template. To import those values, use the Fn::ImportValue function in the template for the other stacks

以下内容导出 API 网关 ID。

Description: API for interacting with API resources

Parameters:
  TargetEnvironment:
    Description: 'Examples can be dev, test or prod'
    Type: 'String'
    
  ProductName:
    Description: 'Represents the name of the product you want to call the deployment'
    Type: 'String'

Resources:
  MyApi:
    Type: AWS::ApiGateway::RestApi
    Properties:
      Name: !Sub '${ProductName}-${TargetEnvironment}-apigw-primaryapi'

Outputs:
  MyApiId:
    Description: 'Id of the API'
    Value: !Ref MyApi
    Export:
      Name: !Sub '${ProductName}-${TargetEnvironment}-apigw-primaryapi'
  MyApiRootResourceId:
    Description: 'Id of the root resource on the API'
    Value: !GetAtt MyApi.RootResourceId
    Export:
      Name: !Sub '${ProductName}-${TargetEnvironment}-apigw-primaryapirootresource'

输出的Export部分是这里的重要部分。如果您提供导出，则其他堆栈可以从中使用。

现在，在另一个文件中，我可以使用 Fn::Import 内部函数导入该 MyApiId 值，导入导出的名称。我还可以导入它的根资源，并在创建子 API 资源时使用这两个值。

来自AWS Docs:

The intrinsic function Fn::ImportValue returns the value of an output exported by another stack. You typically use this function to create cross-stack references.

Description: Resource endpoints for interacting with the API

Parameters:
  TargetEnvironment:
    Description: 'Examples can be dev, test or prod'
    Type: 'String'
    
  ProductName:
    Description: 'Represents the name of the product you want to call the deployment'
    Type: 'String'

Resources:
  MyResource:
    Type: AWS::ApiGateway::Resource
    Properties:
      ParentId: {'Fn::ImportValue': !Sub '${ProductName}-${TargetEnvironment}-apigw-primaryapirootresource' }
      PathPart: foobar
      RestApiId: {'Fn::ImportValue': !Sub '${ProductName}-${TargetEnvironment}-apigw-primaryapi' }

这是两个完全不同的 .yaml 文件，可以部署为两个独立的堆栈，但现在它们相互依赖。如果您尝试在删除 MyResource 堆栈之前删除 MyApi API Gateway 堆栈，则 CloudFormation 删除操作将会失败。您必须先删除依赖项。

需要记住的一件事是，在某些情况下，您可能希望能够灵活地删除根资源，而不必担心依赖关系。在某些情况下，删除操作可以完成而没有任何副作用。例如，删除 SNS 主题不会破坏 Lambda - 它会阻止其运行。没有理由仅仅为了重新部署新的 SNS 主题而删除 Lambda。在这种情况下，我利用命名约定并将事物连接在一起，而不是使用导出。例如 - 上面的 AWS::ApiGateway::Resource 可以根据命名约定绑定(bind)到特定于环境的 API 网关。

Parameters:
  TargetEnvironment:
    Description: 'Examples can be dev, test or prod'
    Type: 'String'
    
  ProductName:
    Description: 'Represents the name of the product you want to call the deployment'
    Type: 'String'

Resources:
  MyResource:
    Type: AWS::ApiGateway::Resource
    Properties:
      ParentId: {'Fn::ImportValue': !Sub '${ProductName}-${TargetEnvironment}-apigw-primaryapirootresource' }
      PathPart: foobar
      RestApiId: !Sub '${ProductName}-${TargetEnvironment}-apigw-primaryapi'

有了这个，只要资源的后半部分在所有环境中命名相同，就无需担心导出/导入。环境可以通过 TargetEnvironment 参数进行更改，以便可以在开发、测试和生产中重复使用。

此方法的一个警告是，命名约定仅在您想要访问可以通过名称引用的内容时才有效。如果您需要一个属性，例如本示例中的 RootResource，或者 EC2 大小、EBS 卷大小等，那么您不能只使用命名约定。您需要导出该值并导入它。在上面的示例中，我可以用命名约定替换 RestApiId 导入用法，但无法用命名约定替换 ParentId - 我必须执行导入。

我在模板中混合使用了这两种方法 - 在积累经验时，您会发现何时使用一种方法比另一种方法更有意义。