Plugin for the SLS 1.x branch to provide support for adding API Gateway stage tags (not currently supported by CloudFormation)

Usage no npm install needed!

<script type="module">
  import silvermineServerlessPluginApigatewayStageTags from 'https://cdn.skypack.dev/@silvermine/serverless-plugin-apigateway-stage-tags';


Serverless Plugin: Support Tagging API Gateway Stages

Build Status Coverage Status Dependency Status Dev Dependency Status

What is it?

This is a plugin for the Serverless framework that adds support for setting tags on an API Gateway stage.

Normally CloudFormation supports tagging for resources created by a CloudFormation template. Unfortunately, API Gateway stages are not one of those resources. AWS does provided support for tagging via the AWS Console, aws-cli, and the API Gateway REST API. This plugin uses this support to automate the creation of the tags for the API Gateway stages in the service.

This plugin will mimic the stack tag propagation that CloudFormation automatically performs. There is not currently support for adding additional tags to a API Gateway stage. If this is a feature you need, feel free to submit a PR!

Once CloudFormation supports adding tags to an API Gateway stage and serverless/serverless#4644 is completed, this plugin will be obsolete.

How do I use it?

There are two steps:

Install the Plugin as a Development Dependency

npm install --save-dev --save-exact @silvermine/serverless-plugin-apigateway-stage-tags

Telling Serverless to Use the Plugin

Simply add this plugin to the list of plugins in your serverless.yml file:

   - '@silvermine/serverless-plugin-apigateway-stage-tags'

How do I contribute?

We genuinely appreciate external contributions. See our extensive documentation on how to contribute.


This software is released under the MIT license. See the license file for more details.