resetDBParameterGroup method

Future<DBParameterGroupNameMessage> resetDBParameterGroup({
  1. required String dBParameterGroupName,
  2. List<Parameter>? parameters,
  3. bool? resetAllParameters,
})

Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod. To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request.

May throw InvalidDBParameterGroupStateFault. May throw DBParameterGroupNotFoundFault.

Parameter dBParameterGroupName : The name of the DB parameter group.

Constraints:

  • Must match the name of an existing DBParameterGroup.

Parameter parameters : To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

Valid Values (for Apply method): pending-reboot

Parameter resetAllParameters : Specifies whether (true) or not (false) to reset all parameters in the DB parameter group to default values.

Default: true

Implementation

Future<DBParameterGroupNameMessage> resetDBParameterGroup({
  required String dBParameterGroupName,
  List<Parameter>? parameters,
  bool? resetAllParameters,
}) async {
  ArgumentError.checkNotNull(dBParameterGroupName, 'dBParameterGroupName');
  final $request = <String, dynamic>{};
  $request['DBParameterGroupName'] = dBParameterGroupName;
  parameters?.also((arg) => $request['Parameters'] = arg);
  resetAllParameters?.also((arg) => $request['ResetAllParameters'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'ResetDBParameterGroup',
    version: '2014-10-31',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['ResetDBParameterGroupMessage'],
    shapes: shapes,
    resultWrapper: 'ResetDBParameterGroupResult',
  );
  return DBParameterGroupNameMessage.fromXml($result);
}