Skip to content

Latest commit

 

History

History
103 lines (83 loc) · 3.05 KB

README.md

File metadata and controls

103 lines (83 loc) · 3.05 KB
Raw

tf_aws_aurora

Terraform module for deploying and managing AWS Aurora

This module

  • we encrypt everything and make a kms id for you
  • future enhancement to make kms_key_id optional, so if you do pass it it'll use it, and if you don't it'll create the kms key id for you

Required

  • azs - "A list of Availability Zones in the Region"
  • cluster_size - "Number of cluster instances to create"
  • env - "env to deploy into, should typically dev/staging/prod"
  • name - "Name for the Redis replication group i.e. cmsCommon"
  • subnets - "List of subnet IDs to use in creating RDS subnet group (must already exist)"
  • vpc_id - "VPC ID"
see aws_rds_cluster documentation for these variables
  • database_name
  • master_username
  • master_password

Optional

  • backup_retention_period - "The days to retain backups for defaults to 30"
  • db_port - "defaults to 3306"
  • allowed_cidr - "A list of CIDR addresses that can access the cluster. Defaults to ["127.0.0.1/32"]"
  • allowed_security_groups - "A list of Security Group ID's to allow access to. Defaults to empty list"
  • preferred_backup_window - "The daily time range in UTC during which automated backups are created. Default to 01:00-03:00"
  • instance_class - "Instance class to use when creating RDS cluster. Defaults to db.t2.medium"
  • storage_encrypted - "Defaults to true"
  • apply_immediately - "Defaults to false"
  • iam_database_authentication_enabled - "Whether to enable IAM database authentication. Detaults to false"
  • engine - "Name of the db Engine for Aurora mysql 5.7 use aurora-mysql. Defaults to Aurora mysql 5.6"
  • major_engine_version - "Name of the major engine. Defaults to 5.6"
  • family - "Name of the family db parameter group for 5.7 use aurora-mysql5.7. Defaults to Aurora aurora5.6"

Usage

module "aurora" {
  source = "github.com/terraform-community-modules/tf_aws_aurora?ref=1.0.0"
  azs                     = "${var.azs}"
  env                     = "${var.env}"
  name                    = "thtest"
  subnets                 = "${module.vpc.database_subnets}"
  vpc_id                  = "${module.vpc.vpc_id}"
  cluster_size            = "2"
  allowed_cidr            = ["10.10.10.0/24", "10.10.20.0/24"]
  allowed_security_groups = ["sg-24f4655b"]
  database_name           = "thtest"
  master_username         = "tim"
  master_password         = "test1234"
  backup_retention_period = "1"
  #preferred_backup_window = ""
  
  cluster_parameters = [
    {
      name  = "binlog_checksum"
      value = "NONE"
    },
    {
      name         = "binlog_format"
      value        = "statement"
      apply_method = "pending-reboot"
    }
  ]
  
  db_parameters = [
    {
      name  = "long_query_time"
      value = "2"
    },
    {
      name  = "slow_query_log"
      value = "1"
    }
  ]

}

Outputs

  • rds_cluster_id
  • writer_endpoint
  • reader_endpoint
  • security_group_id

Authors

Tim Hartmann

License