Skip to content

Commit 2b9aa0c

Browse files
authored
feat: Add new parameter monitoring_role_description (#350)
1 parent 397ac22 commit 2b9aa0c

File tree

7 files changed

+26
-8
lines changed

7 files changed

+26
-8
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -280,6 +280,7 @@ Users have the ability to:
280280
| <a name="input_max_allocated_storage"></a> [max\_allocated\_storage](#input\_max\_allocated\_storage) | Specifies the value for Storage Autoscaling | `number` | `0` | no |
281281
| <a name="input_monitoring_interval"></a> [monitoring\_interval](#input\_monitoring\_interval) | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60. | `number` | `0` | no |
282282
| <a name="input_monitoring_role_arn"></a> [monitoring\_role\_arn](#input\_monitoring\_role\_arn) | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. Must be specified if monitoring\_interval is non-zero. | `string` | `null` | no |
283+
| <a name="input_monitoring_role_description"></a> [monitoring\_role\_description](#input\_monitoring\_role\_description) | Description of the monitoring IAM role | `string` | `null` | no |
283284
| <a name="input_monitoring_role_name"></a> [monitoring\_role\_name](#input\_monitoring\_role\_name) | Name of the IAM role which will be created when create\_monitoring\_role is enabled. | `string` | `"rds-monitoring-role"` | no |
284285
| <a name="input_multi_az"></a> [multi\_az](#input\_multi\_az) | Specifies if the RDS instance is multi-AZ | `bool` | `false` | no |
285286
| <a name="input_name"></a> [name](#input\_name) | The DB name to create. If omitted, no database is created initially | `string` | `null` | no |

examples/complete-postgres/main.tf

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,8 @@ module "db" {
9898
performance_insights_retention_period = 7
9999
create_monitoring_role = true
100100
monitoring_interval = 60
101+
monitoring_role_name = "example-monitoring-role-name"
102+
monitoring_role_description = "Description for monitoring role"
101103

102104
parameters = [
103105
{

main.tf

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -111,14 +111,15 @@ module "db_instance" {
111111
performance_insights_retention_period = var.performance_insights_retention_period
112112
performance_insights_kms_key_id = var.performance_insights_enabled ? var.performance_insights_kms_key_id : null
113113

114-
replicate_source_db = var.replicate_source_db
115-
backup_retention_period = var.backup_retention_period
116-
backup_window = var.backup_window
117-
max_allocated_storage = var.max_allocated_storage
118-
monitoring_interval = var.monitoring_interval
119-
monitoring_role_arn = var.monitoring_role_arn
120-
monitoring_role_name = var.monitoring_role_name
121-
create_monitoring_role = var.create_monitoring_role
114+
replicate_source_db = var.replicate_source_db
115+
backup_retention_period = var.backup_retention_period
116+
backup_window = var.backup_window
117+
max_allocated_storage = var.max_allocated_storage
118+
monitoring_interval = var.monitoring_interval
119+
monitoring_role_arn = var.monitoring_role_arn
120+
monitoring_role_name = var.monitoring_role_name
121+
monitoring_role_description = var.monitoring_role_description
122+
create_monitoring_role = var.create_monitoring_role
122123

123124
character_set_name = var.character_set_name
124125
timezone = var.timezone

modules/db_instance/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@ No modules.
6868
| <a name="input_max_allocated_storage"></a> [max\_allocated\_storage](#input\_max\_allocated\_storage) | Specifies the value for Storage Autoscaling | `number` | `0` | no |
6969
| <a name="input_monitoring_interval"></a> [monitoring\_interval](#input\_monitoring\_interval) | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60. | `number` | `0` | no |
7070
| <a name="input_monitoring_role_arn"></a> [monitoring\_role\_arn](#input\_monitoring\_role\_arn) | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. Must be specified if monitoring\_interval is non-zero. | `string` | `null` | no |
71+
| <a name="input_monitoring_role_description"></a> [monitoring\_role\_description](#input\_monitoring\_role\_description) | Description of the monitoring IAM role | `string` | `null` | no |
7172
| <a name="input_monitoring_role_name"></a> [monitoring\_role\_name](#input\_monitoring\_role\_name) | Name of the IAM role which will be created when create\_monitoring\_role is enabled. | `string` | `"rds-monitoring-role"` | no |
7273
| <a name="input_multi_az"></a> [multi\_az](#input\_multi\_az) | Specifies if the RDS instance is multi-AZ | `bool` | `false` | no |
7374
| <a name="input_name"></a> [name](#input\_name) | The DB name to create. If omitted, no database is created initially | `string` | `null` | no |

modules/db_instance/main.tf

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -215,6 +215,7 @@ resource "aws_iam_role" "enhanced_monitoring" {
215215

216216
name = var.monitoring_role_name
217217
assume_role_policy = data.aws_iam_policy_document.enhanced_monitoring.json
218+
description = var.monitoring_role_description
218219

219220
tags = merge(
220221
{

modules/db_instance/variables.tf

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -195,6 +195,12 @@ variable "monitoring_role_name" {
195195
default = "rds-monitoring-role"
196196
}
197197

198+
variable "monitoring_role_description" {
199+
description = "Description of the monitoring IAM role"
200+
type = string
201+
default = null
202+
}
203+
198204
variable "create_monitoring_role" {
199205
description = "Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs."
200206
type = bool

variables.tf

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -183,6 +183,12 @@ variable "monitoring_role_name" {
183183
default = "rds-monitoring-role"
184184
}
185185

186+
variable "monitoring_role_description" {
187+
description = "Description of the monitoring IAM role"
188+
type = string
189+
default = null
190+
}
191+
186192
variable "create_monitoring_role" {
187193
description = "Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs."
188194
type = bool

0 commit comments

Comments
 (0)