serverless-ssm-publish

:zap: serverless-ssm-publish

Publish custom data to AWS SSM Parameter Store from serverless.yaml.

Install

• Install with your choice of npm/yarn

npm install serverless-ssm-publish --save-dev
yarn add serverless-ssm-publish --save-dev

• Add the plugin to your plugins section in the serverless.yaml

plugins:
  - serverless-ssm-publish

Usage

During deployment

Add any params you want published to SSM to your serverless.yaml custom section. Ssm publish compares existing values and will only write if no value exists/ the value has changed.

custom:
  secretToken: ${opt:secretToken}

  ssmPublish:
    enabled: true                             # Needs to be set to true
    params:
      - path: /global/tokens/secretToken
        value: ${self:custom.secretToken}
        description: Super Secret Token       # description is optional
        secure: true                          # defaults to true
      - path: /service/config/storageBucket
        value: !Ref StorageBucket
        secure: false

From the CLI

You can also call the plugin directly in order to update SSM params without running deployment/packaging.

sls ssmPublish

Changelog

Version History

*0.1.0

• Initial release

Changelog

1.0.2 (2020-03-30)

Bug Fixes

• fix typo in semantic-release settings to publish changelog (bcc191a)

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[Unreleased]

• Extended CLI usage - Allowing you to publish specific params to SSM using the cli