# aws-parameter-store-json-reader

> A library that reads JSON from AWS Parameter Store.

Latest version **1.0.1** (published 2018-11-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install aws-parameter-store-json-reader
pnpm add aws-parameter-store-json-reader
yarn add aws-parameter-store-json-reader
bun add aws-parameter-store-json-reader
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2018-11-30 |
| First published | 2018-11-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 19.2 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Matthew Lloyd |
| Maintainers | matt.lloyd101 |
| Keywords | aws, parameter, store, json |

## Links

- npm: https://www.npmjs.com/package/aws-parameter-store-json-reader
- Repository: https://github.com/MattLloyd101/aws-parameter-store-json-reader
- Homepage: https://github.com/MattLloyd101/aws-parameter-store-json-reader#readme
- Issues: https://github.com/MattLloyd101/aws-parameter-store-json-reader/issues
- npm.io page: https://npm.io/package/aws-parameter-store-json-reader

## Dependencies (1)

- [aws-sdk](https://npm.io/package/aws-sdk.md) ^2.359.0

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 1.0.1 (latest) — 2018-11-30
- 1.0.0 — 2018-11-27

## README

# AWS Parameter Store JSON Reader

[![Build Status](https://travis-ci.org/MattLloyd101/aws-parameter-store-json-reader.svg?branch=master)](https://travis-ci.org/MattLloyd101/aws-parameter-store-json-reader)
[![npm version](https://badge.fury.io/js/aws-parameter-store-json-reader.svg)](https://badge.fury.io/js/aws-parameter-store-json-reader)

A Node.js library that reads JSON from AWS Parameter Store.

Meant to be used in conjunction with [aws-parameter-store-json-writer](https://github.com/MattLloyd101/aws-parameter-store-json-writer).

## Installation

via [npm](https://github.com/npm/npm)

```bash
npm install aws-parameter-store-json-reader
```

## Usage

```javascript
const AwsParameterStoreJsonReader = require('aws-parameter-store-json-reader');

const parameterReader = new AwsParameterStoreJsonReader({
    "apiVersion": '2014-11-06',
});

async function readConfig(path) {
    return await parameterReader.read(path);
}

readConfig("/ContentManagement/ContentManagementAggregator");

// {
//     "dev": {
//         "db": {
//             "username": "dev-user",
//             "password": "secret-password"
//         },
//         "tags": ["dev", "database"],
//         "ids": ["12", "42", "128"],
//         "objs": [{ "entry": "1" }, { "entry": "2" }, { "entry": "3" }]
//     },
//     "prod": {
//         "db": {
//             "username": "prod-user",
//             "password": "super-secret-password"
//         }
//     }
// };
```

The above assumes that the values in the path adhere to the JSON structure provided by [aws-parameter-store-json-writer](https://github.com/MattLloyd101/aws-parameter-store-json-writer). e.g.

| Name | Type | Key ID | Value |
| ---- | ---- | ------ | ----- |
| `/ContentManagement/ContentManagementAggregator/dev/db/username` | String | - | dev-user |
| `/ContentManagement/ContentManagementAggregator/dev/db/password` | SecureString | arn:aws:kms:us-east-2:123456789012:key/1a2b3c4d-1a2b-1a2b-1a2b-1a2b3c4d5e | "secret-password" |
| `/ContentManagement/ContentManagementAggregator/dev/tags` | StringList | - | "dev", "database" |
| `/ContentManagement/ContentManagementAggregator/dev/ids` | StringList | - | "12", "42", "128" |
| `/ContentManagement/ContentManagementAggregator/dev/objs/0/entry` | String | - | "1" |
| `/ContentManagement/ContentManagementAggregator/dev/objs/1/entry` | String | - | "2" |
| `/ContentManagement/ContentManagementAggregator/dev/objs/2/entry` | String | - | "3" |
| `/ContentManagement/ContentManagementAggregator/prod/db/username` | String | - | "prod-user" |
| `/ContentManagement/ContentManagementAggregator/prod/db/password` | SecureString | arn:aws:kms:us-east-2:123456789012:key/1a2b3c4d-1a2b-1a2b-1a2b-1a2b3c4d5e | "super-secret-password" |

## Parameter Store Json Writer Configuration

**apiVersion** – (optional) The version of the AWS API you wish to be using.

## Versioning

This library uses the [Semver](https://semver.org/) versioning system. The numbers do not relate to maturity but the number of breaking changes introduced.

---
_Source: https://npm.io/package/aws-parameter-store-json-reader · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._