Skip to content

Commit d950ad3

Browse files
committed
Reword some variable descriptions.
1 parent 6db2bf9 commit d950ad3

File tree

2 files changed

+12
-11
lines changed

2 files changed

+12
-11
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ Smallest complete fully working example. This example might require extra resour
2929
This terraform module will create:
3030
* an AWS RDS Postgres instance
3131
* a database parameter group
32+
* a database subnet group
3233
* a security group for the rds instance
3334

3435
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
@@ -49,11 +50,11 @@ This terraform module will create:
4950

5051
| Name | Description | Type | Default | Required |
5152
|------|-------------|------|---------|:--------:|
52-
| password | The postgres password | `string` | n/a | yes |
53+
| password | The password for the master DB user. | `string` | n/a | yes |
5354
| rds\_subnet\_ids | VPC subnet IDs in subnet group | `list(string)` | n/a | yes |
54-
| spark\_cluster\_sg\_ids | Security group is attached to the ec2 instances of EMR Spark | `list(string)` | n/a | yes |
55+
| spark\_cluster\_sg\_ids | List of Spark service access security group IDs to allow ingress from | `list(string)` | n/a | yes |
5556
| subnet\_group\_name | The name of the subnet group to add the RDS instance to | `string` | n/a | yes |
56-
| tamr\_vm\_sg\_id | Security group id attached to the tamr vm | `string` | n/a | yes |
57+
| tamr\_vm\_sg\_id | Tamr VM security group ID to allow ingress from | `string` | n/a | yes |
5758
| vpc\_id | VPC ID for the rds security group | `string` | n/a | yes |
5859
| additional\_cidrs | Additional CIDR to connect to RDS Postgres instance | `list(string)` | `[]` | no |
5960
| additional\_tags | Additional tags to set on the RDS instance | `map` | `{}` | no |
@@ -69,11 +70,11 @@ This terraform module will create:
6970
| max\_allocated\_storage | Max allocate storage | `number` | `1000` | no |
7071
| parameter\_group\_family | The family of the DB parameter group | `string` | `"postgres12"` | no |
7172
| parameter\_group\_name | The name of the rds parameter group | `string` | `"rds-postgres-pg"` | no |
72-
| postgres\_name | The name of the postgres instance | `string` | `"tamr_rds_db"` | no |
73+
| postgres\_name | The name of the postgres database to create on the DB instance | `string` | `"tamr_rds_db"` | no |
7374
| security\_group\_name | Name for the security group for the rds instance | `string` | `"tamr_rds_sg"` | no |
7475
| skip\_final\_snapshot | Skip final snapshot | `bool` | `true` | no |
7576
| storage\_type | Storage type (e.g. gp2, io1) | `string` | `"gp2"` | no |
76-
| username | The postgres username | `string` | `"tamr"` | no |
77+
| username | The username for the master DB user. | `string` | `"tamr"` | no |
7778

7879
## Outputs
7980

variables.tf

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
variable "password" {
2-
description = "The postgres password"
2+
description = "The password for the master DB user."
33
type = string
44
}
55

66
variable "username" {
7-
description = "The postgres username"
7+
description = "The username for the master DB user."
88
type = string
99
default = "tamr"
1010
}
1111

1212
variable "postgres_name" {
13-
description = "The name of the postgres instance"
13+
description = "The name of the postgres database to create on the DB instance"
1414
type = string
1515
default = "tamr_rds_db"
1616
}
@@ -23,7 +23,7 @@ variable "parameter_group_name" {
2323

2424
variable "identifier_prefix" {
2525
description = "Identifier prefix for the RDS instance"
26-
type = "string"
26+
type = string
2727
default = "tamr-rds-"
2828
}
2929

@@ -110,12 +110,12 @@ variable "security_group_name" {
110110
}
111111

112112
variable "tamr_vm_sg_id" {
113-
description = "Security group id attached to the tamr vm"
113+
description = "Tamr VM security group ID to allow ingress from"
114114
type = string
115115
}
116116

117117
variable "spark_cluster_sg_ids" {
118-
description = "Security group is attached to the ec2 instances of EMR Spark"
118+
description = "List of Spark service access security group IDs to allow ingress from"
119119
type = list(string)
120120
}
121121

0 commit comments

Comments
 (0)