rds-cluster

cloudposse/rds-cluster/aws

Terraform Module HCL AWS

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

Install
module "rds-cluster" {
source = "cloudposse/rds-cluster/aws"
version = "2.4.0"
}
⭐ Source on GitHub 📦 Registry page
README

Terraform module to provision an RDS Aurora cluster for MySQL or Postgres. Supports Amazon Aurora Serverless. > [!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. > Usage For a complete example, see examples/complete. For automated tests of the complete example using bats and Terratest (which tests and deploys the example on AWS), see test. Basic example ```hcl module "rds_cluster_aurora_postgres" { source = "cloudposse/rds-cluster/aws" # Cloud Posse recommends pinning every module to a specific version # version = "x.x.x" name = "po

Inputs (50)
NameTypeDescriptionDefault
subnetslist(string)List of VPC subnet IDs required
enginestringThe name of the database engine to be used for this DB cluster. Valid values: `a"aurora"
engine_versionstringThe version of the database engine to use. See `aws rds describe-db-engine-versi""
allowed_ipv6_cidr_blockslist(string)List of IPv6 CIDR blocks allowed to access the cluster[]
storage_typestringOne of 'standard' (magnetic), 'gp2' (general purpose SSD), 'io1' (provisioned IOnull
apply_immediatelyboolSpecifies whether any cluster modifications are applied immediately, or during ttrue
autoscaling_target_metricsstringThe metrics type to use. If this value isn't provided the default is CPU utiliza"RDSReaderAverageCPUUtilization"
descriptor_formatsanyDescribe additional descriptors to be output in the `descriptors` output map. Ma{}
snapshot_identifierstringSpecifies whether or not to create this cluster from a snapshotnull
backup_windowstringDaily time range during which the backups happen"07:00-09:00"
maintenance_windowstringWeekly time range during which system maintenance can occur, in UTC"wed:03:00-wed:04:00"
scaling_configurationlist(object({ auto_pause List of nested attributes with scaling properties. Only valid when `engine_mode`[]
allowed_cidr_blockslist(string)List of CIDR blocks allowed to access the cluster[]
allocated_storagenumberThe allocated storage in GBsnull
deletion_protectionboolIf the DB instance should have deletion protection enabledfalse
stagestringID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'bunull
additional_tag_mapmap(string)Additional key-value pairs to add to each map in `tags_as_list_of_maps`. Not add{}
cluster_familystringThe family of the DB cluster parameter group"aurora5.6"
storage_encryptedboolSpecifies whether the DB cluster is encrypted. The default is `false` for `provifalse
enhanced_monitoring_role_enabledboolA boolean flag to enable/disable the creation of the enhanced monitoring IAM rolfalse
replication_source_identifierstringARN of a source DB cluster or DB instance if this DB cluster is to be created as""
… and 10 more inputs
Outputs (20)
instance_endpoints — List of DNS addresses for the DB instances in the cluster
security_group_id — Security Group ID
activity_stream_arn — Activity Stream ARN
database_name — Database name
endpoint — The DNS address of the RDS instance
admin_user_secret — The secret manager attributes for the managed admin user password (`master_user_secret`).
security_group_arn — Security Group ARN
reader_endpoint — A read-only endpoint for the Aurora cluster, automatically load-balanced across replicas
master_host — DB Master hostname
replicas_host — Replicas hostname
dbi_resource_ids — List of the region-unique, immutable identifiers for the DB instances in the cluster
cluster_resource_id — The region-unique, immutable identifie of the cluster
cluster_security_groups — Default RDS cluster security groups
activity_stream_name — Activity Stream Name
reserved_instance — All information about the reserved instance(s) if created.
master_username — Username for the master DB user
arn — Amazon Resource Name (ARN) of the cluster
security_group_name — Security Group name
cluster_identifier — Cluster Identifier
port — DB port
Resources (14)
aws_appautoscaling_policyaws_appautoscaling_targetaws_db_parameter_groupaws_db_subnet_groupaws_iam_roleaws_iam_role_policy_attachmentaws_rds_clusteraws_rds_cluster_activity_streamaws_rds_cluster_instanceaws_rds_cluster_parameter_groupaws_rds_reserved_instanceaws_security_groupaws_security_group_rulerandom_pet
Details
FrameworkTerraform Module
LanguageHCL
Version2.4.0
Cloud AWS
★ Stars169
Forks191
Total downloads4.9M
Inputs50
Outputs20
Resources14
Examples8
LicenseApache-2.0
Namespacecloudposse
Updated