modify_global_cluster¶
Operation¶
async
¶
modify_global_cluster(input: ModifyGlobalClusterInput, plugins: list[Plugin] | None = None) -> ModifyGlobalClusterOutput
Modifies a setting for an Amazon Aurora global database cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
Note
This operation only applies to Aurora global database clusters.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ModifyGlobalClusterInput
|
An instance of |
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 |
|---|---|
ModifyGlobalClusterOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for ModifyGlobalClusterInput structure.
Attributes¶
class-attribute
instance-attribute
¶
allow_major_version_upgrade: bool | None = ...
Specifies whether to allow major version upgrades.
Constraints: Must be enabled if you specify a value for the
EngineVersion parameter that's a different major version than the
global cluster's current version.
If you upgrade the major version of a global database, the cluster and DB instance parameter groups are set to the default parameter groups for the new version. Apply any custom parameter groups after completing the upgrade.
class-attribute
instance-attribute
¶
deletion_protection: bool | None = ...
Specifies whether to enable deletion protection for the global database cluster. The global database cluster can't be deleted when deletion protection is enabled.
class-attribute
instance-attribute
¶
engine_version: str | None = ...
The version number of the database engine to which you want to upgrade.
To list all of the available engine versions for aurora-mysql (for
MySQL-based Aurora global databases), use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'
To list all of the available engine versions for aurora-postgresql
(for PostgreSQL-based Aurora global databases), use the following
command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'
class-attribute
instance-attribute
¶
global_cluster_identifier: str | None = ...
The cluster identifier for the global cluster to modify. This parameter isn't case-sensitive.
Constraints:
- Must match the identifier of an existing global database cluster.
class-attribute
instance-attribute
¶
new_global_cluster_identifier: str | None = ...
The new cluster identifier for the global database cluster. This value is stored as a lowercase string.
Constraints:
-
Must contain from 1 to 63 letters, numbers, or hyphens.
-
The first character must be a letter.
-
Can't end with a hyphen or contain two consecutive hyphens.
Example: my-cluster2
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for ModifyGlobalClusterOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
A data type representing an Aurora global database.
class-attribute
instance-attribute
¶
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.