feat(modules): rds sub-module

Author: saumitra-dev

modules/rds/.header.md

@@ -0,0 +1,3 @@
+# rds
+
+This sub-module creates an RDS instance.

modules/rds/main.tf

@@ -0,0 +1,56 @@
+resource "aws_db_instance" "this" {
+  identifier = var.identifier
+
+  instance_class    = var.instance_class
+  storage_type      = var.storage_type
+  allocated_storage = var.allocated_storage
+
+  engine                 = var.engine
+  engine_version         = var.engine_version
+  vpc_security_group_ids = var.vpc_security_group_ids
+
+  db_subnet_group_name = aws_db_subnet_group.this.name
+  parameter_group_name = aws_db_parameter_group.this.name
+
+  db_name                     = var.db_name
+  username                    = var.username
+  manage_master_user_password = var.manage_master_user_password
+
+  skip_final_snapshot = var.skip_final_snapshot
+
+  tags = var.tags
+}
+
+################################################################################
+# DB Subnet Group
+################################################################################
+
+resource "aws_db_subnet_group" "this" {
+  name        = var.db_subnet_group_name
+  description = var.db_subnet_group_description
+  subnet_ids  = var.db_subnet_group_subnet_ids
+
+  tags = var.db_subnet_group_tags
+}
+
+################################################################################
+# DB Parameter Group
+################################################################################
+
+resource "aws_db_parameter_group" "this" {
+  name        = var.db_parameter_group_name
+  description = var.db_parameter_group_description
+  family      = var.db_parameter_group_family
+
+  dynamic "parameter" {
+    for_each = var.db_parameter_group_parameters
+
+    content {
+      name         = parameter.value.name
+      value        = parameter.value.value
+      apply_method = try(parameter.value.apply_method, null)
+    }
+  }
+
+  tags = var.db_parameter_group_tags
+}

modules/rds/outputs.tf

@@ -0,0 +1,47 @@
+output "id" {
+  description = "RDS DBI resource ID."
+  value       = aws_db_instance.this.id
+}
+
+output "arn" {
+  description = "The ARN of the RDS instance."
+  value       = aws_db_instance.this.arn
+}
+
+output "endpoint" {
+  description = "The connection endpoint in `address:port` format."
+  value       = aws_db_instance.this.endpoint
+}
+
+output "master_user_secret" {
+  description = "Details of the secret containing the database master password."
+  value       = aws_db_instance.this.master_user_secret[0]
+}
+
+################################################################################
+# DB Subnet Group
+################################################################################
+
+output "db_subnet_group_id" {
+  description = "The db subnet group name."
+  value       = aws_db_subnet_group.this.id
+}
+
+output "db_subnet_group_arn" {
+  description = "The ARN of the db subnet group."
+  value       = aws_db_subnet_group.this.arn
+}
+
+################################################################################
+# DB Parameter Group
+################################################################################
+
+output "db_parameter_group_id" {
+  description = "The db parameter group name."
+  value       = aws_db_parameter_group.this.id
+}
+
+output "db_parameter_group_arn" {
+  description = "The ARN of the db parameter group."
+  value       = aws_db_parameter_group.this.arn
+}

modules/rds/variables.tf

@@ -0,0 +1,151 @@
+variable "identifier" {
+  description = "(Required) The name of the RDS instance."
+  type        = string
+  nullable    = false
+}
+
+variable "instance_class" {
+  description = "(Required) The instance type of the RDS instance."
+  type        = string
+  nullable    = false
+}
+
+variable "storage_type" {
+  description = "(Optional, Default:\"gp2\") One of \"standard\", \"gp2\", \"gp3\" or \"io1\"."
+  type        = string
+  nullable    = false
+  default     = "gp2"
+}
+
+variable "allocated_storage" {
+  description = "(Required) The allocated storage in gibibytes."
+  type        = number
+  nullable    = false
+}
+
+variable "engine" {
+  description = "(Optional, Default:null) The database engine."
+  type        = string
+  default     = null
+}
+
+variable "engine_version" {
+  description = "(Optional, Default:null) The engine version to use."
+  type        = string
+  default     = null
+}
+
+variable "db_name" {
+  description = "(Optional, Default:default_db) The database name."
+  type        = string
+  nullable    = false
+  default     = "default_db"
+}
+
+variable "username" {
+  description = "(Optional, Default:admin_user) Username for the master DB user."
+  type        = string
+  nullable    = false
+  default     = "admin_user"
+}
+
+variable "manage_master_user_password" {
+  description = "(Optional, Default:true) Set to true to allow RDS to manage the master user password in Secrets Manager."
+  type        = bool
+  nullable    = false
+  default     = true
+}
+
+variable "vpc_security_group_ids" {
+  description = "(Optional) List of VPC security groups to associate."
+  type        = list(string)
+  nullable    = false
+  default     = []
+}
+
+variable "skip_final_snapshot" {
+  description = "(Optional, Default:false) Determines whether a final DB snapshot is created before the DB instance is deleted."
+  type        = bool
+  nullable    = false
+  default     = false
+}
+
+variable "tags" {
+  description = "(Optional) A map of tags to assign to the resource."
+  type        = map(string)
+  nullable    = false
+  default     = {}
+}
+
+################################################################################
+# DB Subnet Group
+################################################################################
+
+variable "db_subnet_group_name" {
+  description = "(Required, Forces new resource) The name of the DB subnet group."
+  type        = string
+  nullable    = false
+}
+
+variable "db_subnet_group_description" {
+  description = "(Optional, Default:\"Managed By Terraform\", Forces new resource) The description of the DB subnet group."
+  type        = string
+  nullable    = false
+  default     = "Managed By Terraform"
+}
+
+variable "db_subnet_group_subnet_ids" {
+  description = "(Required) A list of VPC subnet IDs."
+  type        = list(string)
+  nullable    = false
+}
+
+variable "db_subnet_group_tags" {
+  description = "(Optional, Default:{}) A map of tags to assign to the resource."
+  type        = map(string)
+  nullable    = false
+  default     = {}
+}
+
+################################################################################
+# DB Parameter Group
+################################################################################
+
+variable "db_parameter_group_name" {
+  description = "(Required, Forces new resource) The name of the DB parameter group."
+  type        = string
+  nullable    = false
+}
+
+variable "db_parameter_group_description" {
+  description = "(Optional, Default:\"Managed By Terraform\", Forces new resource) The description of the DB parameter group."
+  type        = string
+  nullable    = false
+  default     = "Managed By Terraform"
+}
+
+variable "db_parameter_group_family" {
+  description = "(Required, Forces new resource) The family of the DB parameter group."
+  type        = string
+  nullable    = false
+}
+
+variable "db_parameter_group_parameters" {
+  description = "(Optional, Default:[]) The DB parameters to apply."
+  type = list(
+    object({
+      name         = string
+      value        = string
+      apply_method = optional(string)
+    })
+  )
+  nullable = false
+  default  = []
+}
+
+variable "db_parameter_group_tags" {
+  description = "(Optional, Default:{}) A map of tags to assign to the resource."
+  type        = map(string)
+  nullable    = false
+  default     = {}
+}

modules/rds/version.tf

@@ -0,0 +1,10 @@
+terraform {
+  required_version = ">= 1.8.4"
+
+  required_providers {
+    aws = {
+      source  = "hashicorp/aws"
+      version = "~> 5.0"
+    }
+  }
+}