rebootDBInstance method

Future<RebootDBInstanceResult> rebootDBInstance({ required String dBInstanceIdentifier, bool? forceFailover, })

You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect.

Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.

May throw InvalidDBInstanceStateFault. May throw DBInstanceNotFoundFault.

Parameter dBInstanceIdentifier : The DB instance identifier. This parameter is stored as a lowercase string.

Constraints:

• Must match the identifier of an existing DBInstance.

Parameter forceFailover : When true, the reboot is conducted through a MultiAZ failover.

Constraint: You can't specify true if the instance is not configured for MultiAZ.

Implementation

Future<RebootDBInstanceResult> rebootDBInstance({
  required String dBInstanceIdentifier,
  bool? forceFailover,
}) async {
  ArgumentError.checkNotNull(dBInstanceIdentifier, 'dBInstanceIdentifier');
  final $request = <String, dynamic>{};
  $request['DBInstanceIdentifier'] = dBInstanceIdentifier;
  forceFailover?.also((arg) => $request['ForceFailover'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'RebootDBInstance',
    version: '2014-10-31',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['RebootDBInstanceMessage'],
    shapes: shapes,
    resultWrapper: 'RebootDBInstanceResult',
  );
  return RebootDBInstanceResult.fromXml($result);
}