stopDBCluster method

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

Stops the running cluster that is specified by DBClusterIdentifier. The cluster must be in the available state. For more information, see Stopping and Starting an Amazon DocumentDB Cluster.

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

Parameter dBClusterIdentifier : The identifier of the cluster to stop. Example: docdb-2019-05-28-15-24-52

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);
}