ssm-config

KO | EN

gitlite — search

#python #llm #go #android #machine-learning #rust #deep-learning #linux #nodejs #macos #cli #security #pytorch #ios

(★ 8)

a AWS SSM Parameter Store configuration provider for node.js apps

ssm-config Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# ssm-config
a `node.js` library for building configuration objects using parameters from AWS SSM Parameter Store. Useful for lambda functions using the `node.js` runtime.

**Features**
- supports all ssm parameter types, including encrypted parameters with type `SecureString`
- supports custom validation/parsing allowing for defaults and type coercion
- supports composing complex configuration using multiple ssm parameters

## Installing
```shell
# install via NPM
$ npm install --save @cludden/ssm-config
```

## Getting Started
Define some parameters in SSM:
```shell
$ aws ssm put-parameter --type String --name /my-app/log/level --value debug
$ aws ssm put-parameter --type String --name /my-app/db --value {"user":"foo","port":3306}
$ aws ssm put-parameter --type SecureString --name /my-app/db/password --value s3cr3t
$ aws ssm put-parameter --type String --name /shared/number --value 11
```

Build a config object:
```javascript
import AWS from 'aws-sdk';
import ssmConfig from '@cludden/ssm-config';

const prefix = '/my-app';
const ssm = new AWS.SSM();

const config = await ssmConfig({ prefix, ssm });
console.log(config);
/*
{
  db: {
    user: "foo",
    password: "s3cr3t",
    port: 3306,
  },
  log: {
    level: "debug",
  }
}
*/
```

With custom validation logic:
```javascript
import AWS from 'aws-sdk';
import { expect } from 'chai';
import loadConfig from '@cludden/ssm-config';

const prefix = ['/my-app', '/shared'];
const ssm = new AWS.SSM();

const config = await loadConfig({ prefix, ssm, validate });
console.log(config);
/*
{
  db: {
    user: "foo",
    password: "s3cr3t",
    port: 3306,
  },
  log: {
    level: "debug",
  },
  number: 11,
}
*/
```

## Contributing
1. Clone it (`git clone git@github.com:cludden/ssm-config.git`)
1. Create your feature branch (`git checkout -b my-new-feature`)
1. Commit your changes using [conventional changelog standards](https://github.com/bcoe/conventional-changelog-standard/blob/master/convention.md) (`git commit -m 'feat(my-new-feature): Add some feature'`)
1. Push to the branch (`git push origin my-new-feature`)
1. Ensure linting/security/tests are all passing
1. Create new Pull Request

## Testing
Prerequisites:
- [Docker & Compose](https://store.docker.com/search?offering=community&type=edition))

```shell
# run test suite and generate code coverage
$ docker-compose run ssm-config

# run linter
$ docker-compose run ssm-config npm run lint

# run security scan
$ docker-compose run ssm-config npm run sec
```

## License
Licensed under the [MIT License](LICENSE.md)

ssm-config

ssm-config Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

ssm-config

ssm-config Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README