stopRelationalDatabase method

Future<StopRelationalDatabaseResult> stopRelationalDatabase({ required String relationalDatabaseName, String? relationalDatabaseSnapshotName, })

Stops a specific database that is currently running in Amazon Lightsail.

The stop relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.

May throw ServiceException. May throw InvalidInputException. May throw NotFoundException. May throw OperationFailureException. May throw AccessDeniedException. May throw AccountSetupInProgressException. May throw UnauthenticatedException.

Parameter relationalDatabaseName : The name of your database to stop.

Parameter relationalDatabaseSnapshotName : The name of your new database snapshot to be created before stopping your database.

Implementation

Future<StopRelationalDatabaseResult> stopRelationalDatabase({
  required String relationalDatabaseName,
  String? relationalDatabaseSnapshotName,
}) async {
  ArgumentError.checkNotNull(
      relationalDatabaseName, 'relationalDatabaseName');
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'Lightsail_20161128.StopRelationalDatabase'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'relationalDatabaseName': relationalDatabaseName,
      if (relationalDatabaseSnapshotName != null)
        'relationalDatabaseSnapshotName': relationalDatabaseSnapshotName,
    },
  );

  return StopRelationalDatabaseResult.fromJson(jsonResponse.body);
}