https://github.com/checkly/serverless-plugin-select-resource

serverless plugin for selecting which resources to be deployed based on region and stage
https://github.com/checkly/serverless-plugin-select-resource

cloudformation serverless serverless-plugin

Last synced: about 2 months ago
JSON representation

serverless plugin for selecting which resources to be deployed based on region and stage

• Host: GitHub
• URL: https://github.com/checkly/serverless-plugin-select-resource
• Owner: checkly
• License: mit
• Created: 2020-02-13T13:45:58.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2020-08-27T14:54:03.000Z (almost 5 years ago)
• Last Synced: 2025-04-11T16:07:36.736Z (about 2 months ago)
• Topics: cloudformation, serverless, serverless-plugin
• Language: JavaScript
• Homepage:
• Size: 28.3 KB
• Stars: 3
• Watchers: 1
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Serverless Select Resource Plugin

[![serverless](http://public.serverless.com/badges/v3.svg)](http://www.serverless.com) 

[![npm version](https://badge.fury.io/js/serverless-plugin-select-resource.svg)](https://badge.fury.io/js/serverless-plugin-select-resource)

[![npm downloads](https://img.shields.io/npm/dm/serverless-plugin-select-resource.svg)](https://www.npmjs.com/package/serverless-plugin-select-resource)

[![license](https://img.shields.io/npm/l/serverless-plugin-select-resource.svg)](https://raw.githubusercontent.com/checkly/serverless-plugin-select-resource/master/LICENSE)

Select which resources are to be deployed based on region and stage. Only tested with AWS.

This plugin was originally forked from [serverless-plugin-select](https://github.com/FidelLimited/serverless-plugin-select/). Difference between them is `serverless-plugin-select` is for filtering functions and this plugin is for filtering AWS resources while deploying.

**Note:** Requires Serverless *v1.12.x* or higher.

## Setup

 Install via npm in the root of your Serverless service:

```

npm install serverless-plugin-select-resource --save-dev

```

* Add the plugin to the `plugins` array in your Serverless `serverless.yml`, you should place it at the top of the list:

```yml

plugins:

  - serverless-plugin-select-resource

  - ...

```

* Add `regions` or `stages` in your resources to select for deployment

* Run deploy command `sls deploy --stage [STAGE NAME] --region [REGION NAME]` 

* Resources will be deployed based on your selection

* All done!

#### Function

* **How it works?** When deployment region or stage don't match resources regions or stages, that function will be deleted from deployment.

* **regions** - Resource accepted deployment regions.

```yml

resources:

  Resources:

    AwesomeQueueInSingleRegion:

      Type: AWS::SQS::Queue

      Properties:

        QueueName: awesome-queue-in-single-region

      regions:

        - 'eu-central-1'

        - ...

```

* **stages** - Resource accepted deployment stages.

```yml

resources:

  Resources:

    AwesomeQueueInSingleStage:

      Type: AWS::SQS::Queue

      Properties:

        QueueName: awesome-queue-in-single-stage

      stages:

        - dev

        - prod

```

## Contribute

Help us making this plugin better and future proof.

* Clone the code

* Install the dependencies with `npm install`

* Create a feature branch `git checkout -b new_feature`

* Lint with standard `npm run lint`

## License

This software is released under the MIT license. See [the license file](LICENSE) for more details.