Skip to content

Latest commit

 

History

History
56 lines (36 loc) · 1.69 KB

README.md

File metadata and controls

56 lines (36 loc) · 1.69 KB
Raw

Build Status npm version

aws-param-env

Module for loading parameter-store values from AWS SSM into environment variables

Features

  • Loads parameters by path
  • Runs synchronously to that environment variables can be set before your code loads
  • Recursively loads and decodes parameters by default
  • Can run inside AWS Lambda environment
  • AWS Lambda Node.js 10.x compatible

Installation

Install via npm.

npm install aws-param-env --save

Note: aws-param-env does not contain a dependency on aws-sdk and it should be installed within your application.

Getting Started

const awsParamEnv = require( 'aws-param-env' );

awsParamEnv.load( '/my-service-path-in-ssm/env' );

If your AWS region is not set in your environment variables, then it can be set programmatically by supplying options when calling load():

const awsParamEnv = require( 'aws-param-env' );

awsParamEnv.load( '/my-service-path-in-ssm/env', { region: 'us-east-1' } );

To load the environment variables automatically from a path, set the AWS_SSM_ENV_PATH to the SSM path and the AWS_REGION to the correct AWS region.

// AWS_SSM_ENV_PATH = '/my-services/service1/env', AWS_REGION='us-east-1'
require( 'aws-param-env' );

// environment variables are automatically loaded from the SSM parameter store

Feedback

We'd love to get feedback on how to make this tool better. Feel free to contact us at [email protected]

License

BSD-3-Clause