# @zrpaplicacoes/ssm-parameter-validation

> SSM Parameter Validation is a package that validate if all the variables listed in docker-compose are configured in SSM (System Manager in AWS) as environment variables.

Latest version **0.0.3** (published 2019-10-06) · ISC license · 0 weekly downloads

## Install

```sh
npm install @zrpaplicacoes/ssm-parameter-validation
pnpm add @zrpaplicacoes/ssm-parameter-validation
yarn add @zrpaplicacoes/ssm-parameter-validation
bun add @zrpaplicacoes/ssm-parameter-validation
```

Provides the command `execute`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2019-10-06 |
| First published | 2019-10-06 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 5.7 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Carlos Sechi |
| Maintainers | alexgotardi, gustavorodarte, paulolima, pedro.gryzinsky, rafaelcostella |

## Links

- npm: https://www.npmjs.com/package/@zrpaplicacoes/ssm-parameter-validation
- npm.io page: https://npm.io/package/@zrpaplicacoes/ssm-parameter-validation

## Dependencies (6)

- [chalk](https://npm.io/package/chalk.md) ^2.4.2
- [dotenv](https://npm.io/package/dotenv.md) ^8.0.0
- [aws-sdk](https://npm.io/package/aws-sdk.md) ^2.459.0
- [js-yaml](https://npm.io/package/js-yaml.md) ^3.13.1
- [minimist](https://npm.io/package/minimist.md) ^1.2.0
- [aws-param-store](https://npm.io/package/aws-param-store.md) ^3.0.0

## Recent versions

- 0.0.3 (latest) — 2019-10-06
- 0.0.2 — 2019-10-06
- 0.0.1 — 2019-10-06

## README

# SSM Parameter Validation

SSM Parameter Validation is a package that validate if all the variables listed in docker-compose are configured in SSM (System Manager in AWS) as environment variables.

This works for projects that locally are docker based (and uses docker compose) and in production uses SSM as environment parameters control.

## How to use

### In your machine

Install the package in your dev-dependencies:

```
npm install @zrpaplicacoes/ssm-parameter-validation --save-dev
```

And then import the file in your code to use:

```
const { ssmValidation } = require('./index.js');

ssmValidation(config);
```

You can both configure your project variables through [config file](#through-config-file) or [environment variables](#through-environment-variables).

### Using docker

Docker only supports configuration through [environment variables](#through-environment-variables), so run:

```
docker run -v /${PWD}/docker-compose.yml:/home/node/app/docker-compose.yml -e AWS_REGION='<<region>>' -e AWS_SECRET_ACCESS_KEY='<<config>>' -e AWS_ACCESS_KEY_ID='<<config>>' -e PARAMETERS_PATH='<<config>>' -e IGNORE_PARAMETERS='<<config>> ssm-parameter-validation'
```

## Configuration

### Through Config File

### Through Environment Variables

---
_Source: https://npm.io/package/@zrpaplicacoes/ssm-parameter-validation · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._