https://github.com/joshuahiggins/serverless-ssm-provider
AWS SSM provider plugin for Serverless framework
https://github.com/joshuahiggins/serverless-ssm-provider
aws aws-ssm serverless serverless-framework serverless-plugin ssm
Last synced: 5 months ago
JSON representation
AWS SSM provider plugin for Serverless framework
- Host: GitHub
- URL: https://github.com/joshuahiggins/serverless-ssm-provider
- Owner: joshuahiggins
- Created: 2019-06-04T17:38:52.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2022-02-12T00:29:13.000Z (over 4 years ago)
- Last Synced: 2025-10-10T19:48:43.141Z (8 months ago)
- Topics: aws, aws-ssm, serverless, serverless-framework, serverless-plugin, ssm
- Language: JavaScript
- Homepage:
- Size: 125 KB
- Stars: 4
- Watchers: 0
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# serverless-ssm-provider
This [Serverless](https://github.com/serverless/serverless) plugin allows you to simulate AWS SSM parameters in your `serverless.yml` template. The plugin intercepts requests to AWS and returns values found in your local environment files when a match is found. Otherwise the request passes through to AWS as usual.
## Installation
Install the plugin via npm:
```sh
npm i -D serverless-ssm-provider
```
Add the following to your `serverless.yml` file:
```yml
plugins:
- serverless-ssm-provider
```
## Usage
By default, `serverless-ssm-provider` reviews all AWS SSM requests and attempts to match the request path to an `.env` file for overrides.
Example function:
```yml
functions:
hello:
handler: handler.hello
environment:
MY_SECRET: ${ssm:/hello/mySecretKey}
```
Example `.env` file:
```
/hello/mySecretKey=test
```
Since this plugin intercepts requests before they are sent to AWS, the plugin allows you to work truly offline without error due to failed requests.
## Configuration
To override the default file location:
```yml
custom:
serverless-ssm-provider:
file: ssm.env
```