AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginSwitchoverBlueGreenDeployment and EndSwitchoverBlueGreenDeployment.

Namespace: Amazon.RDS
Assembly: AWSSDK.RDS.dll
Version: 3.x.y.z

Syntax

C#
public abstract Task<SwitchoverBlueGreenDeploymentResponse> SwitchoverBlueGreenDeploymentAsync(
         SwitchoverBlueGreenDeploymentRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.RDS.Model.SwitchoverBlueGreenDeploymentRequest

Container for the necessary parameters to execute the SwitchoverBlueGreenDeployment service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the SwitchoverBlueGreenDeployment service method, as returned by RDS.

Exceptions

ExceptionCondition
BlueGreenDeploymentNotFoundException BlueGreenDeploymentIdentifier doesn't refer to an existing blue/green deployment.
InvalidBlueGreenDeploymentStateException The blue/green deployment can't be switched over or deleted because there is an invalid configuration in the green environment.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer

See Also