Neptune / Client / create_global_cluster

create_global_cluster

Neptune.Client.create_global_cluster(**kwargs)

Creates a Neptune global database spread across multiple Amazon Regions. The global database contains a single primary cluster with read-write capability, and read-only secondary clusters that receive data from the primary cluster through high-speed replication performed by the Neptune storage subsystem.

You can create a global database that is initially empty, and then add a primary cluster and secondary clusters to it, or you can specify an existing Neptune cluster during the create operation to become the primary cluster of the global database.

See also: AWS API Documentation

Request Syntax

response = client.create_global_cluster(
    GlobalClusterIdentifier='string',
    SourceDBClusterIdentifier='string',
    Engine='string',
    EngineVersion='string',
    DeletionProtection=True|False,
    StorageEncrypted=True|False
)

Parameters:

• GlobalClusterIdentifier (string) –

  [REQUIRED]

  The cluster identifier of the new global database cluster.

• SourceDBClusterIdentifier (string) – (Optional) The Amazon Resource Name (ARN) of an existing Neptune DB cluster to use as the primary cluster of the new global database.

• Engine (string) –

  The name of the database engine to be used in the global database.

  Valid values: neptune

• EngineVersion (string) –

  The Neptune engine version to be used by the global database.

  Valid values: 1.2.0.0 or above.

• DeletionProtection (boolean) – The deletion protection setting for the new global database. The global database can’t be deleted when deletion protection is enabled.

• StorageEncrypted (boolean) – The storage encryption setting for the new 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.GlobalClusterAlreadyExistsFault

• Neptune.Client.exceptions.GlobalClusterQuotaExceededFault

• Neptune.Client.exceptions.InvalidDBClusterStateFault

• Neptune.Client.exceptions.DBClusterNotFoundFault