Module: `rds`

Terraform module to provision AWS RDS instances

Introduction

The module will create:

DB instance (MySQL, Postgres, SQL Server, Oracle)
DB Option Group (will create a new one or you may use an existing)
DB Parameter Group
DB Subnet Group
DB Security Group
DNS Record in Route53 for the DB endpoint

Usage

module "rds_instance" {
    source = "cloudposse/rds/aws"
    # Cloud Posse recommends pinning every module to a specific version
    # version = "x.x.x"
    namespace                   = "eg"
    stage                       = "prod"
    name                        = "app"
    dns_zone_id                 = "Z89FN1IW975KPE"
    host_name                   = "db"
    security_group_ids          = ["sg-xxxxxxxx"]
    ca_cert_identifier          = "rds-ca-2019"
    allowed_cidr_blocks         = ["XXX.XXX.XXX.XXX/32"]
    database_name               = "wordpress"
    database_user               = "admin"
    database_password           = "xxxxxxxxxxxx"
    database_port               = 3306
    multi_az                    = true
    storage_type                = "gp2"
    allocated_storage           = 100
    storage_encrypted           = true
    engine                      = "mysql"
    engine_version              = "5.7.17"
    major_engine_version        = "5.7"
    instance_class              = "db.t2.medium"
    db_parameter_group          = "mysql5.7"
    option_group_name           = "mysql-options"
    publicly_accessible         = false
    subnet_ids                  = ["sb-xxxxxxxxx", "sb-xxxxxxxxx"]
    vpc_id                      = "vpc-xxxxxxxx"
    snapshot_identifier         = "rds:production-2015-06-26-06-05"
    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"

    db_parameter = [
      { name  = "myisam_sort_buffer_size"   value = "1048576" },
      { name  = "sort_buffer_size"          value = "2097152" }
    ]

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

Character Sets

If you wish to create the database in a specific character set you can use one of the following options depending on your database engine of choice.

For Oracle and Microsoft SQL you can specify charset name as an input variable to this module. For example, for Microsoft SQL, you could use:

module "rds_instance" {
  ...
  charset_name                   = "Korean_Wansung_CI_AS"
  ...
}

For mysql and mariadb engines character set of the database can be defined via db_parameter. In this example the database is created with utf8mb4 (character set) and utf8mb4_unicode_ci (collation):

module "rds_instance" {
  ...
  db_parameter = [
    {
      name = "character_set_server"
      value = "utf8mb4"
      apply_method = "immediate"
    },
    {
      name = "collation_server"
      value = "utf8mb4_unicode_ci"
      apply_method = "immediate"
    }
  ]
  ...
}

Variables

Required Variables

database_port (number) required: 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
db_parameter_group (string) required: The DB parameter group family name. The value depends on DB engine used. See DBParameterGroupFamily for instructions on how to retrieve applicable value.
engine_version (string) required: Database engine version, depends on engine type.
instance_class (string) required: Class of RDS instance
vpc_id (string) required: VPC ID the DB instance will be created in

Optional Variables

allocated_storage (number) optional

The allocated storage in GBs. Required unless a snapshot_identifier or replicate_source_db is provided.

Default value: null

allow_major_version_upgrade (bool) optional

Allow major version upgrade

Default value: false

allowed_cidr_blocks (list(string)) optional

The whitelisted CIDRs which to allow ingress traffic to the DB instance

Default value: [ ]

apply_immediately (bool) optional

Specifies whether any database modifications are applied immediately, or during the next maintenance window

Default value: false

associate_security_group_ids (list(string)) optional

The IDs of the existing security groups to associate with the DB instance

Default value: [ ]

auto_minor_version_upgrade (bool) optional

Allow automated minor version upgrade (e.g. from Postgres 9.5.3 to Postgres 9.5.4)

Default value: true

availability_zone (string) optional

The AZ for the RDS instance. Specify one of subnet_ids, db_subnet_group_name or availability_zone. If availability_zone is provided, the instance will be placed into the default VPC or EC2 Classic

Default value: null

backup_retention_period (number) optional

Backup retention period in days. Must be > 0 to enable backups

Default value: 0

backup_window (string) optional

When AWS can perform DB snapshots, can't overlap with maintenance window

Default value: "22:00-03:00"

ca_cert_identifier (string) optional

The identifier of the CA certificate for the DB instance

Default value: null

charset_name (string) optional

The character set name to use for DB encoding. Oracle & Microsoft SQL only. For other engines use db_parameter

Default value: null

copy_tags_to_snapshot (bool) optional

Copy tags from DB to a snapshot

Default value: true

database_manage_master_user_password (bool) optional

Set to true to allow RDS to manage the master user password in Secrets Manager. Ignore if database_password is provided.

Default value: false

database_master_user_secret_kms_key_id (string) optional

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN. If not specified, the default KMS key for your Amazon Web Services account is used.

Default value: null

database_name (string) optional

The name of the database to create when the DB instance is created

Default value: null

database_password (string) optional

Password for the primary DB user. Required unless a snapshot_identifier or replicate_source_db is provided.

Default value: null

database_user (string) optional

Username for the primary DB user. Required unless a snapshot_identifier or replicate_source_db is provided.

Default value: null

db_options optional

A list of DB options to apply with an option group. Depends on DB engine

Type:

list(object({
db_security_group_memberships  = list(string)
option_name                    = string
port                           = number
version                        = string
vpc_security_group_memberships = list(string)

option_settings = list(object({
  name  = string
  value = string
}))
}))

Default value: [ ]

db_parameter optional

A list of DB parameters to apply. Note that parameters may differ from a DB family to another

Type:

list(object({
apply_method = string
name         = string
value        = string
}))

Default value: [ ]

db_subnet_group_name (string) optional

Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. Specify one of subnet_ids, db_subnet_group_name or availability_zone

Default value: null

deletion_protection (bool) optional

Set to true to enable deletion protection on the RDS instance

Default value: false

dns_zone_id (string) optional

The ID of the DNS Zone in Route53 where a new DNS record will be created for the DB host name

Default value: ""

enabled_cloudwatch_logs_exports (list(string)) optional

List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine): alert, audit, error, general, listener, slowquery, trace, postgresql (PostgreSQL), upgrade (PostgreSQL).

Default value: [ ]

engine (string) optional

Database engine type. Required unless a snapshot_identifier or replicate_source_db is provided.

Default value: null

final_snapshot_identifier (string) optional

Final snapshot identifier e.g.: some-db-final-snapshot-2019-06-26-06-05

Default value: ""

host_name (string) optional

The DB host name created in Route53

Default value: "db"

iam_database_authentication_enabled (bool) optional

Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled

Default value: false

iops (number) optional

The amount of provisioned IOPS, only valid for certain values of storage_type.

Default value: null

kms_key_arn (string) optional

The ARN of the existing KMS key to encrypt storage

Default value: ""

license_model (string) optional

License model for this DB. Optional, but required for some DB Engines. Valid values: license-included | bring-your-own-license | general-public-license

Default value: ""

maintenance_window (string) optional

The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi' UTC

Default value: "Mon:03:00-Mon:04:00"

major_engine_version (string) optional

Database MAJOR engine version, depends on engine type

Default value: ""

max_allocated_storage (number) optional

The upper limit to which RDS can automatically scale the storage in GBs

Default value: 0

monitoring_interval (string) optional

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.

Default value: "0"

monitoring_role_arn (string) optional

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs

Default value: null

multi_az (bool) optional

Set to true if multi AZ deployment must be supported

Default value: false

option_group_name (string) optional

Name of the DB option group to associate

Default value: ""

parameter_group_name (string) optional

Name of the DB parameter group to associate

Default value: ""

performance_insights_enabled (bool) optional

Specifies whether Performance Insights are enabled.

Default value: false

performance_insights_kms_key_id (string) optional

The ARN for the KMS key to encrypt Performance Insights data. Once KMS key is set, it can never be changed.

Default value: null

performance_insights_retention_period (number) optional

The amount of time in days to retain Performance Insights data. Either 7 (7 days) or 731 (2 years).

Default value: 7

publicly_accessible (bool) optional

Determines if database can be publicly available (NOT recommended)

Default value: false

replicate_source_db (string) optional

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 (if replicating within a single region) or ARN of the Amazon RDS Database to replicate (if replicating cross-region). 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.

Default value: null

restore_to_point_in_time optional

An object specifying the restore point in time for the DB instance to restore from. Only used when snapshot_identifier is not provided.

Type:

object({
restore_time                             = optional(string, null)
source_db_instance_identifier            = optional(string, null)
source_db_instance_automated_backups_arn = optional(string, null)
source_dbi_resource_id                   = optional(string, null)
use_latest_restorable_time               = optional(bool, null)
})

Default value: null

security_group_ids (list(string)) optional

The IDs of the security groups from which to allow ingress traffic to the DB instance

Default value: [ ]

skip_final_snapshot (bool) optional

If true (default), no snapshot will be made before deleting DB

Default value: true

snapshot_identifier (string) optional

Snapshot identifier e.g: rds:production-2019-06-26-06-05 for automated or manual-backup-2023-11-16 for manual. If specified, the module create the instance from the snapshot.

Default value: null

storage_encrypted (bool) optional

(Optional) Specifies whether the DB instance is encrypted. The default is false if not specified

Default value: true

storage_throughput (number) optional

The storage throughput value for the DB instance. Can only be set when storage_type is gp3. Cannot be specified if the allocated_storage value is below a per-engine threshold.

Default value: null

storage_type (string) optional

One of 'standard' (magnetic), 'gp2' (general purpose SSD), 'gp3' (general purpose SSD), or 'io1' (provisioned IOPS SSD)

Default value: "standard"

subnet_ids (list(string)) optional

List of subnet IDs for the DB. DB instance will be created in the VPC associated with the DB subnet group provisioned using the subnet IDs. Specify one of subnet_ids, db_subnet_group_name or availability_zone

Default value: [ ]

timeouts optional

A list of DB timeouts to apply to the running code while creating, updating, or deleting the DB instance.

Type:

object({
create = string
update = string
delete = string
})

Default value:

{
  "create": "40m",
  "delete": "60m",
  "update": "80m"
}

timezone (string) optional

Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information.

Default value: null

Context Variables

The following variables are defined in the context.tf file of this module and part of the terraform-null-label pattern.

additional_tag_map (map(string)) optional

Additional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id.
This is for some rare cases where resources want additional configuration of tags
and therefore take a list of maps with tag key, value, and additional configuration.

Required: No

Default value: { }

attributes (list(string)) optional

ID element. Additional attributes (e.g. workers or cluster) to add to id,
in the order they appear in the list. New attributes are appended to the
end of the list. The elements of the list are joined by the delimiter
and treated as a single ID element.

Required: No

Default value: [ ]

context (any) optional

Single object for setting entire context at once.
See description of individual variables for details.
Leave string and numeric variables as null to use default value.
Individual variable settings (non-null) override settings in context object,
except for attributes, tags, and additional_tag_map, which are merged.

Required: No

Default value:

{
  "additional_tag_map": {},
  "attributes": [],
  "delimiter": null,
  "descriptor_formats": {},
  "enabled": true,
  "environment": null,
  "id_length_limit": null,
  "label_key_case": null,
  "label_order": [],
  "label_value_case": null,
  "labels_as_tags": [
    "unset"
  ],
  "name": null,
  "namespace": null,
  "regex_replace_chars": null,
  "stage": null,
  "tags": {},
  "tenant": null
}

delimiter (string) optional

Delimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.

Required: No

Default value: null

descriptor_formats (any) optional

Describe additional descriptors to be output in the descriptors output map.
Map of maps. Keys are names of descriptors. Values are maps of the form
\{<br/> format = string<br/> labels = list(string)<br/> \}
(Type is any so the map values can later be enhanced to provide additional options.)
format is a Terraform format string to be passed to the format() function.
labels is a list of labels, in order, to pass to format() function.
Label values will be normalized before being passed to format() so they will be
identical to how they appear in id.
Default is {} (descriptors output will be empty).

Required: No

Default value: { }

enabled (bool) optional

Set to false to prevent the module from creating any resources
Required: No

Default value: null

environment (string) optional

ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'
Required: No

Default value: null

id_length_limit (number) optional

Limit id to this many characters (minimum 6).
Set to 0 for unlimited length.
Set to null for keep the existing setting, which defaults to 0.
Does not affect id_full.

Required: No

Default value: null

label_key_case (string) optional

Controls the letter case of the tags keys (label names) for tags generated by this module.
Does not affect keys of tags passed in via the tags input.
Possible values: lower, title, upper.
Default value: title.

Required: No

Default value: null

label_order (list(string)) optional

The order in which the labels (ID elements) appear in the id.
Defaults to ["namespace", "environment", "stage", "name", "attributes"].
You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.

Required: No

Default value: null

label_value_case (string) optional

Controls the letter case of ID elements (labels) as included in id,
set as tag values, and output by this module individually.
Does not affect values of tags passed in via the tags input.
Possible values: lower, title, upper and none (no transformation).
Set this to title and set delimiter to "" to yield Pascal Case IDs.
Default value: lower.

Required: No

Default value: null

labels_as_tags (set(string)) optional

Set of labels (ID elements) to include as tags in the tags output.
Default is to include all labels.
Tags with empty values will not be included in the tags output.
Set to [] to suppress all generated tags.
Notes:
The value of the name tag, if included, will be the id, not the name.
Unlike other null-label inputs, the initial setting of labels_as_tags cannot be
changed in later chained modules. Attempts to change it will be silently ignored.

Required: No

Default value:

[
  "default"
]

name (string) optional

ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.
This is the only ID element not also included as a tag.
The "name" tag is set to the full id string. There is no tag with the value of the name input.

Required: No

Default value: null

namespace (string) optional

ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique
Required: No

Default value: null

regex_replace_chars (string) optional

Terraform regular expression (regex) string.
Characters matching the regex will be removed from the ID elements.
If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.

Required: No

Default value: null

stage (string) optional

ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'
Required: No

Default value: null

tags (map(string)) optional

Additional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.

Required: No

Default value: { }

tenant (string) optional

ID element (Rarely used, not included by default). A customer identifier, indicating who this instance of a resource is for
Required: No

Default value: null

Outputs

hostname: DNS host name of the instance
instance_address: Address of the instance
instance_arn: ARN of the instance
instance_endpoint: DNS Endpoint of the instance
instance_id: ID of the instance
master_user_secret: Secret object if configured with var.database_manage_master_user_password = true.
option_group_id: ID of the Option Group
parameter_group_id: ID of the Parameter Group
resource_id: The RDS Resource ID of this instance.
security_group_id: ID of the Security Group
subnet_group_id: ID of the created Subnet Group

Dependencies

Requirements

terraform, version: >= 1.3
aws, version: >= 5.0

Providers

aws, version: >= 5.0

Modules

Name	Version	Source	Description
`dns_host_name`	0.12.2	`cloudposse/route53-cluster-hostname/aws`	n/a
`final_snapshot_label`	0.25.0	`cloudposse/label/null`	n/a
`this`	0.25.0	`cloudposse/label/null`	n/a

Resources

The following resources are used by this module:

aws_db_instance.default (resource)
aws_db_option_group.default (resource)
aws_db_parameter_group.default (resource)
aws_db_subnet_group.default (resource)
aws_security_group.default (resource)
aws_security_group_rule.egress (resource)
aws_security_group_rule.ingress_cidr_blocks (resource)
aws_security_group_rule.ingress_security_groups (resource)

Data Sources

The following data sources are used by this module:

Module: rds

Introduction​

Usage​

Character Sets​

Variables​

Required Variables​

Optional Variables​

Context Variables​

Outputs​

Dependencies​

Requirements​

Providers​

Modules​

Resources​

Data Sources​

Module: `rds`

Introduction

Usage

Character Sets

Variables

Required Variables

Optional Variables

Context Variables

Outputs

Dependencies

Requirements

Providers

Modules

Resources

Data Sources