https://github.com/scaffoldly/serverless-resources
Create CloudFormation Resources when used with serverless-offline
https://github.com/scaffoldly/serverless-resources
serverless serverless-framework serverless-offline
Last synced: about 1 year ago
JSON representation
Create CloudFormation Resources when used with serverless-offline
- Host: GitHub
- URL: https://github.com/scaffoldly/serverless-resources
- Owner: scaffoldly
- Created: 2022-06-19T19:51:18.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-06-20T17:12:44.000Z (almost 4 years ago)
- Last Synced: 2024-10-30T00:34:01.501Z (over 1 year ago)
- Topics: serverless, serverless-framework, serverless-offline
- Language: JavaScript
- Homepage:
- Size: 4.88 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Serverless Resources
The `serverless-resources` plugin allows the Serverless Framework to create cloud resources
defined in the `resources` section of `serverless.yml`.
_Note_: this plugin only works when `serverless offline` is the command to avoid conflicts with the
stack resources created by `serverless deploy`.
## Install/Configure
Install the package:
```
yarn add --dev serverless-resources
```
`serverless.yml`:
```
plugins:
...
- serverless-resources
- serverless-offline
```
(_Note_: This plugin must be before `serverless-offline`)
### Localstack support
This plugin also supports `serverless-localstack` so Cloud Resources can be created when running
in conjunction with `serverless-offline`:
`serverless.yml`:
```
plugins:
...
- serverless-localstack
- serverless-resources
...
- serverless-offline
```
(_Note_: This plugin must be before `serverless-offline`, and after `serverless-localstack`)
## Configuration Options
`serverless.yml`:
```
custom:
serverless-resources:
stages: # A list of stages to run this plugin, defaults to ['dev']
- dev
```
## Roadmap
- Better collaboration with the generated CloudFormation template from Serverless
- Need to find the right way to generate it during lifecycle events
- Lookup events in function definitions and create function triggers
- Support Additional Cloud Providers
- Add CLI Commands to Create/Delete/etc