🌜
🌞
@middy/ssm

@middy/ssm

v3.1.1

SSM (EC2 Systems Manager) parameters middleware for the middy framework

npm install @middy/ssm

README

Middy ssm middleware

Middy logo

SSM (AWS System Manager Parameter) middleware for the middy framework, the stylish Node.js middleware engine for AWS Lambda

npm version npm install size GitHub Actions CI status badge
Standard Code Style Known Vulnerabilities Language grade: JavaScript Core Infrastructure Initiative (CII) Best Practices
Chat on Gitter Ask questions on StackOverflow

You can read the documentation at: https://middy.js.org/docs/middlewares/ssm

This middleware fetches parameters from AWS Systems Manager Parameter Store.

Parameters to fetch can be defined by path and by name (not mutually exclusive). See AWS docs here.

Parameters can be assigned to the function handler's context object by setting the setToContext flag to true. By default all parameters are added with uppercase names.

The Middleware makes a single API request to fetch all the parameters defined by name, but must make an additional request per specified path. This is because the AWS SDK currently doesn't expose a method to retrieve parameters from multiple paths.

For each parameter defined by name, you also provide the name under which its value should be added to context. For each path, you instead provide a prefix, and by default the value import each parameter returned from that path will be added to context with a name equal to what's left of the parameter's full name after the defined path, with the prefix prepended. If the prefix is an empty string, nothing is prepended. You can override this behaviour by providing your own mapping function with the getParamNameFromPath config option.

Install

To install this middleware you can use NPM:

npm install --save @middy/ssm

Options

  • AwsClient (object) (default AWS.SSM): AWS.SSM class constructor (e.g. that has been instrumented with AWS X-Ray). Must be from aws-sdk v2.
  • awsClientOptions (object) (default undefined): Options to pass to AWS.SSM class constructor.
  • awsClientAssumeRole (string) (default undefined): Internal key where role tokens are stored. See @middy/sts on to set this.
  • awsClientCapture (function) (default undefined): Enable AWS X-Ray by passing captureAWSClient from aws-xray-sdk in.
  • fetchData (object) (required): Mapping of internal key name to API request parameter Names/Path. SecureString are automatically decrypted.
  • disablePrefetch (boolean) (default false): On cold start requests will trigger early if they can. Setting awsClientAssumeRole disables prefetch.
  • cacheKey (string) (default ssm): Cache key for the fetched data responses. Must be unique across all middleware.
  • cacheExpiry (number) (default -1): How long fetch data responses should be cached for. -1: cache forever, 0: never cache, n: cache for n ms.
  • setToContext (boolean) (default false): Store role tokens to request.context.

NOTES:

  • Lambda is required to have IAM permission for ssm:GetParameters and/or ssm:GetParametersByPath depending on what you're requesting.
  • SSM has throughput limitations. Switching to Advanced Parameter type or increasing maxRetries and retryDelayOptions.base in awsClientOptions may be required.

Sample usage

import middy from '@middy/core'
import ssm from '@middy/ssm'

const handler = middy((event, context) => {
  return {}
})

let globalDefaults = {}
handler
  .use(ssm({
    fetchData: {
      accessToken: '/dev/service_name/access_token',  // single value
      dbParams: '/dev/service_name/database/',        // object of values, key for each path
      defaults: '/dev/defaults'
    },
    setToContext: true
  }))
  .before((request) => {
    globalDefaults = request.context.defaults.global
  })
import middy from '@middy/core'
import {getInternal} from '@middy/util'
import ssm from '@middy/ssm'

const handler = middy((event, context) => {
  return {}
})

let globalDefaults = {}
handler
  .use(ssm({
    fetchData: {
      defaults: '/dev/defaults'
    },
    cacheKey: 'ssm-defaults'
  }))
  .use(ssm({
    fetchData: {
      accessToken: '/dev/service_name/access_token',  // single value
      dbParams: '/dev/service_name/database/',        // object of values, key for each path
    },
    cacheExpiry: 15*60*1000,
    cacheKey: 'ssm-secrets'
  }))
  // ... other middleware that fetch
  .before(async (request) => {
    const data = await getInternal(['accessToken','dbParams','defaults'], request)
    Object.assign(request.context, data)
  })

Middy documentation and examples

For more documentation and examples, refers to the main Middy monorepo on GitHub or Middy official website.

Contributing

Everyone is very welcome to contribute to this repository. Feel free to raise issues or to submit Pull Requests.

License

Licensed under MIT License. Copyright (c) 2017-2022 Luciano Mammino, will Farrell, and the Middy team.

FOSSA Status

Release Notes

3.1.1
By will Farrell • Published on August 4, 2022

What's Changed

  • Add in module to package.json files @willfarrell
  • performance improvements @willfarrell

TypeScript

Docs

New Contributors

Full Changelog: https://github.com/middyjs/middy/compare/3.1.0...3.1.1

3.1.0
By will Farrell • Published on June 21, 2022

What's Changed

New Contributors

Full Changelog: https://github.com/middyjs/middy/compare/3.0.4...3.1.0

3.0.4
By will Farrell • Published on June 4, 2022

What's Changed

New Contributors

Full Changelog: https://github.com/middyjs/middy/compare/3.0.3...3.0.4

3.0.3
By will Farrell • Published on May 17, 2022

What's Changed

New Contributors

Full Changelog: https://github.com/middyjs/middy/compare/3.0.2...3.0.3

3.0.2
By will Farrell • Published on May 13, 2022

What's Changed

New Contributors

Full Changelog: https://github.com/middyjs/middy/compare/3.0.1...3.0.2

3.0.1
By will Farrell • Published on May 13, 2022

What's Changed

  • Updated dependencies

Full Changelog: https://github.com/middyjs/middy/compare/3.0.0...3.0.1

2.5.7
By will Farrell • Published on January 25, 2022

Fix publishing transpiling error in 2.5.6. Thanks to @maximepichou and @rreubenreyes for reporting.

General

License
MIT
Typescript Types
Built-in
Tree-shakeable
Yes

Popularity

GitHub Stargazers
3,032
Community Interest
2,905
Number of Forks
293

Maintenance

Commits
10/219/220250
Last Commit
Open Issues
4
Closed Issues
409
Open Pull Requests
1
Closed Pull Requests
149

Versions

Versions Released
10/219/22010
Latest Version Released
Aug 4, 2022
Current Tags
latest3.1.1
next3.1.0-rc.1

Dependencies

Dependencies (1)
Dev Dependencies (3)

Contributors

willfarrell
willfarrell
Commits: 384
lmammino
lmammino
Commits: 113
vladgolubev
vladgolubev
Commits: 12
greenkeeper[bot]
greenkeeper[bot]
Commits: 12
thejuan
thejuan
Commits: 12
dkatavic
dkatavic
Commits: 11
gsingh1
gsingh1
Commits: 10
joseSantacruz
joseSantacruz
Commits: 9
leog
leog
Commits: 6
theburningmonk
theburningmonk
Commits: 6
ossareh
ossareh
Commits: 5
munierujp
munierujp
Commits: 4
JimiPedros
JimiPedros
Commits: 4
sdomagala
sdomagala
Commits: 4
chris-heathwood-uoy
chris-heathwood-uoy
Commits: 3