Skip to content

GlobalCluster

Source code in docs_src/capo_docdb/types/global_cluster.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
class GlobalCluster(TypedDict, closed=True):
    global_cluster_identifier: NotRequired[
        "capo_docdb.types.global_cluster_identifier.GlobalClusterIdentifier"
    ]
    """<p>Contains a user-supplied global cluster identifier. This identifier is the unique key that identifies a global cluster. </p>"""
    global_cluster_resource_id: NotRequired["capo_docdb.types.string.String"]
    """<p>The Amazon Web Services RegionRegion-unique, immutable identifier for the global database cluster. This identifier is found in CloudTrail log entries whenever the KMS customer master key (CMK) for the cluster is accessed. </p>"""
    global_cluster_arn: NotRequired["capo_docdb.types.string.String"]
    """<p>The Amazon Resource Name (ARN) for the global cluster.</p>"""
    status: NotRequired["capo_docdb.types.string.String"]
    """<p>Specifies the current state of this global cluster.</p>"""
    engine: NotRequired["capo_docdb.types.string.String"]
    """<p>The Amazon DocumentDB database engine used by the global cluster. </p>"""
    engine_version: NotRequired["capo_docdb.types.string.String"]
    """<p>Indicates the database engine version.</p>"""
    database_name: NotRequired["capo_docdb.types.string.String"]
    """<p>The default database name within the new global cluster.</p>"""
    storage_encrypted: NotRequired["capo_docdb.types.boolean_optional.BooleanOptional"]
    """<p>The storage encryption setting for the global cluster.</p>"""
    deletion_protection: NotRequired[
        "capo_docdb.types.boolean_optional.BooleanOptional"
    ]
    """<p>The deletion protection setting for the new global cluster.</p>"""
    global_cluster_members: NotRequired[
        "capo_docdb.types.global_cluster_member_list.GlobalClusterMemberList"
    ]
    """<p>The list of cluster IDs for secondary clusters within the global cluster. Currently limited to one item. </p>"""
    failover_state: NotRequired["capo_docdb.types.failover_state.FailoverState"]
    """<p>A data object containing all properties for the current state of an in-process or pending switchover or failover process for this global cluster. This object is empty unless the <code>SwitchoverGlobalCluster</code> or <code>FailoverGlobalCluster</code> operation was called on this global cluster.</p>"""
    tag_list: NotRequired["capo_docdb.types.tag_list.TagList"]
    """<p>A list of global cluster tags.</p>"""

database_name instance-attribute 

database_name: NotRequired[String]

The default database name within the new global cluster.

deletion_protection instance-attribute 

deletion_protection: NotRequired[BooleanOptional]

The deletion protection setting for the new global cluster.

engine instance-attribute 

engine: NotRequired[String]

The Amazon DocumentDB database engine used by the global cluster.

engine_version instance-attribute 

engine_version: NotRequired[String]

Indicates the database engine version.

failover_state instance-attribute 

failover_state: NotRequired[FailoverState]

A data object containing all properties for the current state of an in-process or pending switchover or failover process for this global cluster. This object is empty unless the SwitchoverGlobalCluster or FailoverGlobalCluster operation was called on this global cluster.

global_cluster_arn instance-attribute 

global_cluster_arn: NotRequired[String]

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

global_cluster_identifier instance-attribute 

global_cluster_identifier: NotRequired[GlobalClusterIdentifier]

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

global_cluster_members instance-attribute 

global_cluster_members: NotRequired[GlobalClusterMemberList]

The list of cluster IDs for secondary clusters within the global cluster. Currently limited to one item.

global_cluster_resource_id instance-attribute 

global_cluster_resource_id: NotRequired[String]

The Amazon Web Services RegionRegion-unique, immutable identifier for the global database cluster. This identifier is found in CloudTrail log entries whenever the KMS customer master key (CMK) for the cluster is accessed.

status instance-attribute 

status: NotRequired[String]

Specifies the current state of this global cluster.

storage_encrypted instance-attribute 

storage_encrypted: NotRequired[BooleanOptional]

The storage encryption setting for the global cluster.

tag_list instance-attribute 

tag_list: NotRequired[TagList]

A list of global cluster tags.