Neptune / Client / switchover_global_cluster

switchover_global_cluster

Neptune.Client.switchover_global_cluster(**kwargs)

Switches over the specified secondary DB cluster to be the new primary DB cluster in the global database cluster. Switchover operations were previously called “managed planned failovers.”

Promotes the specified secondary cluster to assume full read/write capabilities and demotes the current primary cluster to a secondary (read-only) cluster, maintaining the original replication topology. All secondary clusters are synchronized with the primary at the beginning of the process so the new primary continues operations for the global database without losing any data. Your database is unavailable for a short time while the primary and selected secondary clusters are assuming their new roles.

Note

This operation is intended for controlled environments, for operations such as “regional rotation” or to fall back to the original primary after a global database failover.

See also: AWS API Documentation

Request Syntax

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

  • GlobalClusterIdentifier (string) –

    [REQUIRED]

    The identifier of the global database cluster to switch over. This parameter isn’t case-sensitive.

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

  • 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
            },
        ],
        'FailoverState': {
            'Status': 'pending'|'failing-over'|'cancelling',
            'FromDbClusterArn': 'string',
            'ToDbClusterArn': 'string',
            'IsDataLossAllowed': 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.

      • FailoverState (dict) –

        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.

        • Status (string) –

          The current status of the global cluster. Possible values are as follows:

          • pending – The service received a request to switch over or fail over the global cluster. The global cluster’s primary DB cluster and the specified secondary DB cluster are being verified before the operation starts.

          • failing-over – Neptune is promoting the chosen secondary Neptune DB cluster to become the new primary DB cluster to fail over the global cluster.

          • cancelling – The request to switch over or fail over the global cluster was cancelled and the primary Neptune DB cluster and the selected secondary Neptune DB cluster are returning to their previous states.

          • switching-over – This status covers the range of Neptune internal operations that take place during the switchover process, such as demoting the primary Neptune DB cluster, promoting the secondary Neptune DB cluster, and synchronizing replicas.

        • FromDbClusterArn (string) –

          The Amazon Resource Name (ARN) of the Neptune DB cluster that is currently being demoted, and which is associated with this state.

        • ToDbClusterArn (string) –

          The Amazon Resource Name (ARN) of the Neptune DB cluster that is currently being promoted, and which is associated with this state.

        • IsDataLossAllowed (boolean) –

          Indicates whether the operation is a global switchover or a global failover. If data loss is allowed, then the operation is a global failover. Otherwise, it’s a switchover.

Exceptions