corelogicllc / serverless-appsync-plugin

serverless plugin for appsync

Deploy AppSync API's in minutes using this Serverless plugin.

Minimum requirements

• Node.js v16 or higher
• Serverless v3.0.0 or higher

Installation

npm install serverless-appsync-plugin

Quick start

service: my-app

plugins:
  - serverless-appsync-plugin

provider:
  name: aws

appSync:
  name: my-api
  authentication:
    type: API_KEY

  resolvers:
    Query.user:
      dataSource: my-table

  dataSources:
    my-table:
      type: AMAZON_DYNAMODB
      config:
        tableName: ${sls:stage}-data

Configuration

• General config
• DataSources
• Resolvers
• Pipeline Functions
• Authentication
• API keys
• Custom Domain
• Variable Substitutions
• Caching
• Web Application Firewall (WAF)

CLI

This plugin adds some useful CLI commands. See CLI commands documentation

Variables

This plugin exports some handy variables that you can use in your yml files to reference some values generated by CloudFormation:

• ${appsync:id}: The id of the AppSync API
• ${appsync:url}: The URL of the AppSync API
• ${appsync:arn}: The ARN of the AppSync API
• ${appsync:apiKey.[NAME]}: An API key

Example:

provider:
  environment:
    APPSYNC_ID: ${appsync:id}
    APPSYNC_ARN: ${appsync:arn}
    APPSYNC_URL: ${appsync:url}
    APPSYNC_API_KEY: ${appsync:apiKey.myKey}

appSync:
  name: my-api

  authentication:
    type: API_KEY

  apiKeys:
    - name: myKey

Upgrading from v1

To upgrade form v1 of this plugin, follow this guide

Contributing

If you have any questions, issue, feature request, please feel free to open an issue.

You are also very welcome to open a PR and we will gladly review it.

Resources

Tools

• Mapping Tool: Quickly Build and Debug AppSync & API Gateway Mapping Templates
• GraphBolt: A professional desktop app solution for building, testing, and debugging AppSync APIs.
• AppSync Resolver Autocomplete: VSCode extension. Autocomplete support for VTL template files.

Video tutorials

• Building an AppSync + Serverless Framework Backend | FooBar

Blog tutorial

• Part 1: Running a scalable & reliable GraphQL endpoint with Serverless

• Part 2: AppSync Backend: AWS Managed GraphQL Service

• Part 3: AppSync Frontend: AWS Managed GraphQL Service

• Part 4: Serverless AppSync Plugin: Top 10 New Features

Contributors ✨

Thanks goes to these wonderful people 👏

Benoît Bouré 🚧 💻	Siddharth Gupta 💻	Nik Graf 💻	Charles Killer 💻	jpstrikesback 💻	ZY 💻	Francis Upton IV 💻
Ilya Shmygol 💻	Maddi Joyce 💻	sebflipper 💻	Erez Rokah 💻	Akshay Kadam (A2K) 💻	Anton 💻	Burkhard Reffeling 💻
Dean Koštomaj 💻	Vincent Lesierse 💻	lulzneko 💻	thomas michael wallace 💻	Adnene KHALFA 💻	Alex Rozn 💻	Eric Chan 💻
Joseph 💻	Miha Eržen 💻	Mike Fogel 💻	Philipp Muens 💻	Toxuin 💻	Scott Rippee 💻	Yi Ai 💻
markvp 💻	Alex 💻	Alex Jurkiewicz 💻	Anas Qaderi 💻	Andreas Heissenberger 💻	mickael 💻	Brian Torres-Gil 💻
Cameron Childress 💻	Chris Chiang 💻	Esref Durna 💻	Hari 💻	Ivan Barlog 💻	John Veldboom 💻	Luca Bigon 💻
Lucas 💻	Mark Pollmann 💻	Maurice Williams 💻	Mike Chen 💻	asnaseer-resilient 💻	Neal Clark 💻	Nicky Moelholm 💻
Patrick Arminio 💻	Paul Li 💻	James Lal 💻	Sam Gilman 💻	Stefan Ceriu 💻	tsmith 💻	veloware 💻
Vladimir Lebedev 💻	Ryan Jones 💻	Vicary A. 💻	Brian Santarelli 🤔	Emilio Font 💻	Andriy Nastyn 💻 📖	MarcusJones 📖
h-kishi 💻	Dillon Browne 💻	Piotr Grzesik 💻	Aleksa Cukovic 💻	Scott Davey 💻	Mateus Holzschuh 💻

This project follows the all-contributors specification. Contributions of any kind welcome!