README.yaml

---
#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#

# Name of this project
name: Terraform AWS Mysql

# License of this project
license: "APACHE"

# Canonical GitHub repo
github_repo: clouddrove/terraform-aws-mysql

# Badges to display
badges:
  - name: "Latest Release"
    image: "https://img.shields.io/github/release/clouddrove/terraform-aws-mysql.svg"
    url: "https://github.com/clouddrove/terraform-aws-mysql/releases/latest"
  - name: "tfsec"
    image: "https://github.com/clouddrove/terraform-aws-mysql/actions/workflows/tfsec.yml/badge.svg"
    url: "https://github.com/clouddrove/terraform-aws-mysql/actions/workflows/tfsec.yml"
  - name: "Licence"
    image: "https://img.shields.io/badge/License-APACHE-blue.svg"
    url: "LICENSE.md"
  - name: "Changelog"
    image: "https://img.shields.io/badge/Changelog-blue"
    url: "CHANGELOG.md"

prerequesties:
  - name: Terraform
    url: https://learn.hashicorp.com/terraform/getting-started/install.html
    version: ">= 1.6.6"

providers:
  - name: aws
    url: https://aws.amazon.com/
    version: ">= 5.31.0"

module_dependencies:
  - name: Labels Module
    url: https://github.com/clouddrove/terraform-aws-labels
    description: Provides resource tagging.

#  description of this project
description: |-
  Terraform module which creates RDS Aurora database resources on AWS and can create different type of databases. Currently it supports MySQL.

# How to use this project
usage : |-
  Here are some examples of how you can use this module in your inventory structure:

  ### COMPLETE MSSQL
  ```hcl
    module "sqlserver" {
    source     = "clouddrove/mysql/aws"
    version    = "1.3.0"

    name        = "sqlserver"
    environment = "test"
    label_order = ["environment", "name"]

    engine            = "sqlserver-ee"
    engine_version    = "15.00"
    instance_class    = "db.t3.small"
    engine_name        = "sqlserver-ee"
    allocated_storage = 20
    timezone          = "GMT Standard Time"
    license_model             = "license-included"

    # DB Details
    db_name = "mssql"
    username      = "admin"
    password      = "esfsgcGdfawAhdxtfjm!"
    port          = "1433"
    maintenance_window = "Mon:00:00-Mon:03:00"
    backup_window      = "03:00-06:00"
    multi_az           = true

    ####----------------------------------------------------------------------------------
    ## Below A security group controls the traffic that is allowed to reach and leave the resources that it is associated with.
    ####----------------------------------------------------------------------------------
    vpc_id        = module.vpc.vpc_id
    allowed_ip    = [module.vpc.vpc_cidr_block]
    allowed_ports = [1433]

    # disable backups to create DB faster
    backup_retention_period = 7

    enabled_cloudwatch_logs_exports = ["error"]
    enabled_cloudwatch_log_group = false

    # DB subnet group
    subnet_ids          = module.subnets.private_subnet_id
    publicly_accessible = false

    # DB parameter group
    family = "sqlserver-ee-15.0"

    # DB option group
    major_engine_version = "15.00"

    ###ssm parameter
    ssm_parameter_endpoint_enabled = true
   }
  ```

  ### COMPLETE MYSQL
  ```hcl
    module "Mysql" {
    source     = "clouddrove/mysql/aws"
    version    = "1.3.0"

    name        = "mysql"
    environment = "test"
    label_order = ["environment", "name"]

    engine            = "mysql"
    engine_version    = "8.0.28"
    instance_class    = "db.t2.small"
    allocated_storage = 5

    ####----------------------------------------------------------------------------------
    ## Below A security group controls the traffic that is allowed to reach and leave the resources that it is associated with.
    ####----------------------------------------------------------------------------------
    vpc_id        = module.vpc.vpc_id
    allowed_ip    = [module.vpc.vpc_cidr_block]
    allowed_ports = [3306]

    # DB Details
    db_name  = "test"
    username = "user"
    password = "esfsgcGdfawAhdxtfjm!"
    port     = "3306"

    maintenance_window = "Mon:00:00-Mon:03:00"
    backup_window      = "03:00-06:00"
    multi_az           = false

    # disable backups to create DB faster
    backup_retention_period = 1

    enabled_cloudwatch_logs_exports = ["audit", "general"]

    # DB subnet group
    subnet_ids          = module.subnets.public_subnet_id
    publicly_accessible = true

    # DB parameter group
    family = "mysql8.0"

    # DB option group
    major_engine_version = "8.0"

    # Database Deletion Protection
    deletion_protection = false

    parameters = [
      {
        name  = "character_set_client"
        value = "utf8"
      },
      {
        name  = "character_set_server"
        value = "utf8"
      }
    ]

    options = [
      {
        option_name = "MARIADB_AUDIT_PLUGIN"

        option_settings = [
          {
            name  = "SERVER_AUDIT_EVENTS"
            value = "CONNECT"
          },
          {
            name  = "SERVER_AUDIT_FILE_ROTATIONS"
            value = "37"
          },
        ]
      },
    ]

    ssm_parameter_endpoint_enabled = true
   }
  ```

  ### MARIADB
  ```hcl
    module "mariadb" {
    source      = "clouddrove/mysql/aws"
    version     = "1.3.0"
    name        = "mariadb"
    environment = "test"
    label_order = ["environment", "name"]

    engine            = "MariaDB"
    engine_version    = "10.6.10"
    instance_class    = "db.m5.large"
    engine_name = "MariaDB"
    allocated_storage = 50

    # DB Details
    db_name       = "test"
    username      = "user"
    password      = "esfsgcGdfawAhdxtfjm!"
    port          = "3306"

    maintenance_window = "Mon:00:00-Mon:03:00"
    backup_window      = "03:00-06:00"
    multi_az           = false

    ####----------------------------------------------------------------------------------
    ## Below A security group controls the traffic that is allowed to reach and leave the resources that it is associated with.
    ####----------------------------------------------------------------------------------
    vpc_id        = module.vpc.vpc_id
    allowed_ip    = [module.vpc.vpc_cidr_block]
    allowed_ports = [3306]

    family = "mariadb10.6"
    # disable backups to create DB faster
    backup_retention_period = 0

    enabled_cloudwatch_logs_exports = ["audit", "general"]

    # DB subnet group
    subnet_ids          = module.private_subnets.public_subnet_id
    publicly_accessible = true

    # DB option group
    major_engine_version = "10.6"

    # Database Deletion Protection
    deletion_protection = false

    ###ssm parameter
    ssm_parameter_endpoint_enabled = true
  }
  ```

  ### ORANCLE DB
  ```hcl
    module "oracle" {
    source      = "clouddrove/mysql/aws"
    version     = "1.3.0"
    name        = "oracle"
    environment = "test"
    label_order = ["environment", "name"]

    engine            = "oracle-ee"
    engine_version    = "19"
    instance_class    = "db.t3.medium"
    engine_name        = "oracle-ee"
    allocated_storage = 50
    storage_encrypted = true
    family = "oracle-ee-19"
    # DB Details
    db_name = "test"
    username      = "admin"
    password      = "esfsgcGdfawAhdxtfjm!"
    port          = "1521"

    maintenance_window = "Mon:00:00-Mon:03:00"
    backup_window      = "03:00-06:00"
    multi_az           = false

    ####----------------------------------------------------------------------------------
    ## Below A security group controls the traffic that is allowed to reach and leave the resources that it is associated with.
    ####----------------------------------------------------------------------------------
    vpc_id        = module.vpc.vpc_id
    allowed_ip    = [module.vpc.vpc_cidr_block]
    allowed_ports = [1521]

    # disable backups to create DB faster
    backup_retention_period = 0

    enabled_cloudwatch_logs_exports = ["audit"]

    # DB subnet group
    subnet_ids          = module.private_subnets.public_subnet_id
    publicly_accessible = true
    # DB option group
    major_engine_version = "19"

    # Database Deletion Protection
    deletion_protection = false

    ###ssm parameter
    ssm_parameter_endpoint_enabled = true
  }
  ```

  ### POSTGRESQL
  ```hcl
    module "postgresql" {
    source      = "clouddrove/mysql/aws"
    version     = "1.3.0"
    name        = "postgresql"
    environment = "test"
    label_order = ["environment", "name"]

    engine            = "postgres"
    engine_version    = "14.6"
    instance_class    = "db.t3.medium"
    allocated_storage = 50
    engine_name        = "postgres"
    storage_encrypted = true
    family = "postgres14"
    # DB Details
    db_name = "test"
    username      = "dbname"
    password      = "esfsgcGdfawAhdxtfjm!"
    port          = "5432"

    maintenance_window = "Mon:00:00-Mon:03:00"
    backup_window      = "03:00-06:00"
    multi_az           = false

    ####----------------------------------------------------------------------------------
    ## Below A security group controls the traffic that is allowed to reach and leave the resources that it is associated with.
    ####----------------------------------------------------------------------------------
    vpc_id        = module.vpc.vpc_id
    allowed_ip    = [module.vpc.vpc_cidr_block]
    allowed_ports = [5432]

    # disable backups to create DB faster
    backup_retention_period = 0

    enabled_cloudwatch_logs_exports = ["postgresql", "upgrade"]

    # DB subnet group
    subnet_ids          = module.private_subnets.public_subnet_id
    publicly_accessible = true

    # DB option group
    major_engine_version = "14"

    # Database Deletion Protection
    deletion_protection = false

    ###ssm parameter
    ssm_parameter_endpoint_enabled = true
  }
  ```

  ### REPLICA MYSQL
  ```hcl
    module "mysql" {
    source      = "clouddrove/mysql/aws"
    version     = "1.3.0"
    name                   = "rds"
    environment            = "test"
    label_order            = ["environment", "name"]
    enabled                = true
    engine                 = "mysql"
    engine_version         = "8.0"
    instance_class         = "db.t4g.large"
    replica_instance_class = "db.t4g.large"
    allocated_storage      = 20
    identifier             = ""
    snapshot_identifier    = ""
    enabled_read_replica   = true
    kms_key_id             = ""
    enabled_replica        = true

    # DB Details
    db_name  = "replica"
    username = "replica_mysql"
    password = "clkjvnsdikjhdsijfsdli"

    port     = 3306
    maintenance_window = "Mon:00:00-Mon:03:00"
    backup_window       = "03:00-06:00"
    multi_az            = true

    ####----------------------------------------------------------------------------------
    ## Below A security group controls the traffic that is allowed to reach and leave the resources that it is associated with.
    ####----------------------------------------------------------------------------------
    vpc_id        = module.vpc.vpc_id
    allowed_ip    = [module.vpc.vpc_cidr_block]
    allowed_ports = [3306]

    # disable backups to create DB faster
    backup_retention_period = 1

    enabled_cloudwatch_logs_exports = ["general"]

    # DB subnet group
    subnet_ids = module.subnets.public_subnet_id
    publicly_accessible = false

    # DB parameter group
    family = "mysql8.0"

    # DB option group
    major_engine_version       = "8.0"
    auto_minor_version_upgrade = false
    # Snapshot name upon DB deletion

    # Database Deletion Protection
    deletion_protection = false

    ###ssm parameter
    ssm_parameter_endpoint_enabled = true
  }
  ```