This component is responsible for provisioning an RDS instance. It seeds relevant database information (hostnames, username, password, etc.) into AWS SSM Parameter Store.

Security Groups Guidance:

By default this component creates a client security group and adds that security group id to the default attached security group. Ideally other AWS resources that require RDS access can be granted this client security group. Additionally you can grant access via specific CIDR blocks or security group ids.

Usage

Stack Level: Regional

Here's an example snippet for how to use this component.

PostgreSQL

components:
  terraform:
    rds/defaults:
      metadata:
        type: abstract
      vars:
        enabled: true
        use_fullname: false
        name: my-postgres-db
        instance_class: db.t3.micro
        database_name: my-postgres-db
        # database_user: admin # enable to specify something specific
        engine: postgres
        engine_version: "15.2"
        database_port: 5432
        db_parameter_group: "postgres15"
        allocated_storage: 10 #GBs
        ssm_enabled: true
        client_security_group_enabled: true
        ## The following settings allow the database to be accessed from anywhere
        # publicly_accessible: true
        # use_private_subnets: false
        # allowed_cidr_blocks:
        #  - 0.0.0.0/0

Microsoft SQL

components:
  terraform:
    rds:
      vars:
        enabled: true
        name: mssql
        # SQL Server 2017 Enterprise
        engine: sqlserver-ee
        engine_version: "14.00.3356.20"
        db_parameter_group: "sqlserver-ee-14.0"
        license_model: license-included
        # Required for MSSQL
        database_name: null
        database_port: 1433
        database_user: mssql
        instance_class: db.t3.xlarge
        # There are issues with enabling this
        multi_az: false
        allocated_storage: 20
        publicly_accessible: false
        ssm_enabled: true
        # This does not seem to work correctly
        deletion_protection: false

Provisioning from a snapshot

The snapshot identifier variable can be added to provision an instance from a snapshot HOWEVER- Keep in mind these instances are provisioned from a unique kms key per rds. For clean terraform runs, you must first provision the key for the destination instance, then copy the snapshot using that kms key.

Example - I want a new instance rds-example-new to be provisioned from a snapshot of rds-example-old:

1. Use the console to manually make a snapshot of rds instance rds-example-old
2. provision the kms key for rds-example-new

atmos terraform plan  rds-example-new -s ue1-staging '-target=module.kms_key_rds.aws_kms_key.default[0]'
atmos terraform apply rds-example-new -s ue1-staging '-target=module.kms_key_rds.aws_kms_key.default[0]'

1. Use the console to copy the snapshot to a new name using the above provisioned kms key
2. Add snapshot_identifier variable to rds-example-new catalog and specify the newly copied snapshot that used the above key
3. Post provisioning, remove the snapshot_idenfier variable and verify terraform runs clean for the copied instance

Requirements

Name	Version
terraform	>= 1.0.0
aws	>= 4.0
random	>= 2.3

Providers

Name	Version
aws	>= 4.0
random	>= 2.3

Modules

Name	Source	Version
dns_gbl_delegated	cloudposse/stack-config/yaml//modules/remote-state	1.5.0
eks	cloudposse/stack-config/yaml//modules/remote-state	1.5.0
iam_roles	../account-map/modules/iam-roles	n/a
kms_key_rds	cloudposse/kms-key/aws	0.12.1
rds_client_sg	cloudposse/security-group/aws	2.2.0
rds_instance	cloudposse/rds/aws	1.1.0
rds_monitoring_role	cloudposse/iam-role/aws	0.17.0
this	cloudposse/label/null	0.25.0
vpc	cloudposse/stack-config/yaml//modules/remote-state	1.5.0

Resources

Name	Type
aws_ssm_parameter.rds_database_hostname	resource
aws_ssm_parameter.rds_database_password	resource
aws_ssm_parameter.rds_database_port	resource
aws_ssm_parameter.rds_database_user	resource
random_password.database_password	resource
random_pet.database_user	resource
aws_caller_identity.current	data source
aws_iam_policy_document.kms_key_rds	data source

Inputs

Name	Description	Type	Default	Required
additional_tag_map	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.	map(string)	{}	no
allocated_storage	The allocated storage in GBs	number	n/a	yes
allow_major_version_upgrade	Allow major version upgrade	bool	false	no
allowed_cidr_blocks	The whitelisted CIDRs which to allow ingress traffic to the DB instance	list(string)	[]	no
apply_immediately	Specifies whether any database modifications are applied immediately, or during the next maintenance window	bool	false	no
associate_security_group_ids	The IDs of the existing security groups to associate with the DB instance	list(string)	[]	no
attributes	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.	list(string)	[]	no
auto_minor_version_upgrade	Allow automated minor version upgrade (e.g. from Postgres 9.5.3 to Postgres 9.5.4)	bool	true	no
availability_zone	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	string	null	no
backup_retention_period	Backup retention period in days. Must be > 0 to enable backups	number	0	no
backup_window	When AWS can perform DB snapshots, can't overlap with maintenance window	string	"22:00-03:00"	no
ca_cert_identifier	The identifier of the CA certificate for the DB instance	string	null	no
charset_name	The character set name to use for DB encoding. Oracle & Microsoft SQL only. For other engines use db_parameter	string	null	no
client_security_group_enabled	create a client security group and include in attached default security group	bool	true	no
context	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.	any	{ "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 }	no
copy_tags_to_snapshot	Copy tags from DB to a snapshot	bool	true	no
database_name	The name of the database to create when the DB instance is created	string	n/a	yes
database_password	Database password for the admin user	string	""	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	number	n/a	yes
database_user	Database admin user name	string	""	no
db_options	A list of DB options to apply with an option group. Depends on DB engine	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 })) }))	[]	no
db_parameter	A list of DB parameters to apply. Note that parameters may differ from a DB family to another	list(object({ apply_method = string name = string value = string }))	[]	no
db_parameter_group	The DB parameter group family name. The value depends on DB engine used. See DBParameterGroupFamily for instructions on how to retrieve applicable value.	string	n/a	yes
db_subnet_group_name	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	string	null	no
deletion_protection	Set to true to enable deletion protection on the RDS instance	bool	false	no
delimiter	Delimiter to be used between ID elements. Defaults to - (hyphen). Set to "" to use no delimiter at all.	string	null	no
descriptor_formats	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).	any	{}	no
dns_gbl_delegated_environment_name	The name of the environment where global dns_delegated is provisioned	string	"gbl"	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	bool	null	no
enabled_cloudwatch_logs_exports	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).	list(string)	[]	no
engine	Database engine type	string	n/a	yes
engine_version	Database engine version, depends on engine type	string	n/a	yes
environment	ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'	string	null	no
final_snapshot_identifier	Final snapshot identifier e.g.: some-db-final-snapshot-2019-06-26-06-05	string	""	no
host_name	The DB host name created in Route53	string	"db"	no
iam_database_authentication_enabled	Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled	bool	false	no
id_length_limit	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.	number	null	no
instance_class	Class of RDS instance	string	n/a	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'	number	0	no
kms_alias_name_ssm	KMS alias name for SSM	string	"alias/aws/ssm"	no
kms_key_arn	The ARN of the existing KMS key to encrypt storage	string	""	no
label_key_case	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.	string	null	no
label_order	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.	list(string)	null	no
label_value_case	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.	string	null	no
labels_as_tags	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.	set(string)	[ "default" ]	no
license_model	License model for this DB. Optional, but required for some DB Engines. Valid values: license-included | bring-your-own-license | general-public-license	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
major_engine_version	Database MAJOR engine version, depends on engine type	string	""	no
max_allocated_storage	The upper limit to which RDS can automatically scale the storage in GBs	number	0	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
monitoring_role_arn	The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs	string	null	no
multi_az	Set to true if multi AZ deployment must be supported	bool	false	no
name	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.	string	null	no
namespace	ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique	string	null	no
option_group_name	Name of the DB option group to associate	string	""	no
parameter_group_name	Name of the DB parameter group to associate	string	""	no
performance_insights_enabled	Specifies whether Performance Insights are enabled.	bool	false	no
performance_insights_kms_key_id	The ARN for the KMS key to encrypt Performance Insights data. Once KMS key is set, it can never be changed.	string	null	no
performance_insights_retention_period	The amount of time in days to retain Performance Insights data. Either 7 (7 days) or 731 (2 years).	number	7	no
publicly_accessible	Determines if database can be publicly available (NOT recommended)	bool	false	no
regex_replace_chars	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.	string	null	no
region	AWS Region	string	n/a	yes
replicate_source_db	If the rds db instance is a replica, supply the source database identifier here	any	null	no
security_group_ids	The IDs of the security groups from which to allow ingress traffic to the DB instance	list(string)	[]	no
skip_final_snapshot	If true (default), no snapshot will be made before deleting DB	bool	true	no
snapshot_identifier	Snapshot identifier e.g: rds:production-2019-06-26-06-05. If specified, the module create cluster from the snapshot	string	null	no
ssm_enabled	If true create SSM keys for the database user and password.	bool	false	no
ssm_key_format	SSM path format. The values will will be used in the following order: var.ssm_key_prefix, var.name, var.ssm_key_*	string	"/%v/%v/%v"	no
ssm_key_hostname	The SSM key to save the hostname. See var.ssm_path_format.	string	"admin/db_hostname"	no
ssm_key_password	The SSM key to save the password. See var.ssm_path_format.	string	"admin/db_password"	no
ssm_key_port	The SSM key to save the port. See var.ssm_path_format.	string	"admin/db_port"	no
ssm_key_prefix	SSM path prefix. Omit the leading forward slash /.	string	"rds"	no
ssm_key_user	The SSM key to save the user. See var.ssm_path_format.	string	"admin/db_user"	no
stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	string	null	no
storage_encrypted	(Optional) Specifies whether the DB instance is encrypted. The default is false if not specified	bool	true	no
storage_throughput	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.	number	null	no
storage_type	One of 'standard' (magnetic), 'gp2' (general purpose SSD), or 'io1' (provisioned IOPS SSD)	string	"standard"	no
tags	Additional tags (e.g. {'BusinessUnit': 'XYZ'}). Neither the tag keys nor the tag values will be modified by this module.	map(string)	{}	no
tenant	ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for	string	null	no
timezone	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.	string	null	no
use_dns_delegated	Use the dns-delegated dns_zone_id	bool	false	no
use_eks_security_group	Use the eks default security group	bool	false	no
use_private_subnets	Use private subnets	bool	true	no

Outputs

Name	Description
exports	Map of exports for use in deployment configuration templates
kms_key_alias	The KMS key alias
psql_helper	A helper output to use with psql for connecting to this RDS instance.
rds_address	Address of the instance
rds_arn	ARN of the instance
rds_database_ssm_key_prefix	SSM prefix
rds_endpoint	DNS Endpoint of the instance
rds_hostname	DNS host name of the instance
rds_id	ID of the instance
rds_name	RDS DB name
rds_option_group_id	ID of the Option Group
rds_parameter_group_id	ID of the Parameter Group
rds_port	RDS DB port
rds_resource_id	The RDS Resource ID of this instance.
rds_security_group_id	ID of the Security Group
rds_subnet_group_id	ID of the created Subnet Group

References

• cloudposse/terraform-aws-components - Cloud Posse's upstream component

Tip

👽 Use Atmos with Terraform

Cloud Posse uses atmos to easily orchestrate multiple environments using Terraform.
Works with Github Actions, Atlantis, or Spacelift.

Watch demo of using Atmos with Terraform

Example of running atmos to manage infrastructure from our Quick Start tutorial.

Related Projects

Check out these related projects.

• Cloud Posse Terraform Modules - Our collection of reusable Terraform modules used by our reference architectures.
• Atmos - Atmos is like docker-compose but for your infrastructure

Tip

Use Terraform Reference Architectures for AWS

Use Cloud Posse's ready-to-go terraform architecture blueprints for AWS to get up and running quickly.

✅ We build it together with your team.
✅ Your team owns everything.
✅ 100% Open Source and backed by fanatical support.

📚 Learn More

Cloud Posse is the leading DevOps Accelerator for funded startups and enterprises.

Your team can operate like a pro today.

Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed.

Day-0: Your Foundation for Success

• Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
• Deployment Strategy. Adopt a proven deployment strategy with GitHub Actions, enabling automated, repeatable, and reliable software releases.
• Site Reliability Engineering. Gain total visibility into your applications and services with Datadog, ensuring high availability and performance.
• Security Baseline. Establish a secure environment from the start, with built-in governance, accountability, and comprehensive audit logs, safeguarding your operations.
• GitOps. Empower your team to manage infrastructure changes confidently and efficiently through Pull Requests, leveraging the full power of GitHub Actions.

Day-2: Your Operational Mastery

• Training. Equip your team with the knowledge and skills to confidently manage the infrastructure, ensuring long-term success and self-sufficiency.
• Support. Benefit from a seamless communication over Slack with our experts, ensuring you have the support you need, whenever you need it.
• Troubleshooting. Access expert assistance to quickly resolve any operational challenges, minimizing downtime and maintaining business continuity.
• Code Reviews. Enhance your team’s code quality with our expert feedback, fostering continuous improvement and collaboration.
• Bug Fixes. Rely on our team to troubleshoot and resolve any issues, ensuring your systems run smoothly.
• Migration Assistance. Accelerate your migration process with our dedicated support, minimizing disruption and speeding up time-to-value.
• Customer Workshops. Engage with our team in weekly workshops, gaining insights and strategies to continuously improve and innovate.

✨ Contributing

This project is under active development, and we encourage contributions from our community.

Many thanks to our outstanding contributors:

For 🐛 bug reports & feature requests, please use the issue tracker.

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

1. Review our Code of Conduct and Contributor Guidelines.
2. Fork the repo on GitHub
3. Clone the project to your own machine
4. Commit changes to your own branch
5. Push your work back up to your fork
6. 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!

🌎 Slack Community

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.

📰 Newsletter

Sign up for our newsletter and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know. Dropped straight into your Inbox every week — and usually a 5-minute read.

📆 Office Hours

Join us every Wednesday via Zoom for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a live Q&A that you can’t find anywhere else. It's FREE for everyone!

License

Preamble to the Apache License, Version 2.0

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.

Trademarks

All other trademarks referenced herein are the property of their respective owners.

---

Copyright © 2017-2025 Cloud Posse, LLC