Skip to content

RDS  >  Operations  >  switchover_blue_green_deployment

switchover_blue_green_deployment

Operation

switchover_blue_green_deployment async

switchover_blue_green_deployment(request: SwitchoverBlueGreenDeploymentInput | SwitchoverBlueGreenDeploymentInputDict, /, *, plugins: list[Plugin] | None = None) -> SwitchoverBlueGreenDeploymentOutput
switchover_blue_green_deployment(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[SwitchoverBlueGreenDeploymentInputDict]) -> SwitchoverBlueGreenDeploymentOutput

Switches over a blue/green deployment.

Before you switch over, production traffic is routed to the databases in the blue environment. After you switch over, production traffic is routed to the databases in the green environment.

For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates 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
SwitchoverBlueGreenDeploymentOutput

An instance of SwitchoverBlueGreenDeploymentOutput.

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

SwitchoverBlueGreenDeploymentInput dataclass

Bases: _SerdeShape

Dataclass for SwitchoverBlueGreenDeploymentInput structure.

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

The resource ID of the blue/green deployment.

Constraints:

  • Must match an existing blue/green deployment resource ID.
switchover_timeout class-attribute instance-attribute
switchover_timeout: int | None = ...

The amount of time, in seconds, for the switchover to complete.

Default: 300

If the switchover takes longer than the specified duration, then any changes are rolled back, and no changes are made to the environments.

Dictionaries

SwitchoverBlueGreenDeploymentInputDict

Bases: TypedDict

Dictionary form of SwitchoverBlueGreenDeploymentInput.

Attributes
blue_green_deployment_identifier instance-attribute
blue_green_deployment_identifier: Required[str]

The resource ID of the blue/green deployment.

Constraints:

  • Must match an existing blue/green deployment resource ID.
switchover_timeout instance-attribute
switchover_timeout: int | None

The amount of time, in seconds, for the switchover to complete.

Default: 300

If the switchover takes longer than the specified duration, then any changes are rolled back, and no changes are made to the environments.

Output

SwitchoverBlueGreenDeploymentOutput dataclass

Bases: _SerdeShape

Dataclass for SwitchoverBlueGreenDeploymentOutput structure.

Attributes

blue_green_deployment class-attribute instance-attribute
blue_green_deployment: BlueGreenDeployment | None = ...

Details about a blue/green deployment.

For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.

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.