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.

Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster's metadata, including its endpoints and DB parameter groups. Aurora also retains the transaction logs so you can do a point-in-time restore if necessary.

For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.

This operation only applies to Aurora DB clusters.

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 BeginStopDBCluster and EndStopDBCluster.

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

Syntax

C#
public abstract Task<StopDBClusterResponse> StopDBClusterAsync(
         StopDBClusterRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.RDS.Model.StopDBClusterRequest

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

Exceptions

ExceptionCondition
DBClusterNotFoundException DBClusterIdentifier doesn't refer to an existing DB cluster.
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.
InvalidDBShardGroupStateException The DB shard group must be in the available state.

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