Skip to content

Commit 9d5798e

Browse files
author
Eduardo Lopez
authored
Update aws-params-writer to explicitly take a parameters count (#90)
1 parent 57261e8 commit 9d5798e

File tree

29 files changed

+218
-211
lines changed

29 files changed

+218
-211
lines changed

‎aws-acm-cert/README.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -33,20 +33,20 @@ module "cert" {
3333

3434
| Name | Description | Type | Default | Required |
3535
|------|-------------|:----:|:-----:|:-----:|
36-
| aws\_route53\_zone\_id | - | string | - | yes |
37-
| cert\_domain\_name | Like www.foo.bar.com or *.foo.bar.com | string | - | yes |
36+
| aws\_route53\_zone\_id | | string | n/a | yes |
37+
| cert\_domain\_name | Like www.foo.bar.com or *.foo.bar.com | string | n/a | yes |
3838
| cert\_subject\_alternative\_names | A map of <alternative_domain:route53_zone_id> | map | `<map>` | no |
39-
| env | Env for tagging and naming. See [doc](../README.md#consistent-tagging). | string | - | yes |
40-
| owner | Owner for tagging and naming. See [doc](../README.md#consistent-tagging). | string | - | yes |
41-
| project | Project for tagging and naming. See [doc](../README.md#consistent-tagging) | string | - | yes |
42-
| service | Service for tagging and naming. See [doc](../README.md#consistent-tagging). | string | - | yes |
43-
| validation\_record\_ttl | - | string | `60` | no |
39+
| env | Env for tagging and naming. See [doc](../README.md#consistent-tagging). | string | n/a | yes |
40+
| owner | Owner for tagging and naming. See [doc](../README.md#consistent-tagging). | string | n/a | yes |
41+
| project | Project for tagging and naming. See [doc](../README.md#consistent-tagging) | string | n/a | yes |
42+
| service | Service for tagging and naming. See [doc](../README.md#consistent-tagging). | string | n/a | yes |
43+
| validation\_record\_ttl | | string | `"60"` | no |
4444

4545
## Outputs
4646

4747
| Name | Description |
4848
|------|-------------|
49-
| arn | - |
50-
| id | - |
49+
| arn | |
50+
| id | |
5151

5252
<!-- END -->

‎aws-aurora-mysql/README.md

+22-22
Original file line numberDiff line numberDiff line change
@@ -35,34 +35,34 @@ module "db" {
3535

3636
| Name | Description | Type | Default | Required |
3737
|------|-------------|:----:|:-----:|:-----:|
38-
| apply\_immediately | If false changes will not be applied until next maintenance window. | string | `false` | no |
39-
| backtrack\_window | Turns on Backgrack for this many seconds. [Doc](https://aws.amazon.com/blogs/aws/amazon-aurora-backtrack-turn-back-time/) | string | `0` | no |
40-
| database\_name | The name of the database to be created in the cluster. | string | - | yes |
41-
| database\_password | Password for user that will be created. | string | - | yes |
42-
| database\_subnet\_group | The name of an existing database subnet group to use. | string | - | yes |
43-
| database\_username | Default user to be created. | string | - | yes |
38+
| apply\_immediately | If false changes will not be applied until next maintenance window. | string | `"false"` | no |
39+
| backtrack\_window | Turns on Backgrack for this many seconds. [Doc](https://aws.amazon.com/blogs/aws/amazon-aurora-backtrack-turn-back-time/) | string | `"0"` | no |
40+
| database\_name | The name of the database to be created in the cluster. | string | n/a | yes |
41+
| database\_password | Password for user that will be created. | string | n/a | yes |
42+
| database\_subnet\_group | The name of an existing database subnet group to use. | string | n/a | yes |
43+
| database\_username | Default user to be created. | string | n/a | yes |
4444
| db\_parameters | Instance params you can set. [Doc](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Reference.html#AuroraMySQL.Reference.Parameters.Instance) | list | `<list>` | no |
45-
| env | Env for tagging and naming. See [doc](../README.md#consistent-tagging). | string | - | yes |
46-
| iam\_database\_authentication\_enabled | - | string | `false` | no |
47-
| ingress\_cidr\_blocks | A list of CIDR blocks that should be allowed to communicate with this Aurora cluster. | list | - | yes |
48-
| instance\_class | See valid instance types [here](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Managing.Performance.html) | string | `db.t2.small` | no |
49-
| instance\_count | Number of instances to create in this cluster. | string | `1` | no |
50-
| kms\_key\_id | If provided, storage will be encrypted with this key, otherwise an AWS-managed key is used. (Encryption is always on). | string | `` | no |
51-
| owner | Owner for tagging and naming. See [doc](../README.md#consistent-tagging). | string | - | yes |
52-
| performance\_insights\_enabled | - | string | `false` | no |
53-
| project | Project for tagging and naming. See [doc](../README.md#consistent-tagging) | string | - | yes |
54-
| publicly\_accessible | Avoid doing this - it gives access to the open internet. | string | `false` | no |
45+
| env | Env for tagging and naming. See [doc](../README.md#consistent-tagging). | string | n/a | yes |
46+
| iam\_database\_authentication\_enabled | | string | `"false"` | no |
47+
| ingress\_cidr\_blocks | A list of CIDR blocks that should be allowed to communicate with this Aurora cluster. | list | n/a | yes |
48+
| instance\_class | See valid instance types [here](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Managing.Performance.html) | string | `"db.t2.small"` | no |
49+
| instance\_count | Number of instances to create in this cluster. | string | `"1"` | no |
50+
| kms\_key\_id | If provided, storage will be encrypted with this key, otherwise an AWS-managed key is used. (Encryption is always on). | string | `""` | no |
51+
| owner | Owner for tagging and naming. See [doc](../README.md#consistent-tagging). | string | n/a | yes |
52+
| performance\_insights\_enabled | | string | `"false"` | no |
53+
| project | Project for tagging and naming. See [doc](../README.md#consistent-tagging) | string | n/a | yes |
54+
| publicly\_accessible | Avoid doing this - it gives access to the open internet. | string | `"false"` | no |
5555
| rds\_cluster\_parameters | Cluster params you can set. [Doc](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Reference.html#AuroraMySQL.Reference.Parameters.Cluster) | list | `<list>` | no |
56-
| service | Service for tagging and naming. See [doc](../README.md#consistent-tagging). | string | - | yes |
57-
| skip\_final\_snapshot | When you destroy a database RDS will, by default, take snapshot. Set this to skip that step. | string | `false` | no |
58-
| vpc\_id | The id of the existing VPC in which this cluster should be created. | string | - | yes |
56+
| service | Service for tagging and naming. See [doc](../README.md#consistent-tagging). | string | n/a | yes |
57+
| skip\_final\_snapshot | When you destroy a database RDS will, by default, take snapshot. Set this to skip that step. | string | `"false"` | no |
58+
| vpc\_id | The id of the existing VPC in which this cluster should be created. | string | n/a | yes |
5959

6060
## Outputs
6161

6262
| Name | Description |
6363
|------|-------------|
64-
| database\_name | - |
65-
| endpoint | - |
66-
| reader\_endpoint | - |
64+
| database\_name | |
65+
| endpoint | |
66+
| reader\_endpoint | |
6767

6868
<!-- END -->

‎aws-aurora-postgres/README.md

+23-23
Original file line numberDiff line numberDiff line change
@@ -35,35 +35,35 @@ module "db" {
3535

3636
| Name | Description | Type | Default | Required |
3737
|------|-------------|:----:|:-----:|:-----:|
38-
| apply\_immediately | If false changes will not be applied until next maintenance window. | string | `false` | no |
39-
| database\_name | The name of the database to be created in the cluster. | string | - | yes |
40-
| database\_password | Password for user that will be created. | string | - | yes |
41-
| database\_subnet\_group | The name of an existing database subnet group to use. | string | - | yes |
42-
| database\_username | Default user to be created. | string | - | yes |
38+
| apply\_immediately | If false changes will not be applied until next maintenance window. | string | `"false"` | no |
39+
| database\_name | The name of the database to be created in the cluster. | string | n/a | yes |
40+
| database\_password | Password for user that will be created. | string | n/a | yes |
41+
| database\_subnet\_group | The name of an existing database subnet group to use. | string | n/a | yes |
42+
| database\_username | Default user to be created. | string | n/a | yes |
4343
| db\_parameters | Instance params you can set. [Doc](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Reference.html#AuroraPostgreSQL.Reference.Parameters.Instance) | list | `<list>` | no |
44-
| engine\_version | The version of Postgres to use. | string | `9.6` | no |
45-
| env | Env for tagging and naming. See [doc](../README.md#consistent-tagging). | string | - | yes |
46-
| iam\_database\_authentication\_enabled | - | string | `false` | no |
47-
| ingress\_cidr\_blocks | A list of CIDR blocks that should be allowed to communicate with this Aurora cluster. | list | - | yes |
48-
| instance\_class | See valid instance types [here](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Managing.html) | string | `db.r4.large` | no |
49-
| instance\_count | Number of instances to create in this cluster. | string | `1` | no |
50-
| kms\_key\_id | If provided, storage will be encrypted with this key, otherwise an AWS-managed key is used. (Encryption is always on). | string | `` | no |
51-
| owner | Owner for tagging and naming. See [doc](../README.md#consistent-tagging). | string | - | yes |
52-
| performance\_insights\_enabled | - | string | `false` | no |
53-
| project | Project for tagging and naming. See [doc](../README.md#consistent-tagging) | string | - | yes |
54-
| publicly\_accessible | Avoid doing this - it gives access to the open internet. | string | `false` | no |
44+
| engine\_version | The version of Postgres to use. | string | `"9.6"` | no |
45+
| env | Env for tagging and naming. See [doc](../README.md#consistent-tagging). | string | n/a | yes |
46+
| iam\_database\_authentication\_enabled | | string | `"false"` | no |
47+
| ingress\_cidr\_blocks | A list of CIDR blocks that should be allowed to communicate with this Aurora cluster. | list | n/a | yes |
48+
| instance\_class | See valid instance types [here](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Managing.html) | string | `"db.r4.large"` | no |
49+
| instance\_count | Number of instances to create in this cluster. | string | `"1"` | no |
50+
| kms\_key\_id | If provided, storage will be encrypted with this key, otherwise an AWS-managed key is used. (Encryption is always on). | string | `""` | no |
51+
| owner | Owner for tagging and naming. See [doc](../README.md#consistent-tagging). | string | n/a | yes |
52+
| performance\_insights\_enabled | | string | `"false"` | no |
53+
| project | Project for tagging and naming. See [doc](../README.md#consistent-tagging) | string | n/a | yes |
54+
| publicly\_accessible | Avoid doing this - it gives access to the open internet. | string | `"false"` | no |
5555
| rds\_cluster\_parameters | Cluster params you can set. [Doc](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Reference.html#AuroraPostgreSQL.Reference.Parameters.Cluster) | list | `<list>` | no |
56-
| service | Service for tagging and naming. See [doc](../README.md#consistent-tagging). | string | - | yes |
57-
| skip\_final\_snapshot | When you destroy a database RDS will, by default, take snapshot. Set this to skip that step. | string | `false` | no |
58-
| vpc\_id | The id of the existing VPC in which this cluster should be created. | string | - | yes |
56+
| service | Service for tagging and naming. See [doc](../README.md#consistent-tagging). | string | n/a | yes |
57+
| skip\_final\_snapshot | When you destroy a database RDS will, by default, take snapshot. Set this to skip that step. | string | `"false"` | no |
58+
| vpc\_id | The id of the existing VPC in which this cluster should be created. | string | n/a | yes |
5959

6060
## Outputs
6161

6262
| Name | Description |
6363
|------|-------------|
64-
| database\_name | - |
65-
| endpoint | - |
66-
| port | - |
67-
| reader\_endpoint | - |
64+
| database\_name | |
65+
| endpoint | |
66+
| port | |
67+
| reader\_endpoint | |
6868

6969
<!-- END -->

‎aws-aurora/README.md

+29-29
Original file line numberDiff line numberDiff line change
@@ -7,39 +7,39 @@ This is a low-level module for creating AWS Aurora clusters. We strongly reccome
77

88
| Name | Description | Type | Default | Required |
99
|------|-------------|:----:|:-----:|:-----:|
10-
| apply\_immediately | - | string | `false` | no |
11-
| backtrack\_window | - | string | `0` | no |
12-
| database\_name | - | string | - | yes |
13-
| database\_password | - | string | - | yes |
14-
| database\_subnet\_group | - | string | - | yes |
15-
| database\_username | - | string | - | yes |
16-
| db\_parameters | - | list | `<list>` | no |
17-
| enabled\_cloudwatch\_logs\_exports | - | list | `<list>` | no |
18-
| engine | - | string | - | yes |
19-
| engine\_version | - | string | - | yes |
20-
| env | Env for tagging and naming. See [doc](../README.md#consistent-tagging). | string | - | yes |
21-
| iam\_database\_authentication\_enabled | - | string | `true` | no |
22-
| ingress\_cidr\_blocks | - | list | - | yes |
23-
| instance\_class | - | string | `db.t2.small` | no |
24-
| instance\_count | - | string | `1` | no |
25-
| kms\_key\_id | If supplied, RDS will use this key to encrypt data at rest. Empty string means that RDS will use an AWS-managed key. Encryption is always on with this module. | string | `` | no |
26-
| owner | Owner for tagging and naming. See [doc](../README.md#consistent-tagging). | string | - | yes |
27-
| performance\_insights\_enabled | - | string | `true` | no |
28-
| port | - | string | - | yes |
29-
| project | Project for tagging and naming. See [doc](../README.md#consistent-tagging) | string | - | yes |
30-
| publicly\_accessible | - | string | `false` | no |
31-
| rds\_cluster\_parameters | - | list | `<list>` | no |
32-
| service | Service for tagging and naming. See [doc](../README.md#consistent-tagging). | string | - | yes |
33-
| skip\_final\_snapshot | - | string | `false` | no |
34-
| vpc\_id | - | string | - | yes |
10+
| apply\_immediately | | string | `"false"` | no |
11+
| backtrack\_window | | string | `"0"` | no |
12+
| database\_name | | string | n/a | yes |
13+
| database\_password | | string | n/a | yes |
14+
| database\_subnet\_group | | string | n/a | yes |
15+
| database\_username | | string | n/a | yes |
16+
| db\_parameters | | list | `<list>` | no |
17+
| enabled\_cloudwatch\_logs\_exports | | list | `<list>` | no |
18+
| engine | | string | n/a | yes |
19+
| engine\_version | | string | n/a | yes |
20+
| env | Env for tagging and naming. See [doc](../README.md#consistent-tagging). | string | n/a | yes |
21+
| iam\_database\_authentication\_enabled | | string | `"true"` | no |
22+
| ingress\_cidr\_blocks | | list | n/a | yes |
23+
| instance\_class | | string | `"db.t2.small"` | no |
24+
| instance\_count | | string | `"1"` | no |
25+
| kms\_key\_id | If supplied, RDS will use this key to encrypt data at rest. Empty string means that RDS will use an AWS-managed key. Encryption is always on with this module. | string | `""` | no |
26+
| owner | Owner for tagging and naming. See [doc](../README.md#consistent-tagging). | string | n/a | yes |
27+
| performance\_insights\_enabled | | string | `"true"` | no |
28+
| port | | string | n/a | yes |
29+
| project | Project for tagging and naming. See [doc](../README.md#consistent-tagging) | string | n/a | yes |
30+
| publicly\_accessible | | string | `"false"` | no |
31+
| rds\_cluster\_parameters | | list | `<list>` | no |
32+
| service | Service for tagging and naming. See [doc](../README.md#consistent-tagging). | string | n/a | yes |
33+
| skip\_final\_snapshot | | string | `"false"` | no |
34+
| vpc\_id | | string | n/a | yes |
3535

3636
## Outputs
3737

3838
| Name | Description |
3939
|------|-------------|
40-
| database\_name | - |
41-
| endpoint | - |
42-
| port | - |
43-
| reader\_endpoint | - |
40+
| database\_name | |
41+
| endpoint | |
42+
| port | |
43+
| reader\_endpoint | |
4444

4545
<!-- END -->

‎aws-cloudwatch-log-group/README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,17 @@ By default the name is `${var.project}-${var.env}-${var.service}`, but you can o
99

1010
| Name | Description | Type | Default | Required |
1111
|------|-------------|:----:|:-----:|:-----:|
12-
| env | Env for tagging and naming. See [doc](../README.md#consistent-tagging). | string | - | yes |
13-
| log\_group\_name | Name for the log group. If not set, it will be $project-$env-$service} | string | `` | no |
14-
| owner | Owner for tagging and naming. See [doc](../README.md#consistent-tagging). | string | - | yes |
15-
| project | Project for tagging and naming. See [doc](../README.md#consistent-tagging) | string | - | yes |
16-
| service | Service for tagging and naming. See [doc](../README.md#consistent-tagging). | string | - | yes |
12+
| env | Env for tagging and naming. See [doc](../README.md#consistent-tagging). | string | n/a | yes |
13+
| log\_group\_name | Name for the log group. If not set, it will be $project-$env-$service} | string | `""` | no |
14+
| owner | Owner for tagging and naming. See [doc](../README.md#consistent-tagging). | string | n/a | yes |
15+
| project | Project for tagging and naming. See [doc](../README.md#consistent-tagging) | string | n/a | yes |
16+
| service | Service for tagging and naming. See [doc](../README.md#consistent-tagging). | string | n/a | yes |
1717

1818
## Outputs
1919

2020
| Name | Description |
2121
|------|-------------|
22-
| arn | - |
23-
| name | - |
22+
| arn | |
23+
| name | |
2424

2525
<!-- END -->

‎aws-default-vpc-security/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,6 @@ You will need to invoke this module with a properly configured provider for ever
4040

4141
| Name | Description | Type | Default | Required |
4242
|------|-------------|:----:|:-----:|:-----:|
43-
| default\_sg\_lockdown | Restrict default security group to deny all traffic (you can selectively enable traffic with other security groups). | string | `true` | no |
43+
| default\_sg\_lockdown | Restrict default security group to deny all traffic (you can selectively enable traffic with other security groups). | string | `"true"` | no |
4444

4545
<!-- END -->

‎aws-iam-ecs-task-role/README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -25,17 +25,17 @@ output "ecs-role-arn" {
2525

2626
| Name | Description | Type | Default | Required |
2727
|------|-------------|:----:|:-----:|:-----:|
28-
| env | Environment name. For example– dev, staging or prod. | string | - | yes |
29-
| iam\_path | IAM path for the role. | string | `/` | no |
30-
| owner | Email address of the owner. Can be a group address. | string | - | yes |
31-
| project | High-level project, should be unique across the organization. | string | - | yes |
32-
| service | Name of this thing we're running. | string | - | yes |
28+
| env | Environment name. For example– dev, staging or prod. | string | n/a | yes |
29+
| iam\_path | IAM path for the role. | string | `"/"` | no |
30+
| owner | Email address of the owner. Can be a group address. | string | n/a | yes |
31+
| project | High-level project, should be unique across the organization. | string | n/a | yes |
32+
| service | Name of this thing we're running. | string | n/a | yes |
3333

3434
## Outputs
3535

3636
| Name | Description |
3737
|------|-------------|
38-
| arn | - |
39-
| name | - |
38+
| arn | |
39+
| name | |
4040

4141
<!-- END -->

‎aws-iam-group-assume-role/README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -29,17 +29,17 @@ output "group_name" {
2929
| Name | Description | Type | Default | Required |
3030
|------|-------------|:----:|:-----:|:-----:|
3131
| depends\_on | Pseudo depends_on because Terraform modules do not support depends_on | list | `<list>` | no |
32-
| group\_name | The name of the group this module will create. | string | - | yes |
33-
| iam\_path | The IAM path under which the group and policies will be created. Useful for avoiding naming conflicts. | string | `/` | no |
34-
| target\_accounts | List of accounts in which this role should be assume-able. | list | - | yes |
35-
| target\_role | Name of the role to be assume-able. If not specified or given as empty string, then the group name will be used as the role name. | string | `` | no |
32+
| group\_name | The name of the group this module will create. | string | n/a | yes |
33+
| iam\_path | The IAM path under which the group and policies will be created. Useful for avoiding naming conflicts. | string | `"/"` | no |
34+
| target\_accounts | List of accounts in which this role should be assume-able. | list | n/a | yes |
35+
| target\_role | Name of the role to be assume-able. If not specified or given as empty string, then the group name will be used as the role name. | string | `""` | no |
3636
| users | List of user's names who should be added to this group. | list | `<list>` | no |
3737

3838
## Outputs
3939

4040
| Name | Description |
4141
|------|-------------|
42-
| group\_arn | - |
43-
| group\_name | - |
42+
| group\_arn | |
43+
| group\_name | |
4444

4545
<!-- END -->

‎aws-iam-group-console-login/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,13 @@ output "group_name" {
2222

2323
| Name | Description | Type | Default | Required |
2424
|------|-------------|:----:|:-----:|:-----:|
25-
| group\_name | Name of the group to be created. | string | `console-login` | no |
26-
| iam\_path | IAM path under which resources will be created. | string | `/` | no |
25+
| group\_name | Name of the group to be created. | string | `"console-login"` | no |
26+
| iam\_path | IAM path under which resources will be created. | string | `"/"` | no |
2727

2828
## Outputs
2929

3030
| Name | Description |
3131
|------|-------------|
32-
| group\_name | - |
32+
| group\_name | |
3333

3434
<!-- END -->

0 commit comments

Comments
 (0)