Module library

Aurora

Terraform module to create AWS RDS Aurora resources

Version
Submodules
dsql

Inputs

40 / 114
allocated_storageoptionalnumber

The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster. (This setting is required to create a Multi-AZ DB cluster)

Defaultnull
allow_major_version_upgradeoptionalbool

Enable to allow major engine version upgrades when changing engine versions. Defaults to `false`

Defaultfalse
apply_immediatelyoptionalbool

Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is `false`

Defaultnull
auto_minor_version_upgradeoptionalbool

Whether to apply minor engine upgrades automatically to the DB cluster during the maintenance window. Defaults to `true`

Defaultnull
autoscaling_enabledoptionalbool

Determines whether autoscaling of the cluster read replicas is enabled

Defaultfalse
autoscaling_max_capacityoptionalnumber

Maximum number of read replicas permitted when autoscaling is enabled

Default2
autoscaling_min_capacityoptionalnumber

Minimum number of read replicas permitted when autoscaling is enabled

Default0
autoscaling_policy_nameoptionalstring

Autoscaling policy name

Defaulttarget-metric
autoscaling_scale_in_cooldownoptionalnumber

Cooldown in seconds before allowing further scaling operations after a scale in

Default300
autoscaling_scale_out_cooldownoptionalnumber

Cooldown in seconds before allowing further scaling operations after a scale out

Default300
autoscaling_target_connectionsoptionalnumber

Average number of connections threshold which will initiate autoscaling. Default value is 70% of db.r4/r5/r6g.large's default max_connections

Default700
autoscaling_target_cpuoptionalnumber

CPU threshold which will initiate autoscaling

Default70
availability_zonesoptionallist(string)

List of EC2 Availability Zones for the DB cluster storage where DB cluster instances can be created. RDS automatically assigns 3 AZs if less than 3 AZs are configured, which will show as a difference requiring resource recreation next Terraform apply

Defaultnull
backtrack_windowoptionalnumber

The target backtrack window, in seconds. Only available for `aurora` engine currently. To disable backtracking, set this value to 0. Must be between 0 and 259200 (72 hours)

Defaultnull
backup_retention_periodoptionalnumber

The days to retain backups for

Defaultnull
cloudwatch_log_group_classoptionalstring

Specified the log class of the log group. Possible values are: STANDARD or INFREQUENT_ACCESS

Defaultnull
cloudwatch_log_group_kms_key_idoptionalstring

The ARN of the KMS Key to use when encrypting log data

Defaultnull
cloudwatch_log_group_retention_in_daysoptionalnumber

The number of days to retain CloudWatch logs for the DB instance

Default7
cloudwatch_log_group_skip_destroyoptionalbool

Set to true if you do not wish the log group (and any logs it may contain) to be deleted at destroy time, and instead just remove the log group from the Terraform state

Defaultnull
cloudwatch_log_group_tagsoptionalmap(string)

Additional tags for the CloudWatch log group(s)

Default{}
cluster_activity_streamoptionalobject({ include_audit_fields = optional(bool, false) kms_key_id = string mode =…

Map of arguments for the created DB cluster activity stream

Defaultnull
cluster_ca_cert_identifieroptionalstring

The CA certificate identifier to use for the DB cluster's server certificate. Currently only supported for multi-az DB clusters

Defaultnull
cluster_db_instance_parameter_group_nameoptionalstring

Instance parameter group to associate with all instances of the DB cluster. The `cluster_db_instance_parameter_group_name` is only valid in combination with `allow_major_version_upgrade`

Defaultnull
cluster_instance_classoptionalstring

The compute and memory capacity of each DB instance in the Multi-AZ DB cluster (not all DB instance classes are available in all AWS Regions, or for all database engines)

Defaultnull
cluster_membersoptionallist(string)

List of RDS Instances that are a part of this cluster

Defaultnull
cluster_monitoring_intervaloptionalnumber

Interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0. Valid Values: 0, 1, 5, 10, 15, 30, 60

Default0
cluster_parameter_groupoptionalobject({ name = optional(string) use_name_prefix = optional(bool, true) descript…

Map of nested arguments for the created DB cluster parameter group

Defaultnull
cluster_parameter_group_nameoptionalstring

The name of an existing DB cluster parameter group. Required when `cluster_parameter_group` is not provided (`null`)

Defaultnull
cluster_performance_insights_enabledoptionalbool

Enables Performance Insights for the RDS Cluster

Defaultnull
cluster_performance_insights_kms_key_idoptionalstring

Specifies the KMS Key ID to encrypt Performance Insights data. If not specified, the default RDS KMS key will be used (aws/rds)

Defaultnull
cluster_performance_insights_retention_periodoptionalnumber

Specifies the amount of time to retain performance insights data for. Defaults to 7 days if Performance Insights are enabled. Valid values are 7, month * 31 (where month is a number of months from 1-23), and 731

Defaultnull
cluster_scalability_typeoptionalstring

Specifies the scalability mode of the Aurora DB cluster. When set to limitless, the cluster operates as an Aurora Limitless Database. When set to standard (the default), the cluster uses normal DB instance creation. Valid values: limitless, standard

Defaultnull
cluster_tagsoptionalmap(string)

A map of tags to add to only the cluster. Used for AWS Instance Scheduler tagging

Default{}
cluster_timeoutsoptionalobject({ create = optional(string) update = optional(string) delete = optional(s…

Create, update, and delete timeout configurations for the cluster

Defaultnull
cluster_use_name_prefixoptionalbool

Whether to use `name` as a prefix for the cluster

Defaultfalse
copy_tags_to_snapshotoptionalbool

Copy all Cluster `tags` to snapshots

Defaulttrue
createoptionalbool

Whether cluster should be created (affects nearly all resources)

Defaulttrue
create_cloudwatch_log_groupoptionalbool

Determines whether a CloudWatch log group is created for each `enabled_cloudwatch_logs_exports`

Defaultfalse
create_db_subnet_groupoptionalbool

Determines whether to create the database subnet group or use existing

Defaultfalse
create_monitoring_roleoptionalbool

Determines whether to create the IAM role for RDS enhanced monitoring

Defaulttrue

All 114 are optional — the module deploys with none of them set. Showing 40, so the site stays a static download — the remaining 74 are in the source.

Outputs

33
additional_cluster_endpoints

A map of additional cluster endpoints and their attributes

cluster_arn

Amazon Resource Name (ARN) of cluster

cluster_ca_certificate_identifier

CA identifier of the CA certificate used for the DB instance's server certificate

cluster_ca_certificate_valid_till

Expiration date of the DB instance’s server certificate

cluster_database_name

Name for an automatically created database on cluster creation

cluster_endpoint

Writer endpoint for the cluster

cluster_engine_version_actual

The running version of the cluster database

cluster_hosted_zone_id

The Route53 Hosted Zone ID of the endpoint

cluster_id

The RDS Cluster Identifier

cluster_instances

A map of cluster instances and their attributes

cluster_master_user_secret

The generated database master user secret when `manage_master_user_password` is set to `true`

cluster_master_username

The database master username

cluster_members

List of RDS Instances that are a part of this cluster

cluster_port

The database port

cluster_reader_endpoint

A read-only endpoint for the cluster, automatically load-balanced across replicas

cluster_resource_id

The RDS Cluster Resource ID

cluster_role_associations

A map of IAM roles associated with the cluster and their attributes

cluster_upgrade_rollout_order

Order in which the clusters are upgraded (first, second, last)

db_cluster_activity_stream_kinesis_stream_name

The name of the Amazon Kinesis data stream to be used for the database activity stream

db_cluster_cloudwatch_log_groups

Map of CloudWatch log groups created and their attributes

db_cluster_parameter_group_arn

The ARN of the DB cluster parameter group created

db_cluster_parameter_group_id

The ID of the DB cluster parameter group created

db_cluster_secretsmanager_secret_rotation_enabled

Specifies whether automatic rotation is enabled for the secret

db_parameter_group_arn

The ARN of the DB parameter group created

db_parameter_group_id

The ID of the DB parameter group created

db_shard_group_arn

ARN of the shard group

db_shard_group_endpoint

The connection endpoint for the DB shard group

db_shard_group_resource_id

The AWS Region-unique, immutable identifier for the DB shard group

db_subnet_group_name

The db subnet group name

enhanced_monitoring_iam_role_arn

The Amazon Resource Name (ARN) specifying the enhanced monitoring role

enhanced_monitoring_iam_role_name

The name of the enhanced monitoring role

enhanced_monitoring_iam_role_unique_id

Stable and unique string identifying the enhanced monitoring role

security_group_id

The security group ID of the cluster

What the agent wires into the next module. An edge on the architecture diagram is one of these consumed by something else.