GlobalCluster¶
Structure Class¶
GlobalCluster
dataclass
¶
Bases: _SerdeShape
A data type representing an Aurora global database.
Attributes¶
database_name
class-attribute
instance-attribute
¶
database_name: str | None = ...
The default database name within the new global database cluster.
deletion_protection
class-attribute
instance-attribute
¶
deletion_protection: bool | None = ...
The deletion protection setting for the new global database cluster.
endpoint
class-attribute
instance-attribute
¶
endpoint: str | None = ...
The writer endpoint for the new global database cluster. This endpoint always points to the writer DB instance in the current primary cluster.
engine
class-attribute
instance-attribute
¶
engine: str | None = ...
The Aurora database engine used by the global database cluster.
engine_lifecycle_support
class-attribute
instance-attribute
¶
engine_lifecycle_support: str | None = ...
The lifecycle type for the global cluster.
For more information, see CreateGlobalCluster.
engine_version
class-attribute
instance-attribute
¶
engine_version: str | None = ...
Indicates the database engine version.
failover_state
class-attribute
instance-attribute
¶
failover_state: FailoverState | None = ...
A data object containing all properties for the current state of an
in-process or pending switchover or failover process for this global
cluster (Aurora global database). This object is empty unless the
SwitchoverGlobalCluster or FailoverGlobalCluster operation was
called on this global cluster.
global_cluster_arn
class-attribute
instance-attribute
¶
global_cluster_arn: str | None = ...
The Amazon Resource Name (ARN) for the global database cluster.
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_cluster_members
class-attribute
instance-attribute
¶
global_cluster_members: list[GlobalClusterMember] | None = ...
The list of primary and secondary clusters within the global database cluster.
global_cluster_resource_id
class-attribute
instance-attribute
¶
global_cluster_resource_id: str | None = ...
The Amazon Web Services partition-unique, immutable identifier for the global database cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB cluster is accessed.
status
class-attribute
instance-attribute
¶
status: str | None = ...
Specifies the current state of this global database cluster.
storage_encrypted
class-attribute
instance-attribute
¶
storage_encrypted: bool | None = ...
The storage encryption setting for the global database cluster.
storage_encryption_type
class-attribute
instance-attribute
¶
storage_encryption_type: str | None = ...
The type of encryption used to protect data at rest in the global database cluster. Possible values:
-
none- The global database cluster is not encrypted. -
sse-rds- The global database cluster is encrypted using an Amazon Web Services owned KMS key. -
sse-kms- The global database cluster is encrypted using a customer managed KMS key or Amazon Web Services managed KMS key.
tag_list
class-attribute
instance-attribute
¶
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.