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 RDS 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 an Amazon RDS DB Instance Temporarily in the Amazon RDS User Guide.

This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For Aurora clusters, use StopDBCluster instead.

Note:

For .NET Core 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 doesn't refer to an existing DB instance.
DBSnapshotAlreadyExistsException DBSnapshotIdentifier is already used by an existing snapshot.
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.
SnapshotQuotaExceededException The request would result in the user exceeding the allowed number of DB snapshots.

Version Information

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

See Also