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 a DB instance. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if necessary. For more information, see Stopping and Starting a DB instance in the AWS RDS user guide.

Note:

For PCL this operation is only available in asynchronous form. Please refer to StopDBInstanceAsync.

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

Syntax

C#
public virtual StopDBInstanceResponse StopDBInstance(
         StopDBInstanceRequest request
)
Parameters
request
Type: Amazon.RDS.Model.StopDBInstanceRequest

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

Return Value
The response from the StopDBInstance service method, as returned by RDS.

Exceptions

ExceptionCondition
DBInstanceNotFoundException DBInstanceIdentifier does not refer to an existing DB instance.
DBSnapshotAlreadyExistsException DBSnapshotIdentifier is already used by an existing snapshot.
InvalidDBClusterStateException The DB cluster is not in a valid state.
InvalidDBInstanceStateException The specified DB instance is not in the available state.
SnapshotQuotaExceededException Request would result in user exceeding the allowed number of DB snapshots.

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

See Also