DocDB / Client / failover_global_cluster

failover_global_cluster

DocDB.Client.failover_global_cluster(**kwargs)

Promotes the specified secondary DB cluster to be the primary DB cluster in the global cluster when failing over a global cluster occurs.

Use this operation to respond to an unplanned event, such as a regional disaster in the primary region. Failing over can result in a loss of write transaction data that wasn’t replicated to the chosen secondary before the failover event occurred. However, the recovery process that promotes a DB instance on the chosen seconday DB cluster to be the primary writer DB instance guarantees that the data is in a transactionally consistent state.

See also: AWS API Documentation

Request Syntax

response = client.failover_global_cluster(
    GlobalClusterIdentifier='string',
    TargetDbClusterIdentifier='string',
    AllowDataLoss=True|False,
    Switchover=True|False
)

Parameters:

• GlobalClusterIdentifier (string) –

  [REQUIRED]

  The identifier of the Amazon DocumentDB global cluster to apply this operation. The identifier is the unique key assigned by the user when the cluster is created. In other words, it’s the name of the global cluster.

  Constraints:

  • Must match the identifier of an existing global cluster.

  • Minimum length of 1. Maximum length of 255.

  Pattern: [A-Za-z][0-9A-Za-z-:._]*

• TargetDbClusterIdentifier (string) –

  [REQUIRED]

  The identifier of the secondary Amazon DocumentDB cluster that you want to promote to the primary for the global cluster. Use the Amazon Resource Name (ARN) for the identifier so that Amazon DocumentDB can locate the cluster in its Amazon Web Services region.

  Constraints:

  • Must match the identifier of an existing secondary cluster.

  • Minimum length of 1. Maximum length of 255.

  Pattern: [A-Za-z][0-9A-Za-z-:._]*

• AllowDataLoss (boolean) –

  Specifies whether to allow data loss for this global cluster operation. Allowing data loss triggers a global failover operation.

  If you don’t specify AllowDataLoss, the global cluster operation defaults to a switchover.

  Constraints:

  • Can’t be specified together with the Switchover parameter.

• Switchover (boolean) –

  Specifies whether to switch over this global database cluster.

  Constraints:

  • Can’t be specified together with the AllowDataLoss parameter.

Return type:

dict

Returns:

Response Syntax

{
    'GlobalCluster': {
        'GlobalClusterIdentifier': 'string',
        'GlobalClusterResourceId': 'string',
        'GlobalClusterArn': 'string',
        'Status': 'string',
        'Engine': 'string',
        'EngineVersion': 'string',
        'DatabaseName': 'string',
        'StorageEncrypted': True|False,
        'DeletionProtection': True|False,
        'GlobalClusterMembers': [
            {
                'DBClusterArn': 'string',
                'Readers': [
                    'string',
                ],
                'IsWriter': True|False
            },
        ]
    }
}

Response Structure

• (dict) –

  • GlobalCluster (dict) –

    A data type representing an Amazon DocumentDB global cluster.

    • GlobalClusterIdentifier (string) –

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

    • GlobalClusterResourceId (string) –

      The Amazon Web Services Region-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.

    • GlobalClusterArn (string) –

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

    • Status (string) –

      Specifies the current state of this global cluster.

    • Engine (string) –

      The Amazon DocumentDB database engine used by the global cluster.

    • EngineVersion (string) –

      Indicates the database engine version.

    • DatabaseName (string) –

      The default database name within the new global cluster.

    • StorageEncrypted (boolean) –

      The storage encryption setting for the global cluster.

    • DeletionProtection (boolean) –

      The deletion protection setting for the new global cluster.

    • GlobalClusterMembers (list) –

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

      • (dict) –

        A data structure with information about any primary and secondary clusters associated with an Amazon DocumentDB global clusters.

        • DBClusterArn (string) –

          The Amazon Resource Name (ARN) for each Amazon DocumentDB cluster.

        • Readers (list) –

          The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global cluster.

          • (string) –

        • IsWriter (boolean) –

          Specifies whether the Amazon DocumentDB cluster is the primary cluster (that is, has read-write capability) for the Amazon DocumentDB global cluster with which it is associated.

Exceptions

• DocDB.Client.exceptions.GlobalClusterNotFoundFault

• DocDB.Client.exceptions.InvalidGlobalClusterStateFault

• DocDB.Client.exceptions.InvalidDBClusterStateFault

• DocDB.Client.exceptions.DBClusterNotFoundFault