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.

Creates a blue/green deployment.

A blue/green deployment creates a staging environment that copies the production environment. In a blue/green deployment, the blue environment is the current production environment. The green environment is the staging environment, and it stays in sync with the current production environment.

You can make changes to the databases in the green environment without affecting production workloads. For example, you can upgrade the major or minor DB engine version, change database parameters, or make schema changes in the staging environment. You can thoroughly test changes in the green environment. When ready, you can switch over the environments to promote the green environment to be the new production environment. The switchover typically takes under a minute.

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 BeginCreateBlueGreenDeployment and EndCreateBlueGreenDeployment.

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

Syntax

C#
public abstract Task<CreateBlueGreenDeploymentResponse> CreateBlueGreenDeploymentAsync(
         CreateBlueGreenDeploymentRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.RDS.Model.CreateBlueGreenDeploymentRequest

Container for the necessary parameters to execute the CreateBlueGreenDeployment 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 CreateBlueGreenDeployment service method, as returned by RDS.

Exceptions

ExceptionCondition
BlueGreenDeploymentAlreadyExistsException A blue/green deployment with the specified name already exists.
DBClusterNotFoundException DBClusterIdentifier doesn't refer to an existing DB cluster.
DBClusterParameterGroupNotFoundException DBClusterParameterGroupName doesn't refer to an existing DB cluster parameter group.
DBClusterQuotaExceededException The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.
DBInstanceNotFoundException DBInstanceIdentifier doesn't refer to an existing DB instance.
DBParameterGroupNotFoundException DBParameterGroupName doesn't refer to an existing DB parameter group.
InstanceQuotaExceededException The request would result in the user exceeding the allowed number of DB instances.
InvalidDBClusterStateException The requested operation can't be performed while the cluster is in this state.
InvalidDBInstanceStateException The DB instance isn't in a valid state.
SourceClusterNotSupportedException The source DB cluster isn't supported for a blue/green deployment.
SourceDatabaseNotSupportedException The source DB instance isn't supported for a blue/green deployment.

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