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-rds-replica

# Tags of this project
tags:
  - aws
  - terraform
  - terraform-modules
  - databases
  - rds
  - aws-rds
  - postgres
  - mysql

# Categories of this project
categories:
  - terraform-modules/databases

# Logo for this project
#logo: docs/logo.png

# License of this project
license: "APACHE2"

# Canonical GitHub repo
github_repo: cloudposse/terraform-aws-rds-replica

# Badges to display
badges:
  - name: Latest Release
    image: https://img.shields.io/github/release/cloudposse/terraform-aws-rds-replica.svg?style=for-the-badge
    url: https://github.com/cloudposse/terraform-aws-rds-replica/releases/latest
  - name: Last Updated
    image: https://img.shields.io/github/last-commit/cloudposse/terraform-aws-rds-replica.svg?style=for-the-badge
    url: https://github.com/cloudposse/terraform-aws-rds-replica/commits
  - name: Slack Community
    image: https://slack.cloudposse.com/for-the-badge.svg
    url: https://slack.cloudposse.com

# List any related terraform modules that this module may be used with or that this module depends on.
related:
  - name: "terraform-aws-rds"
    description: "Terraform module to provision AWS RDS instances for MySQL or Postgres"
    url: "https://github.com/cloudposse/terraform-aws-rds"
  - name: "terraform-aws-rds-cluster"
    description: "Terraform module to provision an RDS Aurora cluster for MySQL or Postgres"
    url: "https://github.com/cloudposse/terraform-aws-rds-cluster"
  - name: "terraform-aws-rds-cloudwatch-sns-alarms"
    description: "Terraform module that configures important RDS alerts using CloudWatch and sends them to an SNS topic"
    url: "https://github.com/cloudposse/terraform-aws-rds-cloudwatch-sns-alarms"

# Short description of this project
description: |-
  Terraform module to provision AWS [`RDS`](https://aws.amazon.com/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.

introduction: |-
  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

# How to use this project
usage: |-
  ```hcl
  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"
  }
  ```

include:
  - "docs/targets.md"
  - "docs/terraform.md"

# Contributors to this project
contributors: []