Stops an Amazon RDS DB instance temporarily. 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. The instance restarts automatically after 7 days.
For more information, see Stopping an Amazon RDS DB Instance Temporarily in the Amazon RDS User Guide.
NoteThis command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For Aurora clusters, use StopDBCluster
instead.
For information about the parameters that are common to all actions, see Common Parameters.
The user-supplied instance identifier.
Type: String
Required: Yes
The user-supplied instance identifier of the DB Snapshot created immediately before the DB instance is stopped.
Type: String
Required: No
The following element is returned by the service.
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
, and StopDBInstance
.
Type: DBInstance object
For information about the errors that are common to all actions, see Common Errors.
DBInstanceIdentifier
doesn't refer to an existing DB instance.
HTTP Status Code: 404
DBSnapshotIdentifier
is already used by an existing snapshot.
HTTP Status Code: 400
The requested operation can't be performed while the cluster is in this state.
HTTP Status Code: 400
The DB instance isn't in a valid state.
HTTP Status Code: 400
The request would result in the user exceeding the allowed number of DB snapshots.
HTTP Status Code: 400
For more information about using this API in one of the language-specific AWS SDKs, see the following:
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4