feat: Update DSQL sub-module and example

Author: bryantbiggs

docs/UPGRADE-10.0.md

@@ -8,7 +8,7 @@ If you find a bug, please open an issue with supporting configuration to reprodu
 - Terraform `v1.11` is now minimum supported version to support write-only (`wo_*`) attributes.
 - AWS provider `v6.18` is now minimum supported version
 - The underlying `aws_security_group_rule` resources has been replaced with `aws_vpc_security_group_ingress_rule` and `aws_vpc_security_group_egress_rule` to allow for more flexibility in defining security group rules.
-- `master_password` is no longer supported and only the write-only equivalent is supported (`master_password_wo` and `master_password_wo_version`).
+- `master_password` is no longer supported and only the write-only equivalent is supported (`master_password_wo` and `master_password_wo_version`) ([#513](https://github.com/terraform-aws-modules/terraform-aws-rds-aurora/pull/513))
 
 ## Additional changes
 

examples/dsql/main.tf

@@ -5,7 +5,6 @@ provider "aws" {
 locals {
   name           = "ex-${basename(path.cwd)}"
   region         = "us-east-1"
-  region2        = "us-east-2"
   witness_region = "us-west-2"
 
   tags = {
@@ -22,35 +21,46 @@ locals {
 module "dsql_cluster_1" {
   source = "../../modules/dsql"
 
+  name = "${local.name}-1"
+
+  # For example only
   deletion_protection_enabled = false
-  witness_region              = local.witness_region
-  create_cluster_peering      = true
-  clusters                    = [module.dsql_cluster_2.arn]
+
+  witness_region         = local.witness_region
+  create_cluster_peering = true
+  clusters               = [module.dsql_cluster_2.arn]
 
   timeouts = {
     create = "1h"
   }
 
-  tags = merge(local.tags, { Name = local.name })
+  tags = local.tags
 }
 
 module "dsql_cluster_2" {
   source = "../../modules/dsql"
 
-  region = local.region2
+  region = local.witness_region
 
+  name = "${local.name}-2"
+
+  # For example only
   deletion_protection_enabled = false
-  witness_region              = local.witness_region
-  create_cluster_peering      = true
-  clusters                    = [module.dsql_cluster_1.arn]
+
+  witness_region         = local.region
+  create_cluster_peering = true
+  clusters               = [module.dsql_cluster_1.arn]
 
   tags = merge(local.tags, { Name = local.name })
 }
 
 module "dsql_single_region" {
   source = "../../modules/dsql"
 
+  name = local.name
+
+  # For example only
   deletion_protection_enabled = false
 
-  tags = merge(local.tags, { Name = "single-region" })
+  tags = local.tags
 }

modules/dsql/README.md

@@ -1,6 +1,6 @@
-# DSQL Cluster
+# AWS RDS Aurora DSQL Terraform module
 
-Terraform sub-module which creates DSQL cluster and peering resources.
+Terraform sub-module which creates DSQL resources.
 
 ## Usage
 
@@ -10,25 +10,31 @@ See [DSQL](https://github.com/terraform-aws-modules/terraform-aws-rds-aurora/tre
 module "dsql_cluster_1" {
   source = "../../modules/dsql"
 
-  witness_region              = "us-west-2"
+  name = "dsql-1"
+
+  witness_region              = "us-east-2"
   create_cluster_peering      = true
   clusters                    = [module.dsql_cluster_2.arn]
 
-  tags = { Name = "dsql-1" }
+  tags = {
+    Environment = "production"
+   }
 }
 
 module "dsql_cluster_2" {
   source = "../../modules/dsql"
 
+  region = "us-east-2"
+
+  name = "dsql-2"
+
   witness_region              = "us-west-2"
   create_cluster_peering      = true
   clusters                    = [module.dsql_cluster_1.arn]
 
-  tags = { Name = "dsql-2" }
-
-  providers = {
-    aws = aws.region2
-  }
+  tags = {
+    Environment = "production"
+   }
 }
 ```
 
@@ -66,9 +72,10 @@ No modules.
 | <a name="input_create_cluster_peering"></a> [create\_cluster\_peering](#input\_create\_cluster\_peering) | Whether to create cluster peering | `bool` | `false` | no |
 | <a name="input_deletion_protection_enabled"></a> [deletion\_protection\_enabled](#input\_deletion\_protection\_enabled) | Whether deletion protection is enabled in this cluster | `bool` | `null` | no |
 | <a name="input_kms_encryption_key"></a> [kms\_encryption\_key](#input\_kms\_encryption\_key) | The ARN of the AWS KMS key that encrypts data in the DSQL Cluster, or `AWS_OWNED_KMS_KEY` | `string` | `null` | no |
+| <a name="input_name"></a> [name](#input\_name) | Name used across resources created | `string` | `""` | no |
 | <a name="input_region"></a> [region](#input\_region) | Region where the resource(s) will be managed. Defaults to the Region set in the provider configuration | `string` | `null` | no |
-| <a name="input_tags"></a> [tags](#input\_tags) | A map of tags to be associated with the AWS DSQL Cluster resource | `map(string)` | `{}` | no |
-| <a name="input_timeouts"></a> [timeouts](#input\_timeouts) | Create timeout configuration for the cluster | `any` | `{}` | no |
+| <a name="input_tags"></a> [tags](#input\_tags) | A map of tags to add to all resources | `map(string)` | `{}` | no |
+| <a name="input_timeouts"></a> [timeouts](#input\_timeouts) | Timeout configuration for the cluster | <pre>object({<br/>    create = optional(string)<br/>  })</pre> | `null` | no |
 | <a name="input_witness_region"></a> [witness\_region](#input\_witness\_region) | Witness region for the multi-region clusters. Setting this makes this cluster a multi-region cluster. Changing it recreates the cluster | `string` | `null` | no |
 
 ## Outputs

modules/dsql/main.tf

@@ -1,3 +1,7 @@
+################################################################################
+# Cluster
+################################################################################
+
 resource "aws_dsql_cluster" "this" {
   count = var.create ? 1 : 0
 
@@ -8,14 +12,22 @@ resource "aws_dsql_cluster" "this" {
 
   dynamic "multi_region_properties" {
     for_each = var.witness_region != null ? [true] : []
+
     content {
       witness_region = var.witness_region
     }
   }
 
-  tags = var.tags
+  tags = merge(
+    var.tags,
+    { for k, v in { Name = var.name } : k => v if v != "" }
+  )
 }
 
+################################################################################
+# Cluster Peering
+################################################################################
+
 resource "aws_dsql_cluster_peering" "this" {
   count = var.create && var.create_cluster_peering ? 1 : 0
 
@@ -26,6 +38,6 @@ resource "aws_dsql_cluster_peering" "this" {
   witness_region = var.witness_region
 
   timeouts {
-    create = try(var.timeouts.create, null)
+    create = var.timeouts.create
   }
 }

modules/dsql/outputs.tf

@@ -1,3 +1,7 @@
+################################################################################
+# Cluster
+################################################################################
+
 output "arn" {
   description = "ARN of the cluster"
   value       = try(aws_dsql_cluster.this[0].arn, null)

modules/dsql/variables.tf

@@ -10,6 +10,22 @@ variable "region" {
   default     = null
 }
 
+variable "name" {
+  description = "Name used across resources created"
+  type        = string
+  default     = ""
+}
+
+variable "tags" {
+  description = "A map of tags to add to all resources"
+  type        = map(string)
+  default     = {}
+}
+
+################################################################################
+# Cluster
+################################################################################
+
 variable "deletion_protection_enabled" {
   description = "Whether deletion protection is enabled in this cluster"
   type        = bool
@@ -22,6 +38,10 @@ variable "kms_encryption_key" {
   default     = null
 }
 
+################################################################################
+# Cluster Peering
+################################################################################
+
 variable "create_cluster_peering" {
   description = "Whether to create cluster peering"
   type        = bool
@@ -41,13 +61,9 @@ variable "witness_region" {
 }
 
 variable "timeouts" {
-  description = "Create timeout configuration for the cluster"
-  type        = any
-  default     = {}
-}
-
-variable "tags" {
-  description = "A map of tags to be associated with the AWS DSQL Cluster resource"
-  type        = map(string)
-  default     = {}
+  description = "Timeout configuration for the cluster"
+  type = object({
+    create = optional(string)
+  })
+  default = null
 }

wrappers/dsql/main.tf

@@ -8,8 +8,9 @@ module "wrapper" {
   create_cluster_peering      = try(each.value.create_cluster_peering, var.defaults.create_cluster_peering, false)
   deletion_protection_enabled = try(each.value.deletion_protection_enabled, var.defaults.deletion_protection_enabled, null)
   kms_encryption_key          = try(each.value.kms_encryption_key, var.defaults.kms_encryption_key, null)
+  name                        = try(each.value.name, var.defaults.name, "")
   region                      = try(each.value.region, var.defaults.region, null)
   tags                        = try(each.value.tags, var.defaults.tags, {})
-  timeouts                    = try(each.value.timeouts, var.defaults.timeouts, {})
+  timeouts                    = try(each.value.timeouts, var.defaults.timeouts, null)
   witness_region              = try(each.value.witness_region, var.defaults.witness_region, null)
 }