How to get reference to aws api gateway in serverless framework

Question

provider:
  name: aws
  runtime: nodejs14.x

functions:
  hello:
    handler: handler.hello
    events:
      - httpApi:
          path: /
          method: get
          RestApiId:
            Ref: TestApi // How to get reference of AWS::Serverless::Api i.e. TestApi here

resources:
  Resources:
    authFunction:
      Type: AWS::Serverless::Function
      Properties:
        CodeUri: .
        Handler: handler.hello

    TestApi:
      DependsOn: AuthFunction
      Type: AWS::Serverless::Api
      Properties:
        StageName: dev
        Auth:
            DefaultAuthorizer: LambdaRequestAuthorizer
            Authorizers:
              LambdaRequestAuthorizer:
                FunctionPayloadType: REQUEST
                FunctionArn: !GetAtt AuthFunction.Arn

Getting error:

Configuration error at 'functions.hello': unrecognized property 'RestApiId'

pgrzesik · Accepted Answer · 2022-06-16 13:38:42Z

1

Let's first clarify a few things.

The httpApi event is using HTTP API, not REST API from AWS Api Gateway.

You can set externally created HTTP API by specifying it in the following way:

provider:
  httpApi:
    id: <your http api reference>

If you'd like to use REST API, then you would need to use http event type and set it like this:

provider:
  apiGateway:
    restApiId: <your rest api reference>

answered Jun 16, 2022 at 13:38

pgrzesik

2,44716 silver badges18 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

How to get reference to aws api gateway in serverless framework

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related