Skip to content

RDS  >  Operations  >  create_global_cluster

create_global_cluster

Operation

create_global_cluster async 

create_global_cluster(input: CreateGlobalClusterInput, plugins: list[Plugin] | None = None) -> CreateGlobalClusterOutput

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.

Note

This operation applies only to Aurora DB clusters.

Parameters:

Name Type Description Default
input CreateGlobalClusterInput

An instance of CreateGlobalClusterInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
CreateGlobalClusterOutput

An instance of CreateGlobalClusterOutput.

Input

CreateGlobalClusterInput dataclass

Bases: _SerdeShape

Dataclass for CreateGlobalClusterInput structure.

Attributes

database_name class-attribute instance-attribute 
database_name: str | None = ...

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.
deletion_protection class-attribute instance-attribute 
deletion_protection: bool | None = ...

Specifies whether to enable deletion protection for the new global database cluster. The global database can't be deleted when deletion protection is enabled.

engine class-attribute instance-attribute 
engine: str | None = ...

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.
engine_lifecycle_support class-attribute instance-attribute 
engine_lifecycle_support: str | None = ...

The lifecycle type for this global database cluster.

Note

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 to open-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 Amazon RDS Extended Support with Amazon Aurora 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

engine_version class-attribute instance-attribute 
engine_version: str | None = ...

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.
global_cluster_identifier class-attribute instance-attribute 
global_cluster_identifier: str | None = ...

The cluster identifier for this global database cluster. This parameter is stored as a lowercase string.

source_db_cluster_identifier class-attribute instance-attribute 
source_db_cluster_identifier: str | None = ...

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

storage_encrypted class-attribute instance-attribute 
storage_encrypted: bool | None = ...

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.
tags class-attribute instance-attribute 
tags: list[Tag] | None = ...

Tags to assign to the global cluster.

Output

CreateGlobalClusterOutput dataclass

Bases: _SerdeShape

Dataclass for CreateGlobalClusterOutput structure.

Attributes

global_cluster class-attribute instance-attribute 
global_cluster: GlobalCluster | None = ...

A data type representing an Aurora global database.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.