This Serverless plugin allows you to develop offline while using AWS SSM parameters in your
serverless.yml template. The plugin looks for environment variables which are fulfilled by SSM parameters at build time and substitutes them from a
.env file when running locally with the serverless-offline plugin.
4.X only works
Serverless 1.52+, if you'd like to use this
Serverless <= 1.51 use version
First install the plugins using npm or yarn
npm install serverless-offline serverless-offline-ssm --save-dev#oryarn add -D serverless-offline serverless-offline-ssm
Then inside of your project's
serverless.yml file add the following to the plugins section. Note it is important that
serverless-offline-ssm is loaded before
serverless-offline. This is important to ensure that we are setting the variables properly for
serverless-offline before it needs them.
NOTE: It is imperative that
serverless-offline-ssm be the the first plugin listed in the plugins section of your
serverless.yml file. Due to the load order of plugins, other plugins may interfere with the loading of your
plugins:- serverless-offline-ssm- serverless-offline
You can choose to use a
.env file or define your variables in
serverless-offline-ssm will always check if the
custom.serverless-offline-ssm have any values, if not it will
.env file needs to contain only variable names without the
ssm: prefix and
If you've defined
serverless.yml file your
.env need to be like the example bellow:
custom:serverless-offline-ssm:'lambda.LAMBDA_NAME.DB_DSN': 'sample-value-goes-here''another.sample.value': '99 red baloons'
Pull requests are always welcome. Please see the contributing guidelines.