Terraform module to provision AWS RDS replica instances. These are best suited for reporting purposes.
IMPORTANT It is not possible to create a read replica for a DB Instance that belongs to an Aurora DB Cluster.
This project is part of our comprehensive "SweetOps" approach towards DevOps.
It's 100% Open Source and licensed under the APACHE2.
We literally have hundreds of terraform modules that are Open Source and well-maintained. Check them out!
The module will create an RDS replica instance:
- RDS Replica instance (MySQL, Postgres, SQL Server, Oracle)
- RDS Subnet Group
- RDS DB Security Group
- DNS Record in Route53 for the DB endpoint
module "rds_replica" {
source = "git::https://github.com/cloudposse/terraform-aws-rds-replica.git?ref=master"
namespace = "eg"
stage = "prod"
name = "reporting"
replicate_source_db = "eg-prod-db
dns_zone_id = "Z89FN1IW975KPE"
host_name = "reporting"
security_group_ids = ["sg-xxxxxxxx"]
database_port = 3306
multi_az = "true"
storage_type = "gp2"
storage_encrypted = "true"
instance_class = "db.t2.medium"
publicly_accessible = "false"
subnet_ids = ["subnet-xxxxxxxxx", "subnet-xxxxxxxxx"]
vpc_id = "vpc-xxxxxxxx"
auto_minor_version_upgrade = "true"
allow_major_version_upgrade = "false"
apply_immediately = "false"
maintenance_window = "Mon:03:00-Mon:04:00"
skip_final_snapshot = "false"
copy_tags_to_snapshot = "true"
backup_retention_period = 7
backup_window = "22:00-03:00"
}Available targets:
help Help screen
help/all Display help for all targets
help/short This help short screen
lint Lint terraform code
| Name | Description | Type | Default | Required |
|---|---|---|---|---|
| allow_major_version_upgrade | Allow major version upgrade | string | false |
no |
| apply_immediately | Specifies whether any database modifications are applied immediately, or during the next maintenance window | string | false |
no |
| attributes | Additional attributes (e.g. 1) |
list | <list> |
no |
| auto_minor_version_upgrade | Allow automated minor version upgrade (e.g. from Postgres 9.5.3 to Postgres 9.5.4) | string | true |
no |
| backup_retention_period | Backup retention period in days. Must be > 0 to enable backups | string | 0 |
no |
| backup_window | When AWS can perform DB snapshots, can't overlap with maintenance window | string | 22:00-03:00 |
no |
| copy_tags_to_snapshot | Copy tags from DB to a snapshot | string | true |
no |
| database_port | Database port (e.g. 3306 for MySQL). Used in the DB Security Group to allow access to the DB instance from the provided security_group_ids |
string | - | yes |
| db_parameter | A list of DB parameters to apply. Note that parameters may differ from a DB family to another | list | <list> |
no |
| delimiter | Delimiter to be used between name, namespace, stage and attributes |
string | - |
no |
| dns_zone_id | The ID of the DNS Zone in Route53 where a new DNS record will be created for the DB host name | string | `` | no |
| enabled | Set to false to prevent the module from creating any resources | string | true |
no |
| final_snapshot_identifier | Final snapshot identifier e.g.: some-db-final-snapshot-2015-06-26-06-05 | string | `` | no |
| host_name | The DB host name created in Route53 | string | db |
no |
| instance_class | Class of RDS instance | string | - | yes |
| iops | The amount of provisioned IOPS. Setting this implies a storage_type of 'io1'. Default is 0 if rds storage type is not 'io1' | string | 0 |
no |
| kms_key_id | The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN | string | `` | no |
| maintenance_window | The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi' UTC | string | Mon:03:00-Mon:04:00 |
no |
| monitoring_interval | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. Valid Values are 0, 1, 5, 10, 15, 30, 60. | string | 0 |
no |
| multi_az | Set to true if multi AZ deployment must be supported | string | false |
no |
| name | The Name of the application or solution (e.g. bastion or portal) |
string | - | yes |
| namespace | Namespace (e.g. eg or cp) |
string | - | yes |
| parameter_group_name | Name of the DB parameter group to associate | string | `` | no |
| publicly_accessible | Determines if database can be publicly available (NOT recommended) | string | false |
no |
| replicate_source_db | Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate. Note that if you are creating a cross-region replica of an encrypted database you will also need to specify a kms_key_id. See DB Instance Replication and Working with PostgreSQL and MySQL Read Replicas for more information on using Replication. | string | - | yes |
| same_region | Whether this replica is in the same region as the master. | string | false |
no |
| security_group_ids | The IDs of the security groups from which to allow ingress traffic to the DB instance |
list | <list> |
no |
| skip_final_snapshot | If true (default), no snapshot will be made before deleting DB | string | true |
no |
| snapshot_identifier | Snapshot identifier e.g: rds:production-2015-06-26-06-05. If specified, the module create cluster from the snapshot | string | `` | no |
| stage | Stage (e.g. prod, dev, staging) |
string | - | yes |
| storage_encrypted | Specifies whether the DB instance is encrypted. The default is false if not specified. | string | false |
no |
| storage_type | One of 'standard' (magnetic), 'gp2' (general purpose SSD), or 'io1' (provisioned IOPS SSD). | string | standard |
no |
| subnet_ids | List of subnets for the DB | list | - | yes |
| tags | Additional tags (e.g. map(BusinessUnit,XYZ) |
map | <map> |
no |
| vpc_id | VPC ID the DB instance will be created in | string | - | yes |
| Name | Description |
|---|---|
| hostname | DNS host name of the instance |
| instance_address | Address of the instance |
| instance_endpoint | DNS Endpoint of the instance |
| instance_id | ID of the instance |
| security_group_id | ID of the Security Group |
| subnet_group_id | ID of the Subnet Group |
Like this project? Please give it a ★ on our GitHub! (it helps us a lot)
Are you using this project or any of our other projects? Consider leaving a testimonial. =)
Check out these related projects.
- terraform-aws-rds - Terraform module to provision AWS RDS instances for MySQL or Postgres
- terraform-aws-rds-cluster - Terraform module to provision an RDS Aurora cluster for MySQL or Postgres
- terraform-aws-rds-cloudwatch-sns-alarms - Terraform module that configures important RDS alerts using CloudWatch and sends them to an SNS topic
Got a question?
File a GitHub issue, send us an email or join our Slack Community.
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.
Are you interested in custom Terraform module development? Submit your inquiry using our form today and we'll get back to you ASAP.
Join our Open Source Community on Slack. It's FREE 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 totally sweet infrastructure.
Signup for our newsletter that covers everything on our technology radar. Receive updates on what we're up to on GitHub as well as awesome new projects we discover.
Please use the issue tracker to report any bugs or file feature requests.
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 © 2017-2019 Cloud Posse, LLC
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.
All other trademarks referenced herein are the property of their respective owners.
This project is maintained and funded by Cloud Posse, LLC. Like it? Please let us know by leaving a testimonial!
We're a DevOps Professional Services company based in Los Angeles, CA. We ❤️ Open Source Software.
We offer paid support on all of our projects.
Check out our other projects, follow us on twitter, apply for a job, or hire us to help with your cloud strategy and implementation.
 Erik Osterman |
 Andriy Knysh |
|---|