DbCluster
Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
For an Amazon Aurora DB cluster, this data type is used as a response element in the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster, ModifyDBCluster, PromoteReadReplicaDBCluster, RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot, RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster.
For a Multi-AZ DB cluster, this data type is used as a response element in the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster, ModifyDBCluster, RebootDBCluster, RestoreDBClusterFromSnapshot, and RestoreDBClusterToPointInTime.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
Types
Properties
The name of the Amazon Kinesis data stream used for the database activity stream.
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
The 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.
The status of the database activity stream.
For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
A 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.
The time when a stopped DB cluster is restarted automatically.
Indicates whether minor version patches are applied automatically.
The list of Availability Zones (AZs) where instances in the DB cluster can be created.
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
The number of change records stored for Backtrack.
The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.
The number of days for which automatic DB snapshots are retained.
If present, specifies the name of the character set that this cluster is associated with.
The ID of the clone group with which the DB cluster is associated.
The time when the DB cluster was created, in Universal Coordinated Time (UTC).
Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster.
Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
The custom endpoints associated with the DB cluster.
The 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.
The Amazon Resource Name (ARN) for the DB cluster.
The user-supplied identifier for the DB cluster. This identifier is the unique key that identifies a DB cluster.
The name of the compute and memory capacity class of the DB instance.
The list of DB instances that make up the DB cluster.
The list of option group memberships for this DB cluster.
The name of the DB cluster parameter group for the DB cluster.
The 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.
Information about the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
Reserved for future use.
Indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
The Active Directory Domain membership records associated with the DB cluster.
The earliest time to which a DB cluster can be backtracked.
The earliest time to which a database can be restored with point-in-time restore.
A list of log types that this DB cluster is configured to export to CloudWatch Logs.
The DB engine mode of the DB cluster, either provisioned or serverless.
The version of the database engine.
Indicates 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 GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.
The status of write forwarding for a secondary cluster in an Aurora global database.
The ID that Amazon Route 53 assigns when you create a hosted zone.
Indicates whether the HTTP endpoint is enabled for an Aurora DB cluster.
Indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
The next time you can modify the DB cluster to use the aurora-iopt1 storage type.
The latest time to which a database can be restored with point-in-time restore.
The details for Aurora Limitless Database.
Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it.
The master username for the DB cluster.
The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
The network type of the DB instance.
Information about pending changes to the DB cluster. This information is returned only when there are pending changes. Specific changes are identified by subelements.
The progress of the operation as a percentage.
Indicates whether Performance Insights is enabled for the DB cluster.
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The number of days to retain Performance Insights data.
The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Indicates whether the DB cluster is publicly accessible.
Reserved for future use.
The 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.
Contains one or more identifiers of the read replicas associated with this DB cluster.
The identifier of the source DB cluster if this DB cluster is a read replica.
The scaling configuration for an Aurora DB cluster in serverless DB engine mode.
The scaling configuration for an Aurora Serverless v2 DB cluster.
Reserved for future use.
Indicates whether the DB cluster is encrypted.
The storage throughput for the DB cluster. The throughput is automatically set based on the IOPS that you provision, and is not configurable.
The storage type associated with the DB cluster.
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
The list of VPC security groups that the DB cluster belongs to.