Skip to content

Commit 794fa41

Browse files
committed
Updating the Readme & tests
1 parent a6bfec2 commit 794fa41

File tree

2 files changed

+22
-4
lines changed

2 files changed

+22
-4
lines changed

README.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,21 +29,39 @@ async function readConfig(path) {
2929
}
3030

3131
readConfig("/ContentManagement/ContentManagementAggregator");
32+
33+
// {
34+
// "dev": {
35+
// "db": {
36+
// "username": "dev-user",
37+
// "password": "secret-password"
38+
// },
39+
// "tags": ["dev", "database"],
40+
// "ids": ["12", "42", "128"],
41+
// "objs": [{ "entry": "1" }, { "entry": "2" }, { "entry": "3" }]
42+
// },
43+
// "prod": {
44+
// "db": {
45+
// "username": "prod-user",
46+
// "password": "super-secret-password"
47+
// }
48+
// }
49+
// };
3250
```
3351

3452
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.
3553

3654
| Name | Type | Key ID | Value |
3755
| ---- | ---- | ------ | ----- |
3856
| `/ContentManagement/ContentManagementAggregator/dev/db/username` | String | - | dev-user |
39-
| `/ContentManagement/ContentManagementAggregator/dev/db/password` | SecureString | arn:aws:kms:us-east-2:123456789012:key/1a2b3c4d-1a2b-1a2b-1a2b-1a2b3c4d5e | secret-password |
57+
| `/ContentManagement/ContentManagementAggregator/dev/db/password` | SecureString | arn:aws:kms:us-east-2:123456789012:key/1a2b3c4d-1a2b-1a2b-1a2b-1a2b3c4d5e | "secret-password" |
4058
| `/ContentManagement/ContentManagementAggregator/dev/tags` | StringList | - | "dev", "database" |
4159
| `/ContentManagement/ContentManagementAggregator/dev/ids` | StringList | - | "12", "42", "128" |
4260
| `/ContentManagement/ContentManagementAggregator/dev/objs/0/entry` | String | - | "1" |
4361
| `/ContentManagement/ContentManagementAggregator/dev/objs/1/entry` | String | - | "2" |
4462
| `/ContentManagement/ContentManagementAggregator/dev/objs/2/entry` | String | - | "3" |
45-
| `/ContentManagement/ContentManagementAggregator/prod/db/username` | String | - | prod-user |
46-
| `/ContentManagement/ContentManagementAggregator/prod/db/password` | SecureString | arn:aws:kms:us-east-2:123456789012:key/1a2b3c4d-1a2b-1a2b-1a2b-1a2b3c4d5e | super-secret-password |
63+
| `/ContentManagement/ContentManagementAggregator/prod/db/username` | String | - | "prod-user" |
64+
| `/ContentManagement/ContentManagementAggregator/prod/db/password` | SecureString | arn:aws:kms:us-east-2:123456789012:key/1a2b3c4d-1a2b-1a2b-1a2b-1a2b3c4d5e | "super-secret-password" |
4765

4866
## Parameter Store Json Writer Configuration
4967

test/AwsParameterStoreJsonReader_test.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -252,4 +252,4 @@ describe('AwsParameterStoreJsonReader', () => {
252252
});
253253
});
254254

255-
});
255+
});

0 commit comments

Comments
 (0)