create-global-cluster¶

Description¶

Creates an Aurora global database spread across multiple Amazon Web Services 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.

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 | --cli-input-yaml]
[--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)

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 alphanumeric 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 | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To create a global DB cluster

The following create-global-cluster example creates a new Aurora MySQL-compatible global DB cluster.

aws rds create-global-cluster \
    --global-cluster-identifier myglobalcluster \
    --engine aurora-mysql

Output:

{
    "GlobalCluster": {
        "GlobalClusterIdentifier": "myglobalcluster",
        "GlobalClusterResourceId": "cluster-f0e523bfe07aabb",
        "GlobalClusterArn": "arn:aws:rds::123456789012:global-cluster:myglobalcluster",
        "Status": "available",
        "Engine": "aurora-mysql",
        "EngineVersion": "5.7.mysql_aurora.2.07.2",
        "StorageEncrypted": false,
        "DeletionProtection": false,
        "GlobalClusterMembers": []
    }
}

For more information, see Creating an Aurora global database in the Amazon Aurora User Guide.

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 Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services 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.

GlobalWriteForwardingStatus -> (string)

Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.

FailoverState -> (structure)

A data object containing all properties for the current state of an in-process or pending failover process for this Aurora global database. This object is empty unless the FailoverGlobalCluster API operation has been called on this Aurora global database ( GlobalCluster ).

Status -> (string)

The current status of the Aurora global database ( GlobalCluster ). Possible values are as follows:

pending – A request to fail over the Aurora global database ( GlobalCluster ) has been received by the service. The GlobalCluster ‘s primary DB cluster and the specified secondary DB cluster are being verified before the failover process can start.

failing-over – This status covers the range of Aurora internal operations that take place during the failover process, such as demoting the primary Aurora DB cluster, promoting the secondary Aurora DB, and synchronizing replicas.

cancelling – The request to fail over the Aurora global database ( GlobalCluster ) was cancelled and the primary Aurora DB cluster and the selected secondary Aurora DB cluster are returning to their previous states.

FromDbClusterArn -> (string)

The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being demoted, and which is associated with this state.

ToDbClusterArn -> (string)

The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being promoted, and which is associated with this state.

Table of Contents

Feedback

User Guide