CreateGlobalCluster - Amazon Relational Database Service

CreateGlobalCluster

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

You can create a global database that is initially empty, and then add a primary cluster and a secondary cluster to it. Or you can specify an existing Aurora cluster during the create operation, and this cluster becomes the primary cluster of the global database.

Note

This action applies only to Aurora DB clusters.

Request Parameters

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

DatabaseName

The name for your database of up to 64 alphanumeric characters. If you do not provide a name, Amazon Aurora will not create a database in the global database cluster you are creating.

Type: String

Required: No

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 for this DB cluster.

Type: String

Required: No

EngineVersion

The engine version of the Aurora global database.

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

The Amazon Resource Name (ARN) to use as the primary cluster of the global database. This parameter is optional.

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

A data type representing an Aurora global database.

Type: GlobalCluster object

Errors

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

DBClusterNotFoundFault

DBClusterIdentifier doesn't 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 requested operation can't be performed while the cluster is in this 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: