switchover_global_cluster¶
Operation¶
switchover_global_cluster
async
¶
switchover_global_cluster(request: SwitchoverGlobalClusterInput | SwitchoverGlobalClusterInputDict, /, *, plugins: list[Plugin] | None = None) -> SwitchoverGlobalClusterOutput
switchover_global_cluster(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[SwitchoverGlobalClusterInputDict]) -> SwitchoverGlobalClusterOutput
Switches over the specified secondary DB cluster to be the new primary DB cluster in the global database cluster. Switchover operations were previously called "managed planned failovers."
Aurora promotes the specified secondary cluster to assume full read/write capabilities and demotes the current primary cluster to a secondary (read-only) cluster, maintaining the orginal replication topology. All secondary clusters are synchronized with the primary at the beginning of the process so the new primary continues operations for the Aurora global database without losing any data. Your database is unavailable for a short time while the primary and selected secondary clusters are assuming their new roles. For more information about switching over an Aurora global database, see Performing switchovers for Amazon Aurora global databases in the Amazon Aurora User Guide.
Note
This operation is intended for controlled environments, for operations such as "regional rotation" or to fall back to the original primary after a global database failover.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
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 |
|---|---|
SwitchoverGlobalClusterOutput
|
An instance of |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
SwitchoverGlobalClusterInput
dataclass
¶
Bases: _SerdeShape
Dataclass for SwitchoverGlobalClusterInput structure.
Attributes¶
global_cluster_identifier
class-attribute
instance-attribute
¶
global_cluster_identifier: str | None = ...
The identifier of the global database cluster to switch over. This parameter isn't case-sensitive.
Constraints:
- Must match the identifier of an existing global database cluster (Aurora global database).
target_db_cluster_identifier
class-attribute
instance-attribute
¶
target_db_cluster_identifier: str | None = ...
The identifier of the secondary Aurora DB cluster to promote to the new primary for the global database cluster. Use the Amazon Resource Name (ARN) for the identifier so that Aurora can locate the cluster in its Amazon Web Services Region.
Dictionaries¶
SwitchoverGlobalClusterInputDict
¶
Bases: TypedDict
Dictionary form of SwitchoverGlobalClusterInput.
Attributes¶
global_cluster_identifier
instance-attribute
¶
The identifier of the global database cluster to switch over. This parameter isn't case-sensitive.
Constraints:
- Must match the identifier of an existing global database cluster (Aurora global database).
target_db_cluster_identifier
instance-attribute
¶
The identifier of the secondary Aurora DB cluster to promote to the new primary for the global database cluster. Use the Amazon Resource Name (ARN) for the identifier so that Aurora can locate the cluster in its Amazon Web Services Region.
Output¶
SwitchoverGlobalClusterOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for SwitchoverGlobalClusterOutput 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
¶
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.