Skip to content

GlobalCluster

Source code in docs_src/capo_neptune/types/global_cluster.py
class GlobalCluster(TypedDict, closed=True):
    global_cluster_identifier: NotRequired[
        "capo_neptune.types.global_cluster_identifier.GlobalClusterIdentifier"
    ]
    """<p>Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database.</p>"""
    global_cluster_resource_id: NotRequired["capo_neptune.types.string.String"]
    """<p>An immutable identifier for the global database that is unique within all regions. This identifier is found in CloudTrail log entries whenever the KMS key for the DB cluster is accessed.</p>"""
    global_cluster_arn: NotRequired["capo_neptune.types.string.String"]
    """<p>The Amazon Resource Name (ARN) for the global database.</p>"""
    status: NotRequired["capo_neptune.types.string.String"]
    """<p>Specifies the current state of this global database.</p>"""
    engine: NotRequired["capo_neptune.types.string.String"]
    """<p>The Neptune database engine used by the global database (<code>"neptune"</code>).</p>"""
    engine_version: NotRequired["capo_neptune.types.string.String"]
    """<p>The Neptune engine version used by the global database.</p>"""
    database_name: NotRequired["capo_neptune.types.string.String"]
    """<p>The default database name within the new global database cluster.</p>"""
    storage_encrypted: NotRequired[
        "capo_neptune.types.boolean_optional.BooleanOptional"
    ]
    """<p>The storage encryption setting for the global database.</p>"""
    deletion_protection: NotRequired[
        "capo_neptune.types.boolean_optional.BooleanOptional"
    ]
    """<p>The deletion protection setting for the global database.</p>"""
    global_cluster_members: NotRequired[
        "capo_neptune.types.global_cluster_member_list.GlobalClusterMemberList"
    ]
    """<p>A list of cluster ARNs and instance ARNs for all the DB clusters that are part of the global database.</p>"""
    failover_state: NotRequired["capo_neptune.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 (Neptune global database). 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_neptune.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 database cluster.

deletion_protection instance-attribute

deletion_protection: NotRequired[BooleanOptional]

The deletion protection setting for the global database.

engine instance-attribute

engine: NotRequired[String]

The Neptune database engine used by the global database ("neptune").

engine_version instance-attribute

engine_version: NotRequired[String]

The Neptune engine version used by the global database.

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 (Neptune global database). 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 database.

global_cluster_identifier instance-attribute

global_cluster_identifier: NotRequired[GlobalClusterIdentifier]

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

global_cluster_members instance-attribute

global_cluster_members: NotRequired[GlobalClusterMemberList]

A list of cluster ARNs and instance ARNs for all the DB clusters that are part of the global database.

global_cluster_resource_id instance-attribute

global_cluster_resource_id: NotRequired[String]

An immutable identifier for the global database that is unique within all regions. This identifier is found in CloudTrail log entries whenever the KMS key for the DB cluster is accessed.

status instance-attribute

status: NotRequired[String]

Specifies the current state of this global database.

storage_encrypted instance-attribute

storage_encrypted: NotRequired[BooleanOptional]

The storage encryption setting for the global database.

tag_list instance-attribute

tag_list: NotRequired[TagList]

A list of global cluster tags.