How can I get appsync API endpoint in serverless configure file?

Question

I am using serverless to deploy an Appsync API and a few lambda functions. This plugin https://github.com/sid88in/serverless-appsync-plugin is used to deploy Appsync. The lambda and Appsync are defined in the same serverless.yml file and they are deployed altogether.

My lambda needs to know the Appsync API endpoint which is created during sls deploy. How can I reference the Appsync endpoint as environment variable to my lambda?

my serverless.yml:

function:
   myHandler:
      handler: src/lambdas.myHandler
      name: myHandler
      environment:
        ENDPOINT: # HERE, how can I get appsync endpoint url?

custom:
  appSync:
    name: ${self:provider.stackName}
    ...

cyberwombat · Accepted Answer · 2020-07-12T16:43:51.800

2

AppSync plugin exposes a variable GraphQlApi which you can tap into for your environment variables which are automatically accessible in your lambdas.

In your config:

environment:
  API_URL: { Fn::GetAtt: [ GraphQlApi, GraphQLUrl ] }

In your lambda:

process.env.API_URL

Or lambda config directly:

  name: myHandler
  environment:
    ENDPOINT: { Fn::GetAtt: [ GraphQlApi, GraphQLUrl ] }

edited Jul 12 '20 at 16:43

answered Jul 11 '20 at 16:53

cyberwombat

38,105
35
175
251

Is `Ref::GraphQlApi` the right syntax? I have tried and `API_URL` has value of `Ref::GraphQlApi` rather than the real value. – Joey Yi Zhao Jul 12 '20 at 02:13
Try it with `Fn::GetAtt: [ GraphQlApi, GraphQLUrl ] }` . Forgot `Ref::GraphQlApi` only works directly in CloudFormation sections – cyberwombat Jul 12 '20 at 16:51
Yes it works. I am currently having only one appsync API. How does it support multiple API? – Joey Yi Zhao Jul 13 '20 at 00:38
You prefix it with the name: `MyReallyCoolGraphQlApi` – cyberwombat Jul 13 '20 at 05:12

How can I get appsync API endpoint in serverless configure file?

1 Answers1