{"id":20390458,"url":"https://github.com/checkly/serverless-plugin-select-resource","last_synced_at":"2025-04-12T11:21:41.913Z","repository":{"id":103285650,"uuid":"240270492","full_name":"checkly/serverless-plugin-select-resource","owner":"checkly","description":"serverless plugin for selecting which resources to be deployed based on region and stage","archived":false,"fork":false,"pushed_at":"2020-08-27T14:54:03.000Z","size":29,"stargazers_count":3,"open_issues_count":2,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-11T16:07:36.736Z","etag":null,"topics":["cloudformation","serverless","serverless-plugin"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/checkly.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-02-13T13:45:58.000Z","updated_at":"2025-01-17T06:26:35.000Z","dependencies_parsed_at":null,"dependency_job_id":"295bd155-3c81-4168-973c-bb3ff8e56416","html_url":"https://github.com/checkly/serverless-plugin-select-resource","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/checkly%2Fserverless-plugin-select-resource","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/checkly%2Fserverless-plugin-select-resource/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/checkly%2Fserverless-plugin-select-resource/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/checkly%2Fserverless-plugin-select-resource/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/checkly","download_url":"https://codeload.github.com/checkly/serverless-plugin-select-resource/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248558131,"owners_count":21124223,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cloudformation","serverless","serverless-plugin"],"created_at":"2024-11-15T03:24:59.823Z","updated_at":"2025-04-12T11:21:41.908Z","avatar_url":"https://github.com/checkly.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Serverless Select Resource Plugin\n\n[![serverless](http://public.serverless.com/badges/v3.svg)](http://www.serverless.com) \n[![npm version](https://badge.fury.io/js/serverless-plugin-select-resource.svg)](https://badge.fury.io/js/serverless-plugin-select-resource)\n[![npm downloads](https://img.shields.io/npm/dm/serverless-plugin-select-resource.svg)](https://www.npmjs.com/package/serverless-plugin-select-resource)\n[![license](https://img.shields.io/npm/l/serverless-plugin-select-resource.svg)](https://raw.githubusercontent.com/checkly/serverless-plugin-select-resource/master/LICENSE)\n\nSelect which resources are to be deployed based on region and stage. Only tested with AWS.\n\nThis 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.\n\n**Note:** Requires Serverless *v1.12.x* or higher.\n\n## Setup\n\n Install via npm in the root of your Serverless service:\n\n```\nnpm install serverless-plugin-select-resource --save-dev\n```\n\n* Add the plugin to the `plugins` array in your Serverless `serverless.yml`, you should place it at the top of the list:\n\n```yml\nplugins:\n  - serverless-plugin-select-resource\n  - ...\n```\n\n* Add `regions` or `stages` in your resources to select for deployment\n\n* Run deploy command `sls deploy --stage [STAGE NAME] --region [REGION NAME]` \n\n* Resources will be deployed based on your selection\n\n* All done!\n\n#### Function\n\n* **How it works?** When deployment region or stage don't match resources regions or stages, that function will be deleted from deployment.\n\n* **regions** - Resource accepted deployment regions.\n\n```yml\nresources:\n  Resources:\n    AwesomeQueueInSingleRegion:\n      Type: AWS::SQS::Queue\n      Properties:\n        QueueName: awesome-queue-in-single-region\n      regions:\n        - 'eu-central-1'\n        - ...\n```\n\n* **stages** - Resource accepted deployment stages.\n\n```yml\nresources:\n  Resources:\n    AwesomeQueueInSingleStage:\n      Type: AWS::SQS::Queue\n      Properties:\n        QueueName: awesome-queue-in-single-stage\n      stages:\n        - dev\n        - prod\n```\n\n## Contribute\n\nHelp us making this plugin better and future proof.\n\n* Clone the code\n* Install the dependencies with `npm install`\n* Create a feature branch `git checkout -b new_feature`\n* Lint with standard `npm run lint`\n\n## License\n\nThis software is released under the MIT license. See [the license file](LICENSE) for more details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcheckly%2Fserverless-plugin-select-resource","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcheckly%2Fserverless-plugin-select-resource","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcheckly%2Fserverless-plugin-select-resource/lists"}