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.
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 BeginStopDBInstance and EndStopDBInstance.
Namespace: Amazon.RDS
Assembly: AWSSDK.RDS.dll
Version: 3.x.y.z
public abstract Task<StopDBInstanceResponse> StopDBInstanceAsync( StopDBInstanceRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the StopDBInstance service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Exception | Condition |
---|---|
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. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5