# @vicary/serverless-appsync-plugin > AWS AppSync support for the Serverless Framework Latest version **2.10.2** (published 2025-09-17) · MIT license · 0 weekly downloads ## Install ```sh npm install @vicary/serverless-appsync-plugin pnpm add @vicary/serverless-appsync-plugin yarn add @vicary/serverless-appsync-plugin bun add @vicary/serverless-appsync-plugin ``` ## Health **Score 35/100 (D)** — status: maintenance-mode. Positive: has types; no vulnerabilities; high quality score. Warnings: low downloads; no esm support. Negative: stale; low maintenance score. ## Facts | | | |---|---| | Version | 2.10.2 | | Published | 2025-09-17 | | First published | 2023-06-09 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | CommonJS | | Dependencies | 17 | | Unpacked size | 385.8 KB | | Known vulnerabilities | 0 (+1 in 1 direct dependencies) | | Install scripts | no | | GitHub stars | 0 | | Maintainers | vicary | ## Links - npm: https://www.npmjs.com/package/@vicary/serverless-appsync-plugin - Repository: https://github.com/vicary/serverless-appsync-plugin - Homepage: https://github.com/vicary/serverless-appsync-plugin#readme - Issues: https://github.com/vicary/serverless-appsync-plugin/issues - npm.io page: https://npm.io/package/@vicary/serverless-appsync-plugin ## Dependencies (17) - [ajv](https://npm.io/package/ajv.md) ^8.11.2 - [open](https://npm.io/package/open.md) ^8.4.0 - [chalk](https://npm.io/package/chalk.md) ^4.1.2 - [luxon](https://npm.io/package/luxon.md) ^2.5.0 - [globby](https://npm.io/package/globby.md) ^11.1.0 - [lodash](https://npm.io/package/lodash.md) ^4.17.21 - [aws-sdk](https://npm.io/package/aws-sdk.md) ^2.1265.0 - [esbuild](https://npm.io/package/esbuild.md) ^0.25.5 - [graphql](https://npm.io/package/graphql.md) ^16.6.0 - [ajv-errors](https://npm.io/package/ajv-errors.md) ^3.0.0 - [ajv-formats](https://npm.io/package/ajv-formats.md) ^2.1.1 - [change-case](https://npm.io/package/change-case.md) ^4.1.2 - [terminal-link](https://npm.io/package/terminal-link.md) ^2.1.1 - [ajv-merge-patch](https://npm.io/package/ajv-merge-patch.md) ^5.0.1 - [@serverless/utils](https://npm.io/package/@serverless/utils.md) ^6.8.2 - [@graphql-tools/merge](https://npm.io/package/@graphql-tools/merge.md) ^8.3.12 - [appsync-schema-converter](https://npm.io/package/appsync-schema-converter.md) ^2.1.4 ## Recent versions - 2.10.2 (latest) — 2025-09-17 - 2.10.1 — 2025-09-15 - 2.10.0 — 2025-06-03 - 2.5.0 — 2023-07-27 - 2.4.3 — 2023-06-14 - 2.4.2 — 2023-06-13 - 2.4.1 — 2023-06-10 - 2.4.0 — 2023-06-10 - 2.3.0 — 2023-06-10 - 1.0.0 — 2023-06-09 ## README [![Tests](https://github.com/sid88in/serverless-appsync-plugin/workflows/Tests/badge.svg)](https://github.com/sid88in/serverless-appsync-plugin/actions?query=workflow%3ATests) [![All Contributors](https://img.shields.io/badge/all_contributors-69-orange.svg?style=flat-square)](#contributors-) Deploy [AppSync](https://aws.amazon.com/appsync) API's in minutes using this [Serverless](https://www.serverless.com/) plugin. # Notice This is a fork of the original `serverless-appsync-plugin` with two modifications: 1. A new option `appSync.apiId` to support an existing AppSync API. 2. Replace the schema conversion with `appsync-schema-converter`. # Minimum requirements - [Node.js v16 or higher](https://nodejs.org) - [Serverless v3.0.0 or higher](https://github.com/serverless/serverless) # Installation ``` npm install serverless-appsync-plugin ``` # Quick start ```yaml 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](doc/general-config.md) - [DataSources](doc/dataSources.md) - [Resolvers](doc/resolvers.md) - [Pipeline Functions](doc/pipeline-functions.md) - [Authentication](doc/authentication.md) - [API keys](doc/API-keys.md) - [Custom Domain](doc/custom-domain.md) - [Variable Substitutions](doc/substitutions.md) - [Caching](doc/caching.md) - [Web Application Firewall (WAF)](doc/WAF.md) # CLI This plugin adds some useful CLI commands. See [CLI commands documentation](doc/commands.md) # 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: ```yaml 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](https://github.com/sid88in/serverless-appsync-plugin/tree/v1) of this plugin, [follow this guide](doc/upgrading-from-v1.md) # Contributing If you have any questions, issue, feature request, please feel free to [open an issue](/issues/new). You are also very welcome to open a PR and we will gladly review it. # Resources ## Tools - [Mapping Tool](https://mappingtool.dev/): Quickly Build and Debug AppSync & API Gateway Mapping Templates - [GraphBolt](http://graphbolt.dev/?utm_source=serverless-appsync-plugin&utm_medium=Referral): A professional desktop app solution for building, testing, and debugging AppSync APIs. - [AppSync Resolver Autocomplete](https://marketplace.visualstudio.com/items?itemName=theBenForce.appsync-resolver-autocomplete): VSCode extension. Autocomplete support for VTL template files. ## Video tutorials - [Building an AppSync + Serverless Framework Backend | FooBar](https://www.youtube.com/watch?v=eTUYqI_LCQ4) ## Blog tutorial - _Part 1:_ [Running a scalable & reliable GraphQL endpoint with Serverless](https://serverless.com/blog/running-scalable-reliable-graphql-endpoint-with-serverless/) - _Part 2:_ [AppSync Backend: AWS Managed GraphQL Service](https://medium.com/@sid88in/running-a-scalable-reliable-graphql-endpoint-with-serverless-24c3bb5acb43) - _Part 3:_ [AppSync Frontend: AWS Managed GraphQL Service](https://hackernoon.com/running-a-scalable-reliable-graphql-endpoint-with-serverless-db16e42dc266) - _Part 4:_ [Serverless AppSync Plugin: Top 10 New Features](https://medium.com/hackernoon/serverless-appsync-plugin-top-10-new-features-3faaf6789480) # Contributors ✨ Thanks goes to these wonderful people :clap:

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](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! --- _Source: https://npm.io/package/@vicary/serverless-appsync-plugin · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._