Neptune / Client / failover_global_cluster

failover_global_cluster#

Neptune.Client.failover_global_cluster(**kwargs)#

Initiates the failover process for a Neptune global database.

A failover for a Neptune global database promotes one of secondary read-only DB clusters to be the primary DB cluster and demotes the primary DB cluster to being a secondary (read-only) DB cluster. In other words, the role of the current primary DB cluster and the selected target secondary DB cluster are switched. The selected secondary DB cluster assumes full read/write capabilities for the Neptune global database.

Note

This action applies only to Neptune global databases. This action is only intended for use on healthy Neptune global databases with healthy Neptune DB clusters and no region-wide outages, to test disaster recovery scenarios or to reconfigure the global database topology.

See also: AWS API Documentation

Request Syntax

response = client.failover_global_cluster(
    GlobalClusterIdentifier='string',
    TargetDbClusterIdentifier='string'
)
Parameters:

  • GlobalClusterIdentifier (string) –

    [REQUIRED]

    Identifier of the Neptune global database that should be failed over. The identifier is the unique key assigned by the user when the Neptune global database was created. In other words, it’s the name of the global database that you want to fail over.

    Constraints: Must match the identifier of an existing Neptune global database.

  • TargetDbClusterIdentifier (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the secondary Neptune DB cluster that you want to promote to primary for the global database.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • GlobalCluster (dict) –

      Contains the details of an Amazon Neptune global database.

      This data type is used as a response element for the CreateGlobalCluster, DescribeGlobalClusters, ModifyGlobalCluster, DeleteGlobalCluster, FailoverGlobalCluster, and RemoveFromGlobalCluster actions.

      • GlobalClusterIdentifier (string) –

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

      • GlobalClusterResourceId (string) –

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

      • GlobalClusterArn (string) –

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

      • Status (string) –

        Specifies the current state of this global database.

      • Engine (string) –

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

      • EngineVersion (string) –

        The Neptune engine version used by the global database.

      • StorageEncrypted (boolean) –

        The storage encryption setting for the global database.

      • DeletionProtection (boolean) –

        The deletion protection setting for the global database.

      • GlobalClusterMembers (list) –

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

        • (dict) –

          A data structure with information about any primary and secondary clusters associated with an Neptune global database.

          • DBClusterArn (string) –

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

          • Readers (list) –

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

            • (string) –

          • IsWriter (boolean) –

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

Exceptions

  • Neptune.Client.exceptions.GlobalClusterNotFoundFault

  • Neptune.Client.exceptions.InvalidGlobalClusterStateFault

  • Neptune.Client.exceptions.InvalidDBClusterStateFault

  • Neptune.Client.exceptions.DBClusterNotFoundFault