Skip to content

Commit 43a5966

Browse files
committed
chore: Update README
1 parent 124d452 commit 43a5966

File tree

1 file changed

+52
-14
lines changed

1 file changed

+52
-14
lines changed

README.md

Lines changed: 52 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ A module to create application secrets stored in [AWS Secrets Manager](https://a
88
* [Prerequisites](#prerequisites)
99
* [Example usage](#example-usage)
1010
* [Inputs](#inputs)
11+
* [Secrets](#secrets)
1112
* [Outputs](#outputs)
1213
* [Release](#release)
1314
* [Maintainers](#maintainers)
@@ -24,15 +25,43 @@ module "secrets" {
2425
source = "git::ssh://git@github.com/scribd/terraform-aws-app-secrets.git?ref=main"
2526
2627
app_name = "go-chassis"
27-
secrets = {
28-
"app-env" = "development"
29-
"app-settings-name" = "go-chassis"
30-
"app-database-host" = "[value required]"
31-
"app-database-port" = "3306"
32-
"app-database-name" = "[value required]"
33-
"app-database-username" = "[value required]"
34-
"app-database-password" = "[value required]"
35-
}
28+
secrets = [
29+
{
30+
name = "app-env"
31+
value = "development"
32+
allowed_arns = []
33+
},
34+
{
35+
name = "app-settings-name"
36+
value = "go-chassis"
37+
allowed_arns = []
38+
},
39+
{
40+
name = "app-database-host"
41+
value = "[value required]"
42+
allowed_arn = ["arn:aws:iam::1234567890:role/theirRole"]
43+
},
44+
{
45+
name = "app-database-port"
46+
value = "3306"
47+
allowed_arns = []
48+
},
49+
{
50+
name = "app-database-username"
51+
value = "[value required]"
52+
allowed_arns = []
53+
},
54+
{
55+
name = "app-database-password"
56+
value = "[value required]"
57+
allowed_arns = []
58+
},
59+
{
60+
name = "app-database-name"
61+
value = "[value required]"
62+
allowed_arns = []
63+
}
64+
]
3665
3766
tags = {
3867
department = "engineering"
@@ -49,11 +78,20 @@ module "secrets" {
4978
5079
## Inputs
5180

52-
| Name | Description | Type | Default | Required |
53-
| ----------- | ------------------------ | ----------- | ------- | :-------: |
54-
| app_name | Application name | string | `null` | yes |
55-
| secrets | Key-value map of secrets | map(string) | `null` | yes |
56-
| tags | Key-value map of tags | map(string) | `{}` | no |
81+
| Name | Description | Type | Default | Required |
82+
| ------------ | -------------------------------------- | ------------ | ----------- | --------- |
83+
| `app_name` | Application name | string | `null` | yes |
84+
| `aws_region` | AWS region | string | `us-east-2` | no |
85+
| `secrets` | List of objects of [secrets](#secrets) | list(object) | `null` | yes |
86+
| `tags` | Key-value map of tags | map(string) | `{}` | no |
87+
88+
### Secrets
89+
90+
| Name | Description | Type | Default |
91+
| -------------- | ----------------------------------------------------- | ------ | ------- |
92+
| `name` | Secret name | string | `null` |
93+
| `value` | Secret value | string | `null` |
94+
| `allowed_arns` | List of principal ARNs that have access to the secret | list | `null` |
5795

5896
## Outputs
5997

0 commit comments

Comments
 (0)