Skip to content

RDS  >  Operations  >  failover_global_cluster

failover_global_cluster

Operation

failover_global_cluster async

failover_global_cluster(request: FailoverGlobalClusterInput | FailoverGlobalClusterInputDict, /, *, plugins: list[Plugin] | None = None) -> FailoverGlobalClusterOutput
failover_global_cluster(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[FailoverGlobalClusterInputDict]) -> FailoverGlobalClusterOutput

Promotes the specified secondary DB cluster to be the primary DB cluster in the global database cluster to fail over or switch over a global database. Switchover operations were previously called "managed planned failovers."

Note

Although this operation can be used either to fail over or to switch over a global database cluster, its intended use is for global database failover. To switch over a global database cluster, we recommend that you use the SwitchoverGlobalCluster operation instead.

How you use this operation depends on whether you are failing over or switching over your global database cluster:

  • Failing over - Specify the AllowDataLoss parameter and don't specify the Switchover parameter.

  • Switching over - Specify the Switchover parameter or omit it, but don't specify the AllowDataLoss parameter.

About failing over and switching over

While failing over and switching over a global database cluster both change the primary DB cluster, you use these operations for different reasons:

  • Failing over - Use this operation to respond to an unplanned event, such as a Regional disaster in the primary Region. Failing over can result in a loss of write transaction data that wasn't replicated to the chosen secondary before the failover event occurred. However, the recovery process that promotes a DB instance on the chosen seconday DB cluster to be the primary writer DB instance guarantees that the data is in a transactionally consistent state.

For more information about failing over an Amazon Aurora global database, see Performing managed failovers for Aurora global databases in the Amazon Aurora User Guide.

  • Switching over - Use this operation on a healthy global database cluster for planned events, such as Regional rotation or to fail back to the original primary DB cluster after a failover operation. With this operation, there is no data loss.

For more information about switching over an Amazon Aurora global database, see Performing switchovers for Aurora global databases in the Amazon Aurora User Guide.

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
FailoverGlobalClusterOutput

An instance of FailoverGlobalClusterOutput.

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

FailoverGlobalClusterInput dataclass

Bases: _SerdeShape

Dataclass for FailoverGlobalClusterInput structure.

Attributes
allow_data_loss class-attribute instance-attribute
allow_data_loss: bool | None = ...

Specifies whether to allow data loss for this global database cluster operation. Allowing data loss triggers a global failover operation.

If you don't specify AllowDataLoss, the global database cluster operation defaults to a switchover.

Constraints:

  • Can't be specified together with the Switchover parameter.
global_cluster_identifier class-attribute instance-attribute
global_cluster_identifier: str | None = ...

The identifier of the global database cluster (Aurora global database) this operation should apply to. The identifier is the unique key assigned by the user when the Aurora global database is created. In other words, it's the name of the Aurora global database.

Constraints:

  • Must match the identifier of an existing global database cluster.
switchover class-attribute instance-attribute
switchover: bool | None = ...

Specifies whether to switch over this global database cluster.

Constraints:

  • Can't be specified together with the AllowDataLoss parameter.
target_db_cluster_identifier class-attribute instance-attribute
target_db_cluster_identifier: str | None = ...

The identifier of the secondary Aurora DB cluster that you want to promote to the 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

FailoverGlobalClusterInputDict

Bases: TypedDict

Dictionary form of FailoverGlobalClusterInput.

Attributes
allow_data_loss instance-attribute
allow_data_loss: bool | None

Specifies whether to allow data loss for this global database cluster operation. Allowing data loss triggers a global failover operation.

If you don't specify AllowDataLoss, the global database cluster operation defaults to a switchover.

Constraints:

  • Can't be specified together with the Switchover parameter.
global_cluster_identifier instance-attribute
global_cluster_identifier: Required[str]

The identifier of the global database cluster (Aurora global database) this operation should apply to. The identifier is the unique key assigned by the user when the Aurora global database is created. In other words, it's the name of the Aurora global database.

Constraints:

  • Must match the identifier of an existing global database cluster.
switchover instance-attribute
switchover: bool | None

Specifies whether to switch over this global database cluster.

Constraints:

  • Can't be specified together with the AllowDataLoss parameter.
target_db_cluster_identifier instance-attribute
target_db_cluster_identifier: Required[str]

The identifier of the secondary Aurora DB cluster that you want to promote to the 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

FailoverGlobalClusterOutput dataclass

Bases: _SerdeShape

Dataclass for FailoverGlobalClusterOutput 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.