stopDBCluster method

Future<StopDBClusterResult> stopDBCluster({ required String dBClusterIdentifier, })

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.

May throw DBClusterNotFoundFault. May throw InvalidDBClusterStateFault. May throw InvalidDBInstanceStateFault.

Parameter dBClusterIdentifier : The DB cluster identifier of the Amazon Aurora DB cluster to be stopped. This parameter is stored as a lowercase string.

Implementation

Future<StopDBClusterResult> stopDBCluster({
  required String dBClusterIdentifier,
}) async {
  ArgumentError.checkNotNull(dBClusterIdentifier, 'dBClusterIdentifier');
  final $request = <String, dynamic>{};
  $request['DBClusterIdentifier'] = dBClusterIdentifier;
  final $result = await _protocol.send(
    $request,
    action: 'StopDBCluster',
    version: '2014-10-31',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['StopDBClusterMessage'],
    shapes: shapes,
    resultWrapper: 'StopDBClusterResult',
  );
  return StopDBClusterResult.fromXml($result);
}