Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . rds ]

create-global-cluster

Description

Creates an Aurora global database spread across multiple 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 only applies to Aurora DB clusters.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-global-cluster
[--global-cluster-identifier <value>]
[--source-db-cluster-identifier <value>]
[--engine <value>]
[--engine-version <value>]
[--deletion-protection | --no-deletion-protection]
[--database-name <value>]
[--storage-encrypted | --no-storage-encrypted]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--global-cluster-identifier (string)

The cluster identifier of the new global database cluster.

--source-db-cluster-identifier (string)

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

--engine (string)

Provides the name of the database engine to be used for this DB cluster.

--engine-version (string)

The engine version of the Aurora global database.

--deletion-protection | --no-deletion-protection (boolean)

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

--database-name (string)

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

--storage-encrypted | --no-storage-encrypted (boolean)

The storage encryption setting for the new global database cluster.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

GlobalCluster -> (structure)

A data type representing an Aurora global database.

GlobalClusterIdentifier -> (string)

Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster.

GlobalClusterResourceId -> (string)

The AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.

GlobalClusterArn -> (string)

The Amazon Resource Name (ARN) for the global database cluster.

Status -> (string)

Specifies the current state of this global database cluster.

Engine -> (string)

The Aurora database engine used by the global database cluster.

EngineVersion -> (string)

Indicates the database engine version.

DatabaseName -> (string)

The default database name within the new global database cluster.

StorageEncrypted -> (boolean)

The storage encryption setting for the global database cluster.

DeletionProtection -> (boolean)

The deletion protection setting for the new global database cluster.

GlobalClusterMembers -> (list)

The list of cluster IDs for secondary clusters within the global database cluster. Currently limited to 1 item.

(structure)

A data structure with information about any primary and secondary clusters associated with an Aurora global database.

DBClusterArn -> (string)

The Amazon Resource Name (ARN) for each Aurora cluster.

Readers -> (list)

The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global database.

(string)

IsWriter -> (boolean)

Specifies whether the Aurora cluster is the primary cluster (that is, has read-write capability) for the Aurora global database with which it is associated.