How do I export AWS AppSync resolvers?

Question

I have setup AppSync with a Schema and Resolvers. I can export the Schema to a file, but I cannot see how to export the Resolvers.

I want to store these in a file so that I can source control them. They contain plenty of SQL code that I don't want to lose.

Lexicon

Answer 1

Command template: TYPE_NAME values: Mutation, Query and Subscription.

aws appsync list-resolvers --api-id YOUR_API_ID --type-name TYPE_NAME >> YOUR_FILE.txt

Examples: With YOUR_API_ID = d5gebysm3 (The original length is 26 in my case)

aws appsync list-resolvers --api-id d5gebysm3 --type-name Mutation >> Mutation.txt
aws appsync list-resolvers --api-id d5gebysm3 --type-name Query >> Query.txt
aws appsync list-resolvers --api-id d5gebysm3 --type-name Subscription >> Subscription.txt

Cyclorama

im use - npm i export-appsync -g - export-appsync -a api-id -k access-key-id -s secret-access-key -r region -o output-dir – Lindly

Answer 2

Before you go any farther, I would recommend you look into managing your AppSync resources with CloudFormation. CloudFormation templates can easily be saved in source control.

AppSync & CloudFormation Tutorials:

• https://read.acloud.guru/deploy-a-graphql-service-on-aws-with-the-serverless-framework-7af8fc22a01d

• https://read.acloud.guru/deploy-an-aws-appsync-graphql-api-with-amazon-cloudformation-9a783fdd8491

Or if your resolvers aren't doing anything custom, you can use Amplify's GraphQL Transformer. This allows you to annotate your schema and it will automatically generate resolvers from the annotations. Then you can put the annotated schema into source control. Documentation:

https://aws-amplify.github.io/docs/js/api#using-graphql-transformers

Szombathely

Thanks for that info. The links detail how to manually create the configuration files. Is there a way to output those files from an existing configuration? – Lexicon

Once you've attached the resolvers in the GUI, you can export them using the CLI. aws appsync list-resolvers --api-id <find-your-app-id-on-the-main-api-page-under-integrate-with-your-app> --type-name Post <or-whatever> – Reprobation

Links no longer work – Versify

Answer 3

There is a node.js package specifically made for this: export-appsync. But in the long term, it's easier to source control your schema and resolvers of you work from either serverless framework (serverless.com), from cloudformation or the AWS amplify framework.

Koon

Using that, good to get the work done. I had to modify it to be able to export both functions and datasources as well. Very helpful – Coconut

Answer 4

The nice thing about AWS is that there's probably an API endpoint for what you're looking for.

In this case, you can access the list of resolvers via the ListResolvers API endpoint, and you can retrieve a specific resolver via the GetResolver API endpoint.

Bully

That's a reasonable hypothesis, and I tried that too. However the default resolvers are not returned but clearly they have to be there behind the scenes are the API wouldn't work. This is a bit of a flaky area. Wow -- even weirder. What you have to do is manually attach a resolver for each field on the type. So the default resolvers show up in the UI, and once you attach them you can export them. But again, those defaults had to be there originally. This is one of the more half-baked AWS services I've dealt with. It's good to work with the new ones ;). – Reprobation