CreateGlobalClusterMessage
¶
Source code in docs_src/capo_rds/types/create_global_cluster_message.py
database_name
instance-attribute
¶
database_name: NotRequired[String]
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
SourceDBClusterIdentifieris specified. In this case, Amazon Aurora uses the database name from the source DB cluster.
deletion_protection
instance-attribute
¶
deletion_protection: NotRequired[BooleanOptional]
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
instance-attribute
¶
engine: NotRequired[String]
The database engine to use for this global database cluster.
Valid Values: aurora-mysql | aurora-postgresql
Constraints:
-
Can't be specified if
SourceDBClusterIdentifieris specified. In this case, Amazon Aurora uses the engine of the source DB cluster.
engine_lifecycle_support
instance-attribute
¶
engine_lifecycle_support: NotRequired[String]
The lifecycle 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 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
instance-attribute
¶
engine_version: NotRequired[String]
The engine version to use for this global database cluster.
Constraints:
-
Can't be specified if
SourceDBClusterIdentifieris specified. In this case, Amazon Aurora uses the engine version of the source DB cluster.
global_cluster_identifier
instance-attribute
¶
global_cluster_identifier: NotRequired[GlobalClusterIdentifier]
The cluster identifier for this global database cluster. This parameter is stored as a lowercase string.
source_db_cluster_identifier
instance-attribute
¶
source_db_cluster_identifier: NotRequired[String]
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
instance-attribute
¶
storage_encrypted: NotRequired[BooleanOptional]
Specifies whether to enable storage encryption for the new global database cluster.
Constraints:
-
Can't be specified if
SourceDBClusterIdentifieris specified. In this case, Amazon Aurora uses the setting from the source DB cluster.