https://github.com/vandium-io/aws-param-env

https://github.com/vandium-io/aws-param-env

Last synced: 3 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/vandium-io/aws-param-env
• Owner: vandium-io
• License: bsd-3-clause
• Created: 2017-09-13T19:53:55.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2022-12-30T19:00:40.000Z (about 2 years ago)
• Last Synced: 2025-01-01T12:48:34.481Z (7 days ago)
• Language: JavaScript
• Size: 252 KB
• Stars: 19
• Watchers: 5
• Forks: 6
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/vandium-io/aws-param-env.svg?branch=master)](https://travis-ci.org/vandium-io/aws-param-env)

[![npm version](https://badge.fury.io/js/aws-param-env.svg)](https://badge.fury.io/js/aws-param-env)

# 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

```js

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()`:

```js

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.

```js

// 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](https://en.wikipedia.org/wiki/BSD_licenses)