Need to configure serverless resource output to get api gateway api id

Question

I have a serverless project that is creating an API Gateway API amongst other things. One of the functions in the project needs to generate a URL for an API endpoint.

My plan is to get the API ID using a resource output in serverless.yml then create the URL and pass it through to the lambda function as an env parameter.

My problem/question is how to get the API ID as a cloud formation output in serverless.yml?

I've tried:

resources:
  Outputs:
    RESTApiId:
      Description: The id of the API created in the API gateway
      Value:
        Ref: name-of-api

but this give the error:

The CloudFormation template is invalid: Unresolved resource dependencies [name-of-api] in the Outputs block of the template

Answer 1

The serverless framework has a documentation page on how they generate names for resources.

See. AWS CloudFormation Resource Reference

So the generated RestAPI resource is called ApiGatewayRestApi.