stopDBCluster method

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

Stops an Amazon Neptune DB cluster. When you stop a DB cluster, Neptune retains the DB cluster's metadata, including its endpoints and DB parameter groups.

Neptune also retains the transaction logs so you can do a point-in-time restore if necessary.

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

Parameter dBClusterIdentifier : The DB cluster identifier of the Neptune 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);
}