Skip to content

RDS  >  Operations  >  switchover_read_replica

switchover_read_replica

Operation

switchover_read_replica async

switchover_read_replica(request: SwitchoverReadReplicaInput | SwitchoverReadReplicaInputDict, /, *, plugins: list[Plugin] | None = None) -> SwitchoverReadReplicaOutput
switchover_read_replica(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[SwitchoverReadReplicaInputDict]) -> SwitchoverReadReplicaOutput

Switches over an Oracle standby database in an Oracle Data Guard environment, making it the new primary database. Issue this command in the Region that hosts the current standby database.

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
SwitchoverReadReplicaOutput

An instance of SwitchoverReadReplicaOutput.

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

SwitchoverReadReplicaInput dataclass

Bases: _SerdeShape

Dataclass for SwitchoverReadReplicaInput structure.

Attributes
db_instance_identifier class-attribute instance-attribute
db_instance_identifier: str | None = ...

The DB instance identifier of the current standby database. This value is stored as a lowercase string.

Constraints:

  • Must match the identifier of an existing Oracle read replica DB instance.

Dictionaries

SwitchoverReadReplicaInputDict

Bases: TypedDict

Dictionary form of SwitchoverReadReplicaInput.

Attributes
db_instance_identifier instance-attribute
db_instance_identifier: Required[str]

The DB instance identifier of the current standby database. This value is stored as a lowercase string.

Constraints:

  • Must match the identifier of an existing Oracle read replica DB instance.

Output

SwitchoverReadReplicaOutput dataclass

Bases: _SerdeShape

Dataclass for SwitchoverReadReplicaOutput structure.

Attributes

db_instance class-attribute instance-attribute
db_instance: DBInstance | None = ...

Contains the details of an Amazon RDS DB instance.

This data type is used as a response element in the operations CreateDBInstance, CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, ModifyDBInstance, PromoteReadReplica, RebootDBInstance, RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3, RestoreDBInstanceToPointInTime, StartDBInstance, and StopDBInstance.

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.