CreateGlobalCluster - Amazon Neptune

CreateGlobalCluster

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.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

DeletionProtection

The deletion protection setting for the new global database. The global database can't be deleted when deletion protection is enabled.

Type: Boolean

Required: No

Engine

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

Valid values: neptune

Type: String

Required: No

EngineVersion

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

Valid values: 1.2.0.0 or above.

Type: String

Required: No

GlobalClusterIdentifier

The cluster identifier of the new global database cluster.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

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

Required: Yes

SourceDBClusterIdentifier

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

Type: String

Required: No

StorageEncrypted

The storage encryption setting for the new global database cluster.

Type: Boolean

Required: No

Response Elements

The following element is returned by the service.

GlobalCluster

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.

Type: GlobalCluster object

Errors

For information about the errors that are common to all actions, see Common Errors.

DBClusterNotFoundFault

DBClusterIdentifier does not refer to an existing DB cluster.

HTTP Status Code: 404

GlobalClusterAlreadyExistsFault

The GlobalClusterIdentifier already exists. Choose a new global database identifier (unique name) to create a new global database cluster.

HTTP Status Code: 400

GlobalClusterQuotaExceededFault

The number of global database clusters for this account is already at the maximum allowed.

HTTP Status Code: 400

InvalidDBClusterStateFault

The DB cluster is not in a valid state.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: