You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: tests/0.12/TEST-latest.md
+13-13Lines changed: 13 additions & 13 deletions
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ Stuff before terraform-docs
8
8
| Name | Description | Type | Default | Required |
9
9
|------|-------------|:----:|:-----:|:-----:|
10
10
| allocated\_storage | The allocated storage in gigabytes | string | n/a | yes |
11
-
| backup\_window | The daily time range (in UTC) during which automated backups are created if they are enabled. Example: '09:46-10:16'. Must not overlap with maintenance\_window | string | n/a | yes |
11
+
| backup\_window | The daily time range \(in UTC\) during which automated backups are created if they are enabled. Example: '09:46-10:16'. Must not overlap with maintenance\_window | string | n/a | yes |
12
12
| engine | The database engine to use | string | n/a | yes |
13
13
| engine\_version | The engine version to use | string | n/a | yes |
14
14
| identifier | The name of the RDS instance, if omitted, Terraform will assign a random, unique identifier | string | n/a | yes |
@@ -24,7 +24,7 @@ Stuff before terraform-docs
24
24
| auto\_minor\_version\_upgrade | Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window | bool |`"true"`| no |
25
25
| availability\_zone | The Availability Zone of the RDS instance | string |`""`| no |
26
26
| backup\_retention\_period | The days to retain backups for | number |`"1"`| no |
27
-
| character\_set\_name | (Optional) The character set name to use for DB encoding in Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS for more information | string |`""`| no |
27
+
| character\_set\_name |\(Optional\) The character set name to use for DB encoding in Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS for more information | string |`""`| no |
28
28
| computed\_egress\_rules | List of computed egress rules to create by name | list(string) |`[]`| no |
29
29
| computed\_egress\_with\_cidr\_blocks | List of computed egress rules to create where 'cidr\_blocks' is used | list(map(string)) |`[]`| no |
30
30
| computed\_egress\_with\_ipv6\_cidr\_blocks | List of computed egress rules to create where 'ipv6\_cidr\_blocks' is used | list(map(string)) |`[]`| no |
@@ -35,7 +35,7 @@ Stuff before terraform-docs
35
35
| computed\_ingress\_with\_ipv6\_cidr\_blocks | List of computed ingress rules to create where 'ipv6\_cidr\_blocks' is used | list(map(string)) |`[]`| no |
36
36
| computed\_ingress\_with\_self | List of computed ingress rules to create where 'self' is defined | list(map(string)) |`[]`| no |
37
37
| computed\_ingress\_with\_source\_security\_group\_id | List of computed ingress rules to create where 'source\_security\_group\_id' is used | list(map(string)) |`[]`| no |
38
-
| copy\_tags\_to\_snapshot | On delete, copy all Instance tags to the final snapshot (if final\_snapshot\_identifier is specified) | bool |`"false"`| no |
38
+
| copy\_tags\_to\_snapshot | On delete, copy all Instance tags to the final snapshot \(if final\_snapshot\_identifier is specified\)| bool |`"false"`| no |
39
39
| create | Whether to create security group and all rules | bool |`"true"`| no |
40
40
| create\_db\_instance | Whether to create a database instance | bool |`"true"`| no |
41
41
| create\_db\_option\_group | Whether to create a database option group | bool |`"true"`| no |
@@ -48,19 +48,19 @@ Stuff before terraform-docs
48
48
| description | Description of security group | string |`"Security Group managed by Terraform"`| no |
49
49
| egress\_cidr\_blocks | List of IPv4 CIDR ranges to use on all egress rules | list(string) |`[ "0.0.0.0/0" ]`| no |
50
50
| egress\_ipv6\_cidr\_blocks | List of IPv6 CIDR ranges to use on all egress rules | list(string) |`[ "::/0" ]`| no |
51
-
| egress\_prefix\_list\_ids | List of prefix list IDs (for allowing access to VPC endpoints) to use on all egress rules | list(string) |`[]`| no |
51
+
| egress\_prefix\_list\_ids | List of prefix list IDs \(for allowing access to VPC endpoints\) to use on all egress rules | list(string) |`[]`| no |
52
52
| egress\_rules | List of egress rules to create by name | list(string) |`[]`| no |
53
53
| egress\_with\_cidr\_blocks | List of egress rules to create where 'cidr\_blocks' is used | list(map(string)) |`[]`| no |
54
54
| egress\_with\_ipv6\_cidr\_blocks | List of egress rules to create where 'ipv6\_cidr\_blocks' is used | list(map(string)) |`[]`| no |
55
55
| egress\_with\_self | List of egress rules to create where 'self' is defined | list(map(string)) |`[]`| no |
56
56
| egress\_with\_source\_security\_group\_id | List of egress rules to create where 'source\_security\_group\_id' is used | list(map(string)) |`[]`| no |
57
-
| enabled\_cloudwatch\_logs\_exports | List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine): alert, audit, error, general, listener, slowquery, trace, postgresql (PostgreSQL), upgrade (PostgreSQL). | list(string) |`[]`| no |
57
+
| enabled\_cloudwatch\_logs\_exports | List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values \(depending on engine\): alert, audit, error, general, listener, slowquery, trace, postgresql \(PostgreSQL\), upgrade \(PostgreSQL\). | list(string) |`[]`| no |
58
58
| family | The family of the DB parameter group | string |`""`| no |
59
59
| final\_snapshot\_identifier | The name of your final DB snapshot when this DB instance is deleted. | string |`"null"`| no |
60
-
| iam\_database\_authentication\_enabled | Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled | bool |`"false"`| no |
60
+
| iam\_database\_authentication\_enabled | Specifies whether or mappings of AWS Identity and Access Management \(IAM\) accounts to database accounts is enabled | bool |`"false"`| no |
61
61
| ingress\_cidr\_blocks | List of IPv4 CIDR ranges to use on all ingress rules | list(string) |`[]`| no |
62
62
| ingress\_ipv6\_cidr\_blocks | List of IPv6 CIDR ranges to use on all ingress rules | list(string) |`[]`| no |
63
-
| ingress\_prefix\_list\_ids | List of prefix list IDs (for allowing access to VPC endpoints) to use on all ingress rules | list(string) |`[]`| no |
63
+
| ingress\_prefix\_list\_ids | List of prefix list IDs \(for allowing access to VPC endpoints\) to use on all ingress rules | list(string) |`[]`| no |
64
64
| ingress\_rules | List of ingress rules to create by name | list(string) |`[]`| no |
65
65
| ingress\_with\_cidr\_blocks | List of ingress rules to create where 'cidr\_blocks' is used | list(map(string)) |`[]`| no |
66
66
| ingress\_with\_ipv6\_cidr\_blocks | List of ingress rules to create where 'ipv6\_cidr\_blocks' is used | list(map(string)) |`[]`| no |
@@ -91,18 +91,18 @@ Stuff before terraform-docs
91
91
| options | A list of Options to apply. | any |`[]`| no |
92
92
| parameter\_group\_description | Description of the DB parameter group to create | string |`""`| no |
93
93
| parameter\_group\_name | Name of the DB parameter group to associate or create | string |`""`| no |
94
-
| parameters | A list of DB parameters (map) to apply | list(map(string)) |`[]`| no |
94
+
| parameters | A list of DB parameters \(map\) to apply | list(map(string)) |`[]`| no |
95
95
| publicly\_accessible | Bool to control if instance is publicly accessible | bool |`"false"`| no |
96
96
| replicate\_source\_db | Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate. | string |`""`| no |
97
97
| skip\_final\_snapshot | Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final\_snapshot\_identifier | bool |`"true"`| no |
98
98
| snapshot\_identifier | Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05. | string |`""`| no |
99
99
| storage\_encrypted | Specifies whether the DB instance is encrypted | bool |`"false"`| no |
100
-
| storage\_type | One of 'standard' (magnetic), 'gp2' (general purpose SSD), or 'io1' (provisioned IOPS SSD). The default is 'io1' if iops is specified, 'standard' if not. Note that this behaviour is different from the AWS web console, where the default is 'gp2'. | string |`"gp2"`| no |
100
+
| storage\_type | One of 'standard' \(magnetic\), 'gp2' \(general purpose SSD\), or 'io1' \(provisioned IOPS SSD\). The default is 'io1' if iops is specified, 'standard' if not. Note that this behaviour is different from the AWS web console, where the default is 'gp2'. | string |`"gp2"`| no |
101
101
| subnet\_ids | A list of VPC subnet IDs | list(string) |`[]`| no |
102
102
| tags | A mapping of tags to assign to all resources | map(string) |`{}`| no |
103
103
| test\_var | This is a test variable | string |`""`| no |
104
-
| timeouts | (Optional) Updated Terraform resource management timeouts. Applies to `aws\_db\_instance` in particular to permit resource management times | map(string) |`{ "create": "40m", "delete": "40m", "update": "80m" }`| no |
105
-
| timezone | (Optional) Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information. | string |`""`| no |
104
+
| timeouts |\(Optional\) Updated Terraform resource management timeouts. Applies to `aws\_db\_instance` in particular to permit resource management times | map(string) |`{ "create": "40m", "delete": "40m", "update": "80m" }`| no |
105
+
| timezone |\(Optional\) Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information. | string |`""`| no |
106
106
| use\_name\_prefix | Whether to use name\_prefix or fixed name. Should be true to able to update security group name after initial creation | bool |`"true"`| no |
107
107
| use\_parameter\_group\_name\_prefix | Whether to use the parameter group name prefix or not | bool |`"true"`| no |
108
108
| vpc\_security\_group\_ids | List of VPC security groups to associate | list(string) |`[]`| no |
@@ -116,10 +116,10 @@ Stuff before terraform-docs
116
116
| this\_db\_instance\_arn | The ARN of the RDS instance |
117
117
| this\_db\_instance\_availability\_zone | The availability zone of the RDS instance |
118
118
| this\_db\_instance\_endpoint | The connection endpoint |
119
-
| this\_db\_instance\_hosted\_zone\_id | The canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record) |
119
+
| this\_db\_instance\_hosted\_zone\_id | The canonical hosted zone ID of the DB instance \(to be used in a Route 53 Alias record\)|
120
120
| this\_db\_instance\_id | The RDS instance ID |
121
121
| this\_db\_instance\_name | The database name |
122
-
| this\_db\_instance\_password | The database password (this password may be old, because Terraform doesn't track it after initial creation) |
122
+
| this\_db\_instance\_password | The database password \(this password may be old, because Terraform doesn't track it after initial creation\)|
123
123
| this\_db\_instance\_port | The database port |
124
124
| this\_db\_instance\_resource\_id | The RDS Resource ID of this instance |
125
125
| this\_db\_instance\_status | The RDS instance status |
0 commit comments