GlobalCluster ¶

class GlobalCluster(TypedDict, closed=True):
    global_cluster_identifier: NotRequired[
        "capo_rds.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 cluster.</p>"""
    global_cluster_resource_id: NotRequired["capo_rds.types.string.String"]
    """<p>The Amazon Web Services <a href="https://docs.aws.amazon.com/glossary/latest/reference/glos-chap.html?id=docs_gateway#partition">partition</a>-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.</p>"""
    global_cluster_arn: NotRequired["capo_rds.types.string.String"]
    """<p>The Amazon Resource Name (ARN) for the global database cluster.</p>"""
    status: NotRequired["capo_rds.types.string.String"]
    """<p>Specifies the current state of this global database cluster.</p>"""
    engine: NotRequired["capo_rds.types.string.String"]
    """<p>The Aurora database engine used by the global database cluster.</p>"""
    engine_version: NotRequired["capo_rds.types.string.String"]
    """<p>Indicates the database engine version.</p>"""
    engine_lifecycle_support: NotRequired["capo_rds.types.string.String"]
    """<p>The lifecycle type for the global cluster.</p> <p>For more information, see CreateGlobalCluster.</p>"""
    database_name: NotRequired["capo_rds.types.string.String"]
    """<p>The default database name within the new global database cluster.</p>"""
    storage_encrypted: NotRequired["capo_rds.types.boolean_optional.BooleanOptional"]
    """<p>The storage encryption setting for the global database cluster.</p>"""
    storage_encryption_type: NotRequired[
        "capo_rds.types.storage_encryption_type.StorageEncryptionType"
    ]
    """<p>The type of encryption used to protect data at rest in the global database cluster. Possible values:</p> <ul> <li> <p> <code>none</code> - The global database cluster is not encrypted.</p> </li> <li> <p> <code>sse-rds</code> - The global database cluster is encrypted using an Amazon Web Services owned KMS key.</p> </li> <li> <p> <code>sse-kms</code> - The global database cluster is encrypted using a customer managed KMS key or Amazon Web Services managed KMS key.</p> </li> </ul>"""
    deletion_protection: NotRequired["capo_rds.types.boolean_optional.BooleanOptional"]
    """<p>The deletion protection setting for the new global database cluster.</p>"""
    global_cluster_members: NotRequired[
        "capo_rds.types.global_cluster_member_list.GlobalClusterMemberList"
    ]
    """<p>The list of primary and secondary clusters within the global database cluster.</p>"""
    endpoint: NotRequired["capo_rds.types.string.String"]
    """<p> The writer endpoint for the new global database cluster. This endpoint always points to the writer DB instance in the current primary cluster. </p>"""
    failover_state: NotRequired["capo_rds.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 (Aurora 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_rds.types.tag_list.TagList"]