Skip to content

RDS  >  Structures  >  DBCluster

DBCluster

Structure Class

DBCluster dataclass

Bases: _SerdeShape

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.

Attributes

activity_stream_kinesis_stream_name class-attribute instance-attribute
activity_stream_kinesis_stream_name: str | None = ...

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

activity_stream_kms_key_id class-attribute instance-attribute
activity_stream_kms_key_id: str | None = ...

The 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_mode class-attribute instance-attribute
activity_stream_mode: str | None = ...

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.

activity_stream_status class-attribute instance-attribute
activity_stream_status: str | None = ...

The status of the database activity stream.

allocated_storage class-attribute instance-attribute
allocated_storage: int | None = ...

AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage can vary because Aurora DB cluster storage size adjusts as needed.

associated_roles class-attribute instance-attribute
associated_roles: list[DBClusterRole] | None = ...

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.

auto_minor_version_upgrade class-attribute instance-attribute
auto_minor_version_upgrade: bool | None = ...

Indicates whether minor version patches are applied automatically.

This setting is for Aurora DB clusters and Multi-AZ DB clusters.

For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version.

automatic_restart_time class-attribute instance-attribute
automatic_restart_time: datetime | None = ...

The time when a stopped DB cluster is restarted automatically.

availability_zones class-attribute instance-attribute
availability_zones: list[str] | None = ...

The list of Availability Zones (AZs) where instances in the DB cluster can be created.

aws_backup_recovery_point_arn class-attribute instance-attribute
aws_backup_recovery_point_arn: str | None = ...

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

backtrack_consumed_change_records class-attribute instance-attribute
backtrack_consumed_change_records: int | None = ...

The number of change records stored for Backtrack.

backtrack_window class-attribute instance-attribute
backtrack_window: int | None = ...

The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.

backup_retention_period class-attribute instance-attribute
backup_retention_period: int | None = ...

The number of days for which automatic DB snapshots are retained.

capacity class-attribute instance-attribute
capacity: int | None = ...

The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0 (zero) when the cluster is paused.

For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.

certificate_details class-attribute instance-attribute
certificate_details: CertificateDetails | None = ...

The details of the DB instance's server certificate.

For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.

character_set_name class-attribute instance-attribute
character_set_name: str | None = ...

If present, specifies the name of the character set that this cluster is associated with.

clone_group_id class-attribute instance-attribute
clone_group_id: str | None = ...

The ID of the clone group with which the DB cluster is associated. For newly created clusters, the ID is typically null.

If you clone a DB cluster when the ID is null, the operation populates the ID value for the source cluster and the clone because both clusters become part of the same clone group. Even if you delete the clone cluster, the clone group ID remains for the lifetime of the source cluster to show that it was used in a cloning operation.

For PITR, the clone group ID is inherited from the source cluster. For snapshot restore operations, the clone group ID isn't inherited from the source cluster.

cluster_create_time class-attribute instance-attribute
cluster_create_time: datetime | None = ...

The time when the DB cluster was created, in Universal Coordinated Time (UTC).

cluster_scalability_type class-attribute instance-attribute
cluster_scalability_type: str | None = ...

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.

copy_tags_to_snapshot class-attribute instance-attribute
copy_tags_to_snapshot: bool | None = ...

Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster.

cross_account_clone class-attribute instance-attribute
cross_account_clone: bool | None = ...

Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.

custom_endpoints class-attribute instance-attribute
custom_endpoints: list[str] | None = ...

The custom endpoints associated with the DB cluster.

database_insights_mode class-attribute instance-attribute
database_insights_mode: str | None = ...

The mode of Database Insights that is enabled for the DB cluster.

database_name class-attribute instance-attribute
database_name: str | None = ...

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.

db_cluster_arn class-attribute instance-attribute
db_cluster_arn: str | None = ...

The Amazon Resource Name (ARN) for the DB cluster.

db_cluster_identifier class-attribute instance-attribute
db_cluster_identifier: str | None = ...

The user-supplied identifier for the DB cluster. This identifier is the unique key that identifies a DB cluster.

db_cluster_instance_class class-attribute instance-attribute
db_cluster_instance_class: str | None = ...

The 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_members class-attribute instance-attribute
db_cluster_members: list[DBClusterMember] | None = ...

The list of DB instances that make up the DB cluster.

db_cluster_option_group_memberships class-attribute instance-attribute
db_cluster_option_group_memberships: list[DBClusterOptionGroupStatus] | None = ...

The list of option group memberships for this DB cluster.

db_cluster_parameter_group class-attribute instance-attribute
db_cluster_parameter_group: str | None = ...

The name of the DB cluster parameter group for the DB cluster.

db_cluster_resource_id class-attribute instance-attribute
db_cluster_resource_id: str | None = ...

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.

db_subnet_group class-attribute instance-attribute
db_subnet_group: str | None = ...

Information about the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

db_system_id class-attribute instance-attribute
db_system_id: str | None = ...

Reserved for future use.

deletion_protection class-attribute instance-attribute
deletion_protection: bool | None = ...

Indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

domain_memberships class-attribute instance-attribute
domain_memberships: list[DomainMembership] | None = ...

The Active Directory Domain membership records associated with the DB cluster.

earliest_backtrack_time class-attribute instance-attribute
earliest_backtrack_time: datetime | None = ...

The earliest time to which a DB cluster can be backtracked.

earliest_restorable_time class-attribute instance-attribute
earliest_restorable_time: datetime | None = ...

The earliest time to which a database can be restored with point-in-time restore.

enabled_cloudwatch_logs_exports class-attribute instance-attribute
enabled_cloudwatch_logs_exports: list[str] | None = ...

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 Amazon RDS Database Log Files in the Amazon Aurora User Guide.

endpoint class-attribute instance-attribute
endpoint: str | None = ...

The connection endpoint for the primary instance of the DB cluster.

engine class-attribute instance-attribute
engine: str | None = ...

The database engine used for this DB cluster.

engine_lifecycle_support class-attribute instance-attribute
engine_lifecycle_support: str | None = ...

The lifecycle type for the DB cluster.

For more information, see CreateDBCluster.

engine_mode class-attribute instance-attribute
engine_mode: str | None = ...

The DB engine mode of the DB cluster, either provisioned or serverless.

For more information, see CreateDBCluster.

engine_version class-attribute instance-attribute
engine_version: str | None = ...

The version of the database engine.

global_cluster_identifier class-attribute instance-attribute
global_cluster_identifier: str | None = ...

Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster.

global_write_forwarding_requested class-attribute instance-attribute
global_write_forwarding_requested: bool | None = ...

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.

global_write_forwarding_status class-attribute instance-attribute
global_write_forwarding_status: str | None = ...

The status of write forwarding for a secondary cluster in an Aurora global database.

hosted_zone_id class-attribute instance-attribute
hosted_zone_id: str | None = ...

The ID that Amazon Route 53 assigns when you create a hosted zone.

http_endpoint_enabled class-attribute instance-attribute
http_endpoint_enabled: bool | None = ...

Indicates 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 Using RDS Data API in the Amazon Aurora User Guide.

iam_database_authentication_enabled class-attribute instance-attribute
iam_database_authentication_enabled: bool | None = ...

Indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

internet_access_gateway_enabled class-attribute instance-attribute
internet_access_gateway_enabled: bool | None = ...

Indicates whether the DB cluster has internet-based connectivity enabled through an internet access gateway.

This setting is applicable only for Aurora PostgreSQL clusters created through express configuration.

io_optimized_next_allowed_modification_time class-attribute instance-attribute
io_optimized_next_allowed_modification_time: datetime | None = ...

The next time you can modify the DB cluster to use the aurora-iopt1 storage type.

This setting is only for Aurora DB clusters.

iops class-attribute instance-attribute
iops: int | None = ...

The Provisioned IOPS (I/O operations per second) value.

This setting is only for non-Aurora Multi-AZ DB clusters.

kms_key_id class-attribute instance-attribute
kms_key_id: str | None = ...

If StorageEncrypted 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_time class-attribute instance-attribute
latest_restorable_time: datetime | None = ...

The latest time to which a database can be restored with point-in-time restore.

limitless_database class-attribute instance-attribute
limitless_database: LimitlessDatabase | None = ...

The details for Aurora Limitless Database.

local_write_forwarding_status class-attribute instance-attribute
local_write_forwarding_status: str | None = ...

Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it.

master_user_secret class-attribute instance-attribute
master_user_secret: MasterUserSecret | None = ...

The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.

For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.

master_username class-attribute instance-attribute
master_username: str | None = ...

The master username for the DB cluster.

monitoring_interval class-attribute instance-attribute
monitoring_interval: int | None = ...

The 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_arn class-attribute instance-attribute
monitoring_role_arn: str | None = ...

The 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_az class-attribute instance-attribute
multi_az: bool | None = ...

Indicates whether the DB cluster has instances in multiple Availability Zones.

network_type class-attribute instance-attribute
network_type: str | None = ...

The network type of the DB instance.

The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).

For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.

This setting is only for Aurora DB clusters.

Valid Values: IPV4 | DUAL

pending_modified_values class-attribute instance-attribute
pending_modified_values: ClusterPendingModifiedValues | None = ...

Information about pending changes to the DB cluster. This information is returned only when there are pending changes. Specific changes are identified by subelements.

percent_progress class-attribute instance-attribute
percent_progress: str | None = ...

The progress of the operation as a percentage.

performance_insights_enabled class-attribute instance-attribute
performance_insights_enabled: bool | None = ...

Indicates 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_id class-attribute instance-attribute
performance_insights_kms_key_id: str | None = ...

The 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_period class-attribute instance-attribute
performance_insights_retention_period: int | None = ...

The number of days to retain Performance Insights data.

This setting is only for Aurora DB clusters and Multi-AZ DB clusters.

Valid Values:

  • 7

  • month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)

  • 731

Default: 7 days

port class-attribute instance-attribute
port: int | None = ...

The port that the database engine is listening on.

preferred_backup_window class-attribute instance-attribute
preferred_backup_window: str | None = ...

The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

preferred_maintenance_window class-attribute instance-attribute
preferred_maintenance_window: str | None = ...

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

publicly_accessible class-attribute instance-attribute
publicly_accessible: bool | None = ...

Indicates 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 CreateDBCluster.

This setting is only for non-Aurora Multi-AZ DB clusters.

rds_custom_cluster_configuration class-attribute instance-attribute
rds_custom_cluster_configuration: RdsCustomClusterConfiguration | None = ...

Reserved for future use.

read_replica_identifiers class-attribute instance-attribute
read_replica_identifiers: list[str] | None = ...

Contains one or more identifiers of the read replicas associated with this DB cluster.

reader_endpoint class-attribute instance-attribute
reader_endpoint: str | None = ...

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.

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_identifier class-attribute instance-attribute
replication_source_identifier: str | None = ...

The identifier of the source DB cluster if this DB cluster is a read replica.

scaling_configuration_info class-attribute instance-attribute
scaling_configuration_info: ScalingConfigurationInfo | None = ...

The scaling configuration for an Aurora DB cluster in serverless DB engine mode.

For more information, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.

serverless_v2_platform_version class-attribute instance-attribute
serverless_v2_platform_version: str | None = ...

The version of the Aurora Serverless V2 platform used by the DB cluster. For more information, see Using Aurora Serverless v2 in the Amazon Aurora User Guide.

serverless_v2_scaling_configuration class-attribute instance-attribute
serverless_v2_scaling_configuration: ServerlessV2ScalingConfigurationInfo | None = ...

The scaling configuration for an Aurora Serverless v2 DB cluster.

For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide.

status class-attribute instance-attribute
status: str | None = ...

The current state of this DB cluster.

status_infos class-attribute instance-attribute
status_infos: list[DBClusterStatusInfo] | None = ...

Reserved for future use.

storage_encrypted class-attribute instance-attribute
storage_encrypted: bool | None = ...

Specifies whether the DB cluster is encrypted with an Amazon Web Services managed key or a customer managed key.

If the DB cluster is encrypted with an Amazon Web Services owned key, this value is false and StorageEncryptionType is sse-rds. In that case, the data at rest is still encrypted. To determine how the data at rest is protected, use StorageEncryptionType.

storage_encryption_type class-attribute instance-attribute
storage_encryption_type: str | None = ...

The type of encryption used to protect data at rest in the DB cluster. Possible values:

  • none - The DB cluster is not encrypted.

  • sse-rds - The DB cluster is encrypted using an Amazon Web Services owned KMS key.

  • sse-kms - The DB cluster is encrypted using a customer managed KMS key or Amazon Web Services managed KMS key.

storage_throughput class-attribute instance-attribute
storage_throughput: int | None = ...

The 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_type class-attribute instance-attribute
storage_type: str | None = ...

The storage type associated with the DB cluster.

tag_list class-attribute instance-attribute
tag_list: list[Tag] | None = ...

A list of tags.

For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.

upgrade_rollout_order class-attribute instance-attribute
upgrade_rollout_order: str | None = ...

This data type represents the order in which the clusters are upgraded.

  • [first] - Typically used for development or testing environments.

  • [second] - Default order for resources not specifically configured.

  • [last] - Usually reserved for production environments.

vpc_networking_enabled class-attribute instance-attribute
vpc_networking_enabled: bool | None = ...

Indicates whether the DB cluster uses VPC-based networking.

This setting is applicable only for Aurora PostgreSQL clusters created through express configuration.

vpc_security_groups class-attribute instance-attribute
vpc_security_groups: list[VpcSecurityGroupMembership] | None = ...

The list of VPC security groups that the DB cluster belongs to.