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 the running cluster that is specified by DBClusterIdentifier. The cluster must be in the available state. For more information, see Stopping and Starting an Amazon DocumentDB Cluster.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to StopDBClusterAsync.

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

Syntax

C#
public abstract StopDBClusterResponse StopDBCluster(
         StopDBClusterRequest request
)

Parameters

request
Type: Amazon.DocDB.Model.StopDBClusterRequest

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

Return Value


The response from the StopDBCluster service method, as returned by DocDB.

Exceptions

ExceptionCondition
DBClusterNotFoundException DBClusterIdentifier doesn't refer to an existing cluster.
InvalidDBClusterStateException The cluster isn't in a valid state.
InvalidDBInstanceStateException The specified instance isn't in the available state.

Version Information

.NET Framework:
Supported in: 4.5 and newer, 3.5

See Also