npmpackage.info

Gathering detailed insights and metrics for serverless-offline-ssm

serverless-offline-ssm

Read SSM parameters from a .env file instead of AWS

6.2.0

MIT

TypeScript

5,941,050 2.9

Installations

npm install serverless-offline-ssm

Pull Requests

Open

8

Total

336

Closed

281

Merged

47

Issues

Open

13

Total

27

Closed

14

Releases

Unable to fetch releases

Developer

janders223

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

>=6.0

Typescript Support

Yes

Node Version

10.17.0

NPM Version

6.11.3 Statistics

94 Stars

116 Commits

24 Forks

2 Watching

6 Branches

13 Contributors

Updated on 30 May 2024

Languages

TypeScript (81.36%)

Nix (17.56%)

JavaScript (1.09%)

Total Downloads

Cumulative downloads

Total Downloads

5,941,050

Last day

-5.7%

5,153

Compared to previous day

Last week

29,690

Compared to previous week

Last month

23%

110,817

Compared to previous month

Last year

-20.4%

1,602,911

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

@types/jest @types/lodash.merge @types/node @types/serverless jest lodash.merge ts-jest typescript

Versions

serverless-offline-ssm

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.

NOTE!!

Version 6.x only works with Serverless 3+. Version 5.X only works Serverless 1.69+, if you'd like to use this plugin with Serverless <= 1.59 use version 4.1.2

Installation

First install the plugins using npm or yarn

1npm install serverless-offline serverless-offline-ssm --save-dev
2
3#or
4
5yarn 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 .env file.

1plugins:
2    - serverless-offline-ssm
3    - serverless-offline

Configuration

You can choose to use a .env file and/or define your variables in serverless.yml. Variables within serverless-offline-ssm take precedence. serverless-offline-ssm will always check if the section custom.serverless-offline-ssm have any values, if not it will fallback to .env

Stages

This plugin executes if the stage defined within the plugin options or provider sections of your serverless.yaml are includes within the stages property of the plugin configuration. If this condition has not been met the plugin has no effect.

The stages property of the plugin configuration can be overridden with a cli parameter --ssmOfflineStages which takes a comma separated list of stages.

.env

Your .env file needs to contain only variable names without the ssm: prefix and ~(true|false|split) sulfix.

If you've defined ${ssm:lambda.LAMBDA_NAME.DB_DSN~true} in serverless.yml file your .env need to be like the example bellow:

lambda.LAMBDA_NAME.DB_DSN="VAR VALUE"

serverless.yml

1provider:
2  stage: offline
3custom:
4  serverless-offline-ssm:
5    stages:
6      - offline
7    ssm:
8      'lambda.LAMBDA_NAME.DB_DSN': 'sample-value-goes-here'
9      'another.sample.value': '99 red baloons'

Contributing

Pull requests are always welcome. Please see the contributing guidelines.

License

MIT

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

7

SAST

Determines if the project uses static code analysis.

0

Maintained

Determines if the project is "actively maintained".

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2.9

/10

Last Scanned on 2024-11-25

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More