remove_from_global_cluster

remove_from_global_cluster(**kwargs)

Detaches a Neptune DB cluster from a Neptune global database. A secondary cluster becomes a normal standalone cluster with read-write capability instead of being read-only, and no longer receives data from a the primary cluster.

See also: AWS API Documentation

Request Syntax

response = client.remove_from_global_cluster(
    GlobalClusterIdentifier='string',
    DbClusterIdentifier='string'
)

Parameters

• GlobalClusterIdentifier (string) --

  [REQUIRED]

  The identifier of the Neptune global database from which to detach the specified Neptune DB cluster.

• DbClusterIdentifier (string) --

  [REQUIRED]

  The Amazon Resource Name (ARN) identifying the cluster to be detached from the Neptune global database cluster.

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.DBClusterNotFoundFault