feat: Add serverless functionality (#10)

* fix: update dependencies

* feat: Add ServerlessV2

* terraform-docs: automated action

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Author: ckappen

README.md

@@ -81,6 +81,7 @@ such as extended backups, user management, and autoscaling.
 | <a name="input_enable_enhanced_backups"></a> [enable\_enhanced\_backups](#input\_enable\_enhanced\_backups) | Enable enhanced backups. | `bool` | `true` | no |
 | <a name="input_enabled_cloudwatch_logs_exports"></a> [enabled\_cloudwatch\_logs\_exports](#input\_enabled\_cloudwatch\_logs\_exports) | Set of log types to enable for exporting to CloudWatch logs. | `list(string)` | <pre>[<br>  "audit",<br>  "error",<br>  "general",<br>  "slowquery"<br>]</pre> | no |
 | <a name="input_engine"></a> [engine](#input\_engine) | The engine to use. | `string` | `"aurora-mysql"` | no |
+| <a name="input_engine_mode"></a> [engine\_mode](#input\_engine\_mode) | The engine mode to use. | `string` | `"provisioned"` | no |
 | <a name="input_engine_version"></a> [engine\_version](#input\_engine\_version) | The engine version to use. | `string` | `null` | no |
 | <a name="input_instance_class"></a> [instance\_class](#input\_instance\_class) | The instance type of the RDS instance. | `string` | n/a | yes |
 | <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. | `number` | `60` | no |
@@ -89,6 +90,7 @@ such as extended backups, user management, and autoscaling.
 | <a name="input_port"></a> [port](#input\_port) | The port on which the DB accepts connections. | `number` | `3306` | no |
 | <a name="input_preferred_backup_window"></a> [preferred\_backup\_window](#input\_preferred\_backup\_window) | The daily time range (in UTC) during which automated backups are created if they are enabled. | `string` | `"00:00-02:30"` | no |
 | <a name="input_preferred_maintenance_window"></a> [preferred\_maintenance\_window](#input\_preferred\_maintenance\_window) | The weekly time range during which system maintenance can occur, in (UTC). | `string` | `"Mon:03:00-Mon:04:30"` | no |
+| <a name="input_serverlessv2_scaling_configuration"></a> [serverlessv2\_scaling\_configuration](#input\_serverlessv2\_scaling\_configuration) | The scaling configuration of the Aurora Serverless DB cluster. | <pre>object({<br>    max_capacity = number<br>    min_capacity = number<br>  })</pre> | <pre>{<br>  "max_capacity": null,<br>  "min_capacity": null<br>}</pre> | no |
 | <a name="input_storage_type"></a> [storage\_type](#input\_storage\_type) | Storage type. | `string` | `"aurora"` | no |
 | <a name="input_tags"></a> [tags](#input\_tags) | Tags to add to the AWS RDS Cluster Instance. | `map(any)` | `{}` | no |
 | <a name="input_vpc_security_group_ids_rds_cluster"></a> [vpc\_security\_group\_ids\_rds\_cluster](#input\_vpc\_security\_group\_ids\_rds\_cluster) | List of VPC security groups to associate with the RDS Proxy. | `list(string)` | `null` | no |

main.tf

@@ -31,11 +31,15 @@ module "rds_cluster" {
   # How many read replicas to create
   additional_reader_capacity = var.additional_reader_capacity
 
-  # The engine version to use
+  # The engine
   engine         = var.engine
   engine_version = var.engine_version
+  engine_mode    = var.engine_mode
   database_name  = var.database_name
 
+  # Serverless
+  serverlessv2_scaling_configuration = var.serverlessv2_scaling_configuration
+
   # Network
   db_subnet_group_name   = var.database_subnet_group_name
   vpc_security_group_ids = var.vpc_security_group_ids_rds_cluster

modules/rds_cluster/README.md

@@ -21,7 +21,7 @@
 | <a name="input_deletion_protection"></a> [deletion\_protection](#input\_deletion\_protection) | If the DB instance should have deletion protection enabled. | `bool` | `false` | no |
 | <a name="input_enabled_cloudwatch_logs_exports"></a> [enabled\_cloudwatch\_logs\_exports](#input\_enabled\_cloudwatch\_logs\_exports) | Set of log types to enable for exporting to CloudWatch logs. | `list(string)` | n/a | yes |
 | <a name="input_engine"></a> [engine](#input\_engine) | The engine to use. | `string` | `"aurora-mysql"` | no |
-| <a name="input_engine_mode"></a> [engine\_mode](#input\_engine\_mode) | The database engine mode. Valid values: global, parallelquery, provisioned, serverless | `string` | `"provisioned"` | no |
+| <a name="input_engine_mode"></a> [engine\_mode](#input\_engine\_mode) | The database engine mode. | `string` | n/a | yes |
 | <a name="input_engine_version"></a> [engine\_version](#input\_engine\_version) | The engine version to use. | `string` | n/a | yes |
 | <a name="input_final_snapshot_identifier"></a> [final\_snapshot\_identifier](#input\_final\_snapshot\_identifier) | The name of your final DB snapshot when this DB cluster is deleted. | `string` | `"final-snapshot"` | no |
 | <a name="input_iam_database_authentication_enabled"></a> [iam\_database\_authentication\_enabled](#input\_iam\_database\_authentication\_enabled) | Specifies whether or not mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled. | `bool` | `false` | no |
@@ -31,6 +31,7 @@
 | <a name="input_preferred_backup_window"></a> [preferred\_backup\_window](#input\_preferred\_backup\_window) | The daily time range (in UTC) during which automated backups are created if they are enabled. | `string` | `"00:00-02:30"` | no |
 | <a name="input_preferred_maintenance_window"></a> [preferred\_maintenance\_window](#input\_preferred\_maintenance\_window) | The weekly time range during which system maintenance can occur, in (UTC). | `string` | `"Mon:03:00-Mon:04:30"` | no |
 | <a name="input_replication_source_identifier"></a> [replication\_source\_identifier](#input\_replication\_source\_identifier) | ARN of the source DB cluster or DB instance if this DB cluster is created as a Read Replica. | `string` | `null` | no |
+| <a name="input_serverlessv2_scaling_configuration"></a> [serverlessv2\_scaling\_configuration](#input\_serverlessv2\_scaling\_configuration) | The scaling configuration of the Aurora Serverless DB cluster. | <pre>object({<br>    max_capacity = optional(number)<br>    min_capacity = optional(number)<br>  })</pre> | n/a | yes |
 | <a name="input_skip_final_snapshot"></a> [skip\_final\_snapshot](#input\_skip\_final\_snapshot) | Determines whether a final DB snapshot is created before the DB cluster is deleted. | `bool` | `false` | no |
 | <a name="input_source_region"></a> [source\_region](#input\_source\_region) | The source region for an encrypted replica DB cluster. | `string` | `null` | no |
 | <a name="input_storage_encrypted"></a> [storage\_encrypted](#input\_storage\_encrypted) | Specifies whether the DB cluster is encrypted. | `bool` | `true` | no |
@@ -56,7 +57,7 @@
 ## Resources
 
 - resource.aws_rds_cluster.main (modules/rds_cluster/main.tf#1)
-- resource.random_password.master_password (modules/rds_cluster/main.tf#95)
-- resource.random_string.master_username (modules/rds_cluster/main.tf#89)
+- resource.random_password.master_password (modules/rds_cluster/main.tf#105)
+- resource.random_string.master_username (modules/rds_cluster/main.tf#99)
 - data source.aws_availability_zones.available (modules/rds_cluster/data.tf#1)
 <!-- END_TF_DOCS -->

modules/rds_cluster/main.tf

@@ -63,6 +63,16 @@ resource "aws_rds_cluster" "main" {
   # Security
   deletion_protection = var.deletion_protection
 
+  # Serverless
+  dynamic "serverlessv2_scaling_configuration" {
+    for_each = var.serverlessv2_scaling_configuration == null ? [] : [1]
+    content {
+      max_capacity = var.serverlessv2_scaling_configuration.max_capacity
+      min_capacity = var.serverlessv2_scaling_configuration.min_capacity
+    }
+  }
+
+  # Tags
   tags = merge(
     var.tags,
     {

modules/rds_cluster/variables.tf

@@ -100,8 +100,7 @@ variable "engine" {
 }
 
 variable "engine_mode" {
-  default     = "provisioned"
-  description = "The database engine mode. Valid values: global, parallelquery, provisioned, serverless"
+  description = "The database engine mode."
   type        = string
 }
 
@@ -158,6 +157,14 @@ variable "replication_source_identifier" {
   type        = string
 }
 
+variable "serverlessv2_scaling_configuration" {
+  description = "The scaling configuration of the Aurora Serverless DB cluster."
+  type        = object({
+    max_capacity = optional(number)
+    min_capacity = optional(number)
+  })
+}
+
 variable "source_region" {
   default     = null
   description = "The source region for an encrypted replica DB cluster."

variables.tf

@@ -108,6 +108,12 @@ variable "engine_version" {
   type        = string
 }
 
+variable "engine_mode" {
+  default     = "provisioned"
+  description = "The engine mode to use."
+  type        = string
+}
+
 variable "instance_class" {
   description = "The instance type of the RDS instance."
   type        = string
@@ -193,6 +199,18 @@ variable "port" {
   type        = number
 }
 
+variable "serverlessv2_scaling_configuration" {
+  default = {
+    max_capacity = null
+    min_capacity = null
+  }
+  description = "The scaling configuration of the Aurora Serverless DB cluster."
+  type        = object({
+    max_capacity = number
+    min_capacity = number
+  })
+}
+
 variable "storage_type" {
   default     = "aurora"
   description = "Storage type."