Create Global Cluster
rds_create_global_cluster | R Documentation |
Creates an Aurora global database spread across multiple Amazon Web Services Regions¶
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 create the primary and secondary DB clusters in the global database. Or you can specify an existing Aurora cluster during the create operation, and this cluster becomes the primary cluster of the global database.
This operation applies only to Aurora DB clusters.
Usage¶
rds_create_global_cluster(GlobalClusterIdentifier,
SourceDBClusterIdentifier, Engine, EngineVersion,
EngineLifecycleSupport, DeletionProtection, DatabaseName,
StorageEncrypted)
Arguments¶
GlobalClusterIdentifier
The cluster identifier for this global database cluster. This parameter is stored as a lowercase string.
SourceDBClusterIdentifier
The Amazon Resource Name (ARN) to use as the primary cluster of the global database.
If you provide a value for this parameter, don't specify values for the following settings because Amazon Aurora uses the values from the specified source DB cluster:
DatabaseName
Engine
EngineVersion
StorageEncrypted
Engine
The database engine to use for this global database cluster.
Valid Values:
aurora-mysql | aurora-postgresql
Constraints:
Can't be specified if
SourceDBClusterIdentifier
is specified. In this case, Amazon Aurora uses the engine of the source DB cluster.
EngineVersion
The engine version to use for this global database cluster.
Constraints:
Can't be specified if
SourceDBClusterIdentifier
is specified. In this case, Amazon Aurora uses the engine version of the source DB cluster.
EngineLifecycleSupport
The life cycle type for this global database cluster.
By default, this value is set to
open-source-rds-extended-support
, which enrolls your global cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value toopen-source-rds-extended-support-disabled
. In this case, creating the global cluster will fail if the DB major version is past its end of standard support date.This setting only applies to Aurora PostgreSQL-based global databases.
You can use this setting to enroll your global cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your global cluster past the end of standard support for that engine version. For more information, see Using Amazon RDS Extended Support in the Amazon Aurora User Guide.
Valid Values:
open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default:
open-source-rds-extended-support
DeletionProtection
Specifies whether to enable deletion protection for the new global database cluster. The global database can't be deleted when deletion protection is enabled.
DatabaseName
The name for your database of up to 64 alphanumeric characters. If you don't specify a name, Amazon Aurora doesn't create a database in the global database cluster.
Constraints:
Can't be specified if
SourceDBClusterIdentifier
is specified. In this case, Amazon Aurora uses the database name from the source DB cluster.
StorageEncrypted
Specifies whether to enable storage encryption for the new global database cluster.
Constraints:
Can't be specified if
SourceDBClusterIdentifier
is specified. In this case, Amazon Aurora uses the setting from the source DB cluster.
Value¶
A list with the following syntax:
list(
GlobalCluster = list(
GlobalClusterIdentifier = "string",
GlobalClusterResourceId = "string",
GlobalClusterArn = "string",
Status = "string",
Engine = "string",
EngineVersion = "string",
EngineLifecycleSupport = "string",
DatabaseName = "string",
StorageEncrypted = TRUE|FALSE,
DeletionProtection = TRUE|FALSE,
GlobalClusterMembers = list(
list(
DBClusterArn = "string",
Readers = list(
"string"
),
IsWriter = TRUE|FALSE,
GlobalWriteForwardingStatus = "enabled"|"disabled"|"enabling"|"disabling"|"unknown",
SynchronizationStatus = "connected"|"pending-resync"
)
),
FailoverState = list(
Status = "pending"|"failing-over"|"cancelling",
FromDbClusterArn = "string",
ToDbClusterArn = "string",
IsDataLossAllowed = TRUE|FALSE
)
)
)