Skip to content

Latest commit

 

History

History
51 lines (41 loc) · 1.19 KB

README.md

File metadata and controls

51 lines (41 loc) · 1.19 KB

This plugin will seed your AWS SSM Parameter Store with the environment you have defined in your serverless config. By default your .env will be used to populate the values;

More information about SSM environment variables: Server Variables from AWS SSM Parameter Store

Installation

npm i serverless-ssm-seed --save-dev

Configuration

In your serverless.yml:

Define the plugin

plugins:
    - serverless-ssm-seed

Define the configuration

custom:
  ssm: 
    secure: ['SECURE_VAR']
    ignore: ['SOME_VAR']
    stages: ['dev', 'staging', 'production']

Define the ssm environment variables

  environment:
    SECURE_VAR: ${ssm:/${self:custom.stage}/SECURE_VAR~true}
    SOME_VAR: ${ssm:/${self:custom.stage}/SOME_VAR}

Usage

Seed using your .env values for the defaults:

sls ssm-seed

Use a string instead of .env values for the defaults:

sls ssm-seed --ssm-default='default'

Verify

  • Login to your AWS Console
  • Services -> Systems Manager
  • Parameter Store

You should now see your environment parameters.