Aurora
Terraform module to create AWS RDS Aurora resources
Inputs
40 / 114
allocated_storageoptionalnumberThe 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)
nullallow_major_version_upgradeoptionalboolEnable to allow major engine version upgrades when changing engine versions. Defaults to `false`
falseapply_immediatelyoptionalboolSpecifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is `false`
nullauto_minor_version_upgradeoptionalboolWhether to apply minor engine upgrades automatically to the DB cluster during the maintenance window. Defaults to `true`
nullautoscaling_enabledoptionalboolDetermines whether autoscaling of the cluster read replicas is enabled
falseautoscaling_max_capacityoptionalnumberMaximum number of read replicas permitted when autoscaling is enabled
2autoscaling_min_capacityoptionalnumberMinimum number of read replicas permitted when autoscaling is enabled
0autoscaling_policy_nameoptionalstringAutoscaling policy name
target-metricautoscaling_scale_in_cooldownoptionalnumberCooldown in seconds before allowing further scaling operations after a scale in
300autoscaling_scale_out_cooldownoptionalnumberCooldown in seconds before allowing further scaling operations after a scale out
300autoscaling_target_connectionsoptionalnumberAverage number of connections threshold which will initiate autoscaling. Default value is 70% of db.r4/r5/r6g.large's default max_connections
700autoscaling_target_cpuoptionalnumberCPU threshold which will initiate autoscaling
70availability_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
nullbacktrack_windowoptionalnumberThe 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)
nullbackup_retention_periodoptionalnumberThe days to retain backups for
nullcloudwatch_log_group_classoptionalstringSpecified the log class of the log group. Possible values are: STANDARD or INFREQUENT_ACCESS
nullcloudwatch_log_group_kms_key_idoptionalstringThe ARN of the KMS Key to use when encrypting log data
nullcloudwatch_log_group_retention_in_daysoptionalnumberThe number of days to retain CloudWatch logs for the DB instance
7cloudwatch_log_group_skip_destroyoptionalboolSet 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
nullcloudwatch_log_group_tagsoptionalmap(string)Additional tags for the CloudWatch log group(s)
{}cluster_activity_streamoptionalobject({ include_audit_fields = optional(bool, false) kms_key_id = string mode =…Map of arguments for the created DB cluster activity stream
nullcluster_ca_cert_identifieroptionalstringThe CA certificate identifier to use for the DB cluster's server certificate. Currently only supported for multi-az DB clusters
nullcluster_db_instance_parameter_group_nameoptionalstringInstance 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`
nullcluster_instance_classoptionalstringThe 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)
nullcluster_membersoptionallist(string)List of RDS Instances that are a part of this cluster
nullcluster_monitoring_intervaloptionalnumberInterval, 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
0cluster_parameter_groupoptionalobject({ name = optional(string) use_name_prefix = optional(bool, true) descript…Map of nested arguments for the created DB cluster parameter group
nullcluster_parameter_group_nameoptionalstringThe name of an existing DB cluster parameter group. Required when `cluster_parameter_group` is not provided (`null`)
nullcluster_performance_insights_enabledoptionalboolEnables Performance Insights for the RDS Cluster
nullcluster_performance_insights_kms_key_idoptionalstringSpecifies the KMS Key ID to encrypt Performance Insights data. If not specified, the default RDS KMS key will be used (aws/rds)
nullcluster_performance_insights_retention_periodoptionalnumberSpecifies 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
nullcluster_scalability_typeoptionalstringSpecifies 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
nullcluster_tagsoptionalmap(string)A map of tags to add to only the cluster. Used for AWS Instance Scheduler tagging
{}cluster_timeoutsoptionalobject({ create = optional(string) update = optional(string) delete = optional(s…Create, update, and delete timeout configurations for the cluster
nullcluster_use_name_prefixoptionalboolWhether to use `name` as a prefix for the cluster
falsecopy_tags_to_snapshotoptionalboolCopy all Cluster `tags` to snapshots
truecreateoptionalboolWhether cluster should be created (affects nearly all resources)
truecreate_cloudwatch_log_groupoptionalboolDetermines whether a CloudWatch log group is created for each `enabled_cloudwatch_logs_exports`
falsecreate_db_subnet_groupoptionalboolDetermines whether to create the database subnet group or use existing
falsecreate_monitoring_roleoptionalboolDetermines whether to create the IAM role for RDS enhanced monitoring
trueAll 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_endpointsA map of additional cluster endpoints and their attributes
cluster_arnAmazon Resource Name (ARN) of cluster
cluster_ca_certificate_identifierCA identifier of the CA certificate used for the DB instance's server certificate
cluster_ca_certificate_valid_tillExpiration date of the DB instance’s server certificate
cluster_database_nameName for an automatically created database on cluster creation
cluster_endpointWriter endpoint for the cluster
cluster_engine_version_actualThe running version of the cluster database
cluster_hosted_zone_idThe Route53 Hosted Zone ID of the endpoint
cluster_idThe RDS Cluster Identifier
cluster_instancesA map of cluster instances and their attributes
cluster_master_user_secretThe generated database master user secret when `manage_master_user_password` is set to `true`
cluster_master_usernameThe database master username
cluster_membersList of RDS Instances that are a part of this cluster
cluster_portThe database port
cluster_reader_endpointA read-only endpoint for the cluster, automatically load-balanced across replicas
cluster_resource_idThe RDS Cluster Resource ID
cluster_role_associationsA map of IAM roles associated with the cluster and their attributes
cluster_upgrade_rollout_orderOrder in which the clusters are upgraded (first, second, last)
db_cluster_activity_stream_kinesis_stream_nameThe name of the Amazon Kinesis data stream to be used for the database activity stream
db_cluster_cloudwatch_log_groupsMap of CloudWatch log groups created and their attributes
db_cluster_parameter_group_arnThe ARN of the DB cluster parameter group created
db_cluster_parameter_group_idThe ID of the DB cluster parameter group created
db_cluster_secretsmanager_secret_rotation_enabledSpecifies whether automatic rotation is enabled for the secret
db_parameter_group_arnThe ARN of the DB parameter group created
db_parameter_group_idThe ID of the DB parameter group created
db_shard_group_arnARN of the shard group
db_shard_group_endpointThe connection endpoint for the DB shard group
db_shard_group_resource_idThe AWS Region-unique, immutable identifier for the DB shard group
db_subnet_group_nameThe db subnet group name
enhanced_monitoring_iam_role_arnThe Amazon Resource Name (ARN) specifying the enhanced monitoring role
enhanced_monitoring_iam_role_nameThe name of the enhanced monitoring role
enhanced_monitoring_iam_role_unique_idStable and unique string identifying the enhanced monitoring role
security_group_idThe 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.