AWS SAM:嵌套堆栈,从根堆栈引用API网关

时间:2019-12-22 13:25:35

标签: amazon-web-services amazon-cloudformation aws-api-gateway serverless-framework aws-sam

我想将SAM应用程序分成多个部分。

我想在根堆栈中创建一个API(AWS :: Serverless :: Api)。

我正在子堆栈中创建lambda函数,我想在其中提供从根堆栈到API事件的API引用。

这可行吗?我找不到从根堆栈到子堆栈访问API的任何好例子吗?

我尝试了以下模板-

parenttemplateapi:
    Type: AWS::Serverless::Application
    Properties:
      Location:
        ApplicationId: arn:aws:serverlessrepo:us-east-1:account_id:applications/parent-template
        SemanticVersion: 1.0.0



HelloWorldFunction:
    Type: AWS::Serverless::Function 
    Properties:
      CodeUri: hello_world/
      Handler: app.lambda_handler
      Runtime: python2.7
      Events:
        HelloWorld:
          Type: Api
          Properties:
            Method: get
            Path: /hello
            RestApiId: !GetAtt parenttemplateapi.Outputs.ServerlessGW-restApiId

当我尝试部署此模板时,出现以下错误-

  

错误:无法为堆栈创建变更集:子模板,例如:   服务员ChangeSetCreateComplete失败:服务员遇到终端   故障状态状态:失败。原因:转换   AWS :: Serverless-2016-10-31失败,原因是:内部转换失败。

任何指针/建议吗?

我指的是以下链接-

https://aws.amazon.com/blogs/compute/announcing-nested-applications-for-aws-sam-and-the-aws-serverless-application-repository/

可以在此处使用根堆栈中的API网关ID(AWS :: ApiGateway :: RestApi)吗?

https://dev.to/grahamcox82/building-a-larger-serverless-application-part-3-modular-monorepos-3mon

可以使用无服务器框架来实现吗?

1 个答案:

答案 0 :(得分:3)

这里需要注意的是,我不使用 AWS SAM,因为我只使用 serverless.yml ServerlessFramework 文件来声明要部署的资源。

在我的 ROOT API 中,我声明了我的子 lambda 依赖的一系列输出,以便我的所有端点都可以具有相同的 Rest API ID。此输出声明嵌套在我的 resources 文件中的 serverless.yml 声明下,如下所示:

resources:

  Resources:
    ...
    stuff here that you may need
    ...

  # API Gateway Cross Stack Reference Exports!!!!!
  # Outputs that other services will depend on!!!
  Outputs:
    ApiGatewayRestApiId:
      Value:
        Ref: ApiGatewayRestApi
      Export:
        Name: ${self:custom.stage}-ApiGatewayRestApiId

    ApiGatewayRestApiRootResourceId:
      Value:
        Fn::GetAtt:
          - ApiGatewayRestApi
          - RootResourceId
      Export:
        Name: ${self:custom.stage}-ApiGatewayRestApiRootResourceId

实现此功能后,您需要在 provider 文件的 serverless.yml 部分中的子 lambda 表达式中导入对此父 API 资源的引用。



  # Cross-Stack Reference for sharing of API Gateway URI
  # created with accounting-api
  apiGateway:
    restApiId: ${cf:ROOT_API_NAME_HERE-dev.ApiGatewayRestApiId}
    #"Fn::ImportValue": ${self:custom.stage}-ApiGatewayRestApiId
    restApiRootResourceId:
      ${cf:ROOT_API_NAME_HERE-dev.ApiGatewayRestApiRootResourceId}
      #"Fn::ImportValue": ${self:custom.stage}-ApiGatewayRestApiRootResourceId

您必须注意需要从父 API 的 restApiId 堆栈中导入的 CloudFormation。您可以通过进入父 API 中的 CloudFormation 堆栈来查看输出;点击输出并根据需要找到您的 restApiId 值。

还有另一种方法允许您使用 Fn::ImportValue 导入值,您可以通过此处显示的示例进行查看:

https://github.com/serverless/examples/blob/master/aws-node-shared-gateway/users/serverless.yml

我在上面为您粘贴的代码中注释了此方法,供您参考。