terraform-aws-rds-cluster

Terraform module to provision an RDS Aurora cluster for MySQL or Postgres.

This project is part of our comprehensive "SweetOps" approach towards DevOps.

It's 100% Open Source and licensed under the APACHE2.

Usage

module "rds_cluster_aurora_postgres" {
  source             = "git::https://github.com/cloudposse/terraform-aws-rds-cluster.git?ref=master"
  name               = "postgres"
  engine             = "aurora-postgresql"
  cluster_family     = "aurora-postgresql9.6"
  cluster_size       = "2"
  namespace          = "eg"
  stage              = "dev"
  admin_user         = "admin1"
  admin_password     = "Test123456789"
  db_name            = "dbname"
  db_port            = "5432"
  instance_type      = "db.r4.large"
  vpc_id             = "vpc-36f54c51"
  availability_zones = ["us-east-1a", "us-east-1b"]
  security_groups    = ["sg-0a6d5a3a"]
  subnets            = ["subnet-705e3115", "subnet-dab9e2f0"]
  zone_id            = "Z19EN1IQ979KPE"
}

With cluster parameters

module "rds_cluster_aurora_mysql" {
  source             = "git::https://github.com/cloudposse/terraform-aws-rds-cluster.git?ref=master"
  engine             = "aurora"
  cluster_family     = "aurora-mysql5.7"
  cluster_size       = "2"
  namespace          = "eg"
  stage              = "dev"
  name               = "db"
  admin_user         = "admin1"
  admin_password     = "Test123456789"
  db_name            = "dbname"
  instance_type      = "db.t2.small"
  vpc_id             = "vpc-xxxxxxx"
  availability_zones = ["us-east-1a", "us-east-1b"]
  security_groups    = ["sg-0a6d5a3a"]
  subnets            = ["subnet-8b03333", "subnet-8b0772a3"]
  zone_id            = "xxxxxxxx"

  cluster_parameters = [
    {
      name  = "character_set_client"
      value = "utf8"
    },
    {
      name  = "character_set_connection"
      value = "utf8"
    },
    {
      name  = "character_set_database"
      value = "utf8"
    },
    {
      name  = "character_set_results"
      value = "utf8"
    },
    {
      name  = "character_set_server"
      value = "utf8"
    },
    {
      name  = "collation_connection"
      value = "uft8_bin"
    },
    {
      name  = "collation_server"
      value = "uft8_bin"
    },
    {
      name         = "lower_case_table_names"
      value        = "1"
      apply_method = "pending-reboot"
    },
    {
      name         = "skip-character-set-client-handshake"
      value        = "1"
      apply_method = "pending-reboot"
    },
  ]
}

With enhanced monitoring

# create IAM role for monitoring
resource "aws_iam_role" "enhanced_monitoring" {
  name               = "rds-cluster-example-1"
  assume_role_policy = "${data.aws_iam_policy_document.enhanced_monitoring.json}"
}

# Attach Amazon's managed policy for RDS enhanced monitoring
resource "aws_iam_role_policy_attachment" "enhanced_monitoring" {
  role       = "${aws_iam_role.enhanced_monitoring.name}"
  policy_arn = "arn:aws:iam::aws:policy/service-role/AmazonRDSEnhancedMonitoringRole"
}

# allow rds to assume this role
data "aws_iam_policy_document" "enhanced_monitoring" {
  statement {
      actions = [
      "sts:AssumeRole",
    ]

    effect = "Allow"

    principals {
      type        = "Service"
      identifiers = ["monitoring.rds.amazonaws.com"]
    }
  }
}

module "rds_cluster_aurora_postgres" {
  source             = "git::https://github.com/cloudposse/terraform-aws-rds-cluster.git?ref=master"
  engine             = "aurora-postgresql"
  cluster_family     = "aurora-postgresql9.6"
  cluster_size       = "2"
  namespace          = "eg"
  stage              = "dev"
  name               = "db"
  admin_user         = "admin1"
  admin_password     = "Test123456789"
  db_name            = "dbname"
  db_port            = "5432"
  instance_type      = "db.r4.large"
  vpc_id             = "vpc-xxxxxxx"
  availability_zones = ["us-east-1a", "us-east-1b"]
  security_groups    = ["sg-0a6d5a3a"]
  subnets            = ["subnet-8b03333", "subnet-8b0772a3"]
  zone_id            = "xxxxxxxx"

  # enable monitoring every 30 seconds
  rds_monitoring_interval = "30"

  # reference iam role created above
  rds_monitoring_role_arn = "${aws_iam_role.enhanced_monitoring.arn}"
}

Makefile Targets

Available targets:

  help                                Help screen
  help/all                            Display help for all targets
  help/short                          This help short screen
  lint                                Lint terraform code

Inputs

Name	Description	Type	Default	Required
admin_password	(Required unless a snapshot_identifier is provided) Password for the master DB user	string	-	yes
admin_user	(Required unless a snapshot_identifier is provided) Username for the master DB user	string	`admin`	no
allowed_cidr_blocks	List of CIDR blocks allowed to access	list	`<list>`	no
apply_immediately	Specifies whether any cluster modifications are applied immediately, or during the next maintenance window	string	`true`	no
attributes	Additional attributes (e.g. `1`)	list	`<list>`	no
availability_zones	List of Availability Zones that instances in the DB cluster can be created in	list	-	yes
backup_window	Daily time range during which the backups happen	string	`07:00-09:00`	no
cluster_family	The family of the DB cluster parameter group	string	`aurora5.6`	no
cluster_parameters	List of DB parameters to apply	list	`<list>`	no
cluster_size	Number of DB instances to create in the cluster	string	`2`	no
db_name	Database name	string	-	yes
db_port	Database port	string	`3306`	no
delimiter	Delimiter to be used between `name`, `namespace`, `stage` and `attributes`	string	`-`	no
enabled	Set to false to prevent the module from creating any resources	string	`true`	no
engine	The name of the database engine to be used for this DB cluster. Valid values: `aurora`, `aurora-postgresql`	string	`aurora`	no
engine_version	The version number of the database engine to use	string	``	no
iam_database_authentication_enabled	Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.	string	`false`	no
instance_type	Instance type to use	string	`db.t2.small`	no
maintenance_window	Weekly time range during which system maintenance can occur, in UTC	string	`wed:03:00-wed:04:00`	no
name	Name of the application	string	-	yes
namespace	Namespace (e.g. `eg` or `cp`)	string	-	yes
publicly_accessible	Set to true if you want your cluster to be publicly accessible (such as via QuickSight)	string	`false`	no
rds_monitoring_interval	Interval in seconds that metrics are collected, 0 to disable (values can only be 0, 1, 5, 10, 15, 30, 60)	string	`0`	no
rds_monitoring_role_arn	The ARN for the IAM role that can send monitoring metrics to CloudWatch Logs	string	``	no
retention_period	Number of days to retain backups for	string	`5`	no
security_groups	List of security groups to be allowed to connect to the DB instance	list	-	yes
skip_final_snapshot	Determines whether a final DB snapshot is created before the DB cluster is deleted	string	`true`	no
snapshot_identifier	Specifies whether or not to create this cluster from a snapshot	string	``	no
stage	Stage (e.g. `prod`, `dev`, `staging`)	string	-	yes
storage_encrypted	Set to true if you want your cluster to be encrypted at rest	string	`false`	no
subnets	List of VPC subnet IDs	list	-	yes
tags	Additional tags (e.g. map(`BusinessUnit`,`XYZ`)	map	`<map>`	no
vpc_id	VPC ID to create the cluster in (e.g. `vpc-a22222ee`)	string	-	yes
zone_id	Route53 parent zone ID. The module will create sub-domain DNS records in the parent zone for the DB master and replicas	string	-	yes

Outputs

Name	Description
arn	Amazon Resource Name (ARN) of cluster
cluster_name	Cluster Identifier
endpoint	The DNS address of the RDS instance
master_host	DB Master hostname
name	Database name
password	Password for the master DB user
reader_endpoint	A read-only endpoint for the Aurora cluster, automatically load-balanced across replicas
replicas_host	Replicas hostname
user	Username for the master DB user

Related Projects

Check out these related projects.

terraform-aws-rds - Terraform module to provision AWS RDS instances
terraform-aws-rds-cloudwatch-sns-alarms - Terraform module that configures important RDS alerts using CloudWatch and sends them to an SNS topic

Help

Got a question?

File a GitHub issue, send us an email or join our Slack Community.

Commercial Support

Work directly with our team of DevOps experts via email, slack, and video conferencing.

We provide commercial support for all of our Open Source projects. As a Dedicated Support customer, you have access to our team of subject matter experts at a fraction of the cost of a full-time engineer.

Questions. We'll use a Shared Slack channel between your team and ours.
Troubleshooting. We'll help you triage why things aren't working.
Code Reviews. We'll review your Pull Requests and provide constructive feedback.
Bug Fixes. We'll rapidly work to fix any bugs in our projects.
Build New Terraform Modules. We'll develop original modules to provision infrastructure.
Cloud Architecture. We'll assist with your cloud strategy and design.
Implementation. We'll provide hands-on support to implement our reference architectures.

Community Forum

Get access to our Open Source Community Forum on Slack. It's FREE to join for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build sweet infrastructure.

Contributing

Bug Reports & Feature Requests

Please use the issue tracker to report any bugs or file feature requests.

Developing

If you are interested in being a contributor and want to get involved in developing this project or help out with our other projects, we would love to hear from you! Shoot us an email.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

Fork the repo on GitHub
Clone the project to your own machine
Commit changes to your own branch
Push your work back up to your fork
Submit a Pull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!

Copyright

License

See LICENSE for full details.

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.