RDS Clusters

This table represents the RDS Clusters resource from Amazon Web Services.

aws.rds_cluster

Fields

TitleIDTypeData TypeDescription
_keycorestring
account_idcorestring
activity_stream_kinesis_stream_namecorestringThe name of the Amazon Kinesis data stream used for the database activity stream.
activity_stream_kms_key_idcorestringThe Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
activity_stream_modecorestringThe mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.
activity_stream_statuscorestringThe status of the database activity stream.
allocated_storagecoreint64For all database engines except Amazon Aurora, <code>AllocatedStorage</code> specifies the allocated storage size in gibibytes (GiB). For Aurora, <code>AllocatedStorage</code> always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
associated_rolescorejsonA list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.
auto_minor_version_upgradecoreboolIndicates whether minor version patches are applied automatically. This setting is for Aurora DB clusters and Multi-AZ DB clusters.
automatic_restart_timecoretimestampThe time when a stopped DB cluster is restarted automatically.
availability_zonescorearray<string>The list of Availability Zones (AZs) where instances in the DB cluster can be created.
aws_backup_recovery_point_arncorestringThe Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
backtrack_consumed_change_recordscoreint64The number of change records stored for Backtrack.
backtrack_windowcoreint64The target backtrack window, in seconds. If this value is set to <code>0</code>, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.
backup_retention_periodcoreint64The number of days for which automatic DB snapshots are retained.
capacitycoreint64The current capacity of an Aurora Serverless v1 DB cluster. The capacity is <code>0</code> (zero) when the cluster is paused. For more information about Aurora Serverless v1, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html">Using Amazon Aurora Serverless v1</a> in the <i>Amazon Aurora User Guide</i>.
certificate_detailscorejson
character_set_namecorestringIf present, specifies the name of the character set that this cluster is associated with.
clone_group_idcorestringThe ID of the clone group with which the DB cluster is associated.
cluster_create_timecoretimestampThe time when the DB cluster was created, in Universal Coordinated Time (UTC).
cluster_scalability_typecorestringThe scalability mode of the Aurora DB cluster. When set to <code>limitless</code>, the cluster operates as an Aurora Limitless Database. When set to <code>standard</code> (the default), the cluster uses normal DB instance creation.
copy_tags_to_snapshotcoreboolIndicates whether tags are copied from the DB cluster to snapshots of the DB cluster.
cross_account_clonecoreboolIndicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
custom_endpointscorearray<string>The custom endpoints associated with the DB cluster.
database_insights_modecorestringThe mode of Database Insights that is enabled for the DB cluster.
database_namecorestringThe name of the initial database that was specified for the DB cluster when it was created, if one was provided. This same name is returned for the life of the DB cluster.
db_cluster_arncorestringThe Amazon Resource Name (ARN) for the DB cluster.
db_cluster_identifiercorestringThe user-supplied identifier for the DB cluster. This identifier is the unique key that identifies a DB cluster.
db_cluster_instance_classcorestringThe name of the compute and memory capacity class of the DB instance. This setting is only for non-Aurora Multi-AZ DB clusters.
db_cluster_memberscorejsonThe list of DB instances that make up the DB cluster.
db_cluster_option_group_membershipscorejsonThe list of option group memberships for this DB cluster.
db_cluster_parameter_groupcorestringThe name of the DB cluster parameter group for the DB cluster.
db_cluster_resource_idcorestringThe Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
db_subnet_groupcorestringInformation about the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
db_system_idcorestringReserved for future use.
deletion_protectioncoreboolIndicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
domain_membershipscorejsonThe Active Directory Domain membership records associated with the DB cluster.
earliest_backtrack_timecoretimestampThe earliest time to which a DB cluster can be backtracked.
earliest_restorable_timecoretimestampThe earliest time to which a database can be restored with point-in-time restore.
enabled_cloudwatch_logs_exportscorearray<string>A list of log types that this DB cluster is configured to export to CloudWatch Logs. Log types vary by DB engine. For information about the log types for each DB engine, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html">Amazon RDS Database Log Files</a> in the <i>Amazon Aurora User Guide.</i>
endpointcorestringThe connection endpoint for the primary instance of the DB cluster.
enginecorestringThe database engine used for this DB cluster.
engine_lifecycle_supportcorestringThe life cycle type for the DB cluster. For more information, see CreateDBCluster.
engine_modecorestringThe DB engine mode of the DB cluster, either <code>provisioned</code> or <code>serverless</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html"> CreateDBCluster</a>.
engine_versioncorestringThe version of the database engine.
global_write_forwarding_requestedcoreboolIndicates whether write forwarding is enabled for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of <code>GlobalWriteForwardingStatus</code> to confirm that the request has completed before using the write forwarding feature for this cluster.
global_write_forwarding_statuscorestringThe status of write forwarding for a secondary cluster in an Aurora global database.
hosted_zone_idcorestringThe ID that Amazon Route 53 assigns when you create a hosted zone.
http_endpoint_enabledcoreboolIndicates whether the HTTP endpoint is enabled for an Aurora DB cluster. When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the DB cluster. You can also query your database from inside the RDS console with the RDS query editor. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html">Using RDS Data API</a> in the <i>Amazon Aurora User Guide</i>.
iam_database_authentication_enabledcoreboolIndicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
io_optimized_next_allowed_modification_timecoretimestampThe next time you can modify the DB cluster to use the <code>aurora-iopt1</code> storage type. This setting is only for Aurora DB clusters.
iopscoreint64The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.
kms_key_idcorestringIf <code>StorageEncrypted</code> is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
latest_restorable_timecoretimestampThe latest time to which a database can be restored with point-in-time restore.
limitless_databasecorejsonThe details for Aurora Limitless Database.
local_write_forwarding_statuscorestringIndicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it.
master_user_secretcorejsonThe secret managed by RDS in Amazon Web Services Secrets Manager for the master user password. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html">Password management with Amazon Web Services Secrets Manager</a> in the <i>Amazon RDS User Guide</i> and <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html">Password management with Amazon Web Services Secrets Manager</a> in the <i>Amazon Aurora User Guide.</i>
master_usernamecorestringThe master username for the DB cluster.
monitoring_intervalcoreint64The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. This setting is only for -Aurora DB clusters and Multi-AZ DB clusters.
monitoring_role_arncorestringThe ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. This setting is only for Aurora DB clusters and Multi-AZ DB clusters.
multi_azcoreboolIndicates whether the DB cluster has instances in multiple Availability Zones.
network_typecorestringThe network type of the DB instance. The network type is determined by the <code>DBSubnetGroup</code> specified for the DB cluster. A <code>DBSubnetGroup</code> can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (<code>DUAL</code>). For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html"> Working with a DB instance in a VPC</a> in the <i>Amazon Aurora User Guide.</i> This setting is only for Aurora DB clusters. Valid Values: <code>IPV4 | DUAL</code>
pending_modified_valuescorejsonInformation about pending changes to the DB cluster. This information is returned only when there are pending changes. Specific changes are identified by subelements.
percent_progresscorestringThe progress of the operation as a percentage.
performance_insights_enabledcoreboolIndicates whether Performance Insights is enabled for the DB cluster. This setting is only for Aurora DB clusters and Multi-AZ DB clusters.
performance_insights_kms_key_idcorestringThe Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. This setting is only for Aurora DB clusters and Multi-AZ DB clusters.
performance_insights_retention_periodcoreint64The number of days to retain Performance Insights data. This setting is only for Aurora DB clusters and Multi-AZ DB clusters. Valid Values: <ul> <li> <code>7</code> </li> <li> <i>month</i> * 31, where <i>month</i> is a number of months from 1-23. Examples: <code>93</code> (3 months * 31), <code>341</code> (11 months * 31), <code>589</code> (19 months * 31) </li> <li> <code>731</code> </li> </ul> Default: <code>7</code> days
portcoreint64The port that the database engine is listening on.
preferred_backup_windowcorestringThe daily time range during which automated backups are created if automated backups are enabled, as determined by the <code>BackupRetentionPeriod</code>.
preferred_maintenance_windowcorestringThe weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
publicly_accessiblecoreboolIndicates whether the DB cluster is publicly accessible. When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it. When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address. For more information, see <a>CreateDBCluster</a>. This setting is only for non-Aurora Multi-AZ DB clusters.
rds_custom_cluster_configurationcorejsonReserved for future use.
read_replica_identifierscorearray<string>Contains one or more identifiers of the read replicas associated with this DB cluster.
reader_endpointcorestringThe reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster. If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
replication_source_identifiercorestringThe identifier of the source DB cluster if this DB cluster is a read replica.
scaling_configuration_infocorejson
serverless_v2_scaling_configurationcorejson
statuscorestringThe current state of this DB cluster.
status_infoscorejsonReserved for future use.
storage_encryptedcoreboolIndicates whether the DB cluster is encrypted.
storage_throughputcoreint64The storage throughput for the DB cluster. The throughput is automatically set based on the IOPS that you provision, and is not configurable. This setting is only for non-Aurora Multi-AZ DB clusters.
storage_typecorestringThe storage type associated with the DB cluster.
tagscorehstore
vpc_security_groupscorejsonThe list of VPC security groups that the DB cluster belongs to.