StopDBInstance
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.
Note
This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.
For Aurora clusters, use StopDBCluster instead.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- DBInstanceIdentifier
-
The user-supplied instance identifier.
Type: String
Required: Yes
- DBSnapshotIdentifier
-
The user-supplied instance identifier of the DB Snapshot created immediately before the DB instance is stopped.
Type: String
Required: No
Response Elements
The following element is returned by the service.
- DBInstance
-
Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations
CreateDBInstance,CreateDBInstanceReadReplica,DeleteDBInstance,DescribeDBInstances,ModifyDBInstance,PromoteReadReplica,RebootDBInstance,RestoreDBInstanceFromDBSnapshot,RestoreDBInstanceFromS3,RestoreDBInstanceToPointInTime,StartDBInstance, andStopDBInstance.Type: DBInstance object
Errors
For information about the errors that are common to all actions, see Common Errors.
- DBInstanceNotFound
-
DBInstanceIdentifierdoesn't refer to an existing DB instance.HTTP Status Code: 404
- DBSnapshotAlreadyExists
-
DBSnapshotIdentifieris already used by an existing snapshot.HTTP Status Code: 400
- InvalidDBClusterStateFault
-
The requested operation can't be performed while the cluster is in this state.
HTTP Status Code: 400
- InvalidDBInstanceState
-
The DB instance isn't in a valid state.
HTTP Status Code: 400
- SnapshotQuotaExceeded
-
The request would result in the user exceeding the allowed number of DB snapshots.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
