Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster's metadata, including its endpoints and DB parameter groups. Aurora also retains the transaction logs so you can do a point-in-time restore if necessary.
For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.
NoteThis operation only applies to Aurora DB clusters.
Request ParametersFor information about the parameters that are common to all actions, see Common Parameters.
The DB cluster identifier of the Amazon Aurora DB cluster to be stopped. This parameter is stored as a lowercase string.
Type: String
Required: Yes
The following element is returned by the service.
Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
For an Amazon Aurora DB cluster, this data type is used as a response element in the operations CreateDBCluster
, DeleteDBCluster
, DescribeDBClusters
, FailoverDBCluster
, ModifyDBCluster
, PromoteReadReplicaDBCluster
, RestoreDBClusterFromS3
, RestoreDBClusterFromSnapshot
, RestoreDBClusterToPointInTime
, StartDBCluster
, and StopDBCluster
.
For a Multi-AZ DB cluster, this data type is used as a response element in the operations CreateDBCluster
, DeleteDBCluster
, DescribeDBClusters
, FailoverDBCluster
, ModifyDBCluster
, RebootDBCluster
, RestoreDBClusterFromSnapshot
, and RestoreDBClusterToPointInTime
.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
Type: DBCluster object
For information about the errors that are common to all actions, see Common Errors.
DBClusterIdentifier
doesn't refer to an existing DB cluster.
HTTP Status Code: 404
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 DB shard group must be in the available state.
HTTP Status Code: 400
This example illustrates one usage of StopDBCluster.
Sample Request
https://rds.us-east-1.amazonaws.com/
?Action=StopDBCluster
&DBClusterIdentifier=mydbcluster
&SignatureMethod=HmacSHA256
&SignatureVersion=4
&Version=2014-10-31
&X-Amz-Algorithm=AWS4-HMAC-SHA256
&X-Amz-Credential=AKIADQKE4SARGYLE/20131016/us-west-1/rds/aws4_request
&X-Amz-Date=20131016T233051Z
&X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
&X-Amz-Signature=087a8eb41cb1ab5f99e81575f23e73757ffc6a1e42d7d2b30b9cc0be988cff97
See Also
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