Skip to main content
This page documents every output value exported by the terraform-aws-modules/rds-aurora/aws module.

Usage example

output "aurora_endpoint" {
  value = module.aurora.cluster_endpoint
}

output "aurora_reader_endpoint" {
  value = module.aurora.cluster_reader_endpoint
}

output "aurora_port" {
  value = module.aurora.cluster_port
}

DB Subnet Group

db_subnet_group_name
string
The DB subnet group name.

Cluster

cluster_arn
string
Amazon Resource Name (ARN) of the cluster.
cluster_id
string
The RDS Cluster Identifier.
cluster_resource_id
string
The RDS Cluster Resource ID.
cluster_members
list(string)
List of RDS Instances that are a part of this cluster.
cluster_endpoint
string
Writer endpoint for the cluster.
cluster_reader_endpoint
string
A read-only endpoint for the cluster, automatically load-balanced across replicas.
cluster_engine_version_actual
string
The running version of the cluster database.
cluster_database_name
string
Name for the automatically created database on cluster creation.
cluster_port
number
The database port.
cluster_master_username
string
The database master username. This output is marked sensitive.
cluster_master_user_secret
object
The generated database master user secret when manage_master_user_password is set to true.
cluster_hosted_zone_id
string
The Route53 Hosted Zone ID of the endpoint.
cluster_ca_certificate_identifier
string
CA identifier of the CA certificate used for the DB instance’s server certificate.
cluster_ca_certificate_valid_till
string
Expiration date of the DB instance’s server certificate.
cluster_upgrade_rollout_order
string
Order in which the clusters are upgraded: first, second, or last.

Cluster Instances

cluster_instances
map(object)
A map of cluster instances and their attributes.

Cluster Endpoints

additional_cluster_endpoints
map(object)
A map of additional cluster endpoints and their attributes.

IAM Roles

cluster_role_associations
map(object)
A map of IAM roles associated with the cluster and their attributes.

Enhanced Monitoring

enhanced_monitoring_iam_role_name
string
The name of the enhanced monitoring role.
enhanced_monitoring_iam_role_arn
string
The Amazon Resource Name (ARN) of the enhanced monitoring role.
enhanced_monitoring_iam_role_unique_id
string
Stable and unique string identifying the enhanced monitoring role.

Security Group

security_group_id
string
The security group ID of the cluster.

Parameter Groups

db_cluster_parameter_group_arn
string
The ARN of the DB cluster parameter group created.
db_cluster_parameter_group_id
string
The ID of the DB cluster parameter group created.
db_parameter_group_arn
string
The ARN of the DB parameter group created.
db_parameter_group_id
string
The ID of the DB parameter group created.

CloudWatch Logs

db_cluster_cloudwatch_log_groups
map(object)
Map of CloudWatch log groups created and their attributes.

Activity Stream

db_cluster_activity_stream_kinesis_stream_name
string
The name of the Amazon Kinesis data stream used for the database activity stream.

Secrets Management

db_cluster_secretsmanager_secret_rotation_enabled
bool
Specifies whether automatic rotation is enabled for the master user password secret.

Shard Group

db_shard_group_arn
string
ARN of the shard group.
db_shard_group_resource_id
string
The AWS Region-unique, immutable identifier for the DB shard group.
db_shard_group_endpoint
string
The connection endpoint for the DB shard group.

Build docs developers (and LLMs) love