resetClusterParameterGroup method

Future<ClusterParameterGroupNameMessage> resetClusterParameterGroup({
  1. required String parameterGroupName,
  2. List<Parameter>? parameters,
  3. bool? resetAllParameters,
})

Sets one or more parameters of the specified parameter group to their default values and sets the source values of the parameters to "engine-default". To reset the entire parameter group specify the ResetAllParameters parameter. For parameter changes to take effect you must reboot any associated clusters.

May throw InvalidClusterParameterGroupStateFault. May throw ClusterParameterGroupNotFoundFault.

Parameter parameterGroupName : The name of the cluster parameter group to be reset.

Parameter parameters : An array of names of parameters to be reset. If ResetAllParameters option is not used, then at least one parameter name must be supplied.

Constraints: A maximum of 20 parameters can be reset in a single request.

Parameter resetAllParameters : If true, all parameters in the specified parameter group will be reset to their default values.

Default: true

Implementation

Future<ClusterParameterGroupNameMessage> resetClusterParameterGroup({
  required String parameterGroupName,
  List<Parameter>? parameters,
  bool? resetAllParameters,
}) async {
  ArgumentError.checkNotNull(parameterGroupName, 'parameterGroupName');
  _s.validateStringLength(
    'parameterGroupName',
    parameterGroupName,
    0,
    2147483647,
    isRequired: true,
  );
  final $request = <String, dynamic>{};
  $request['ParameterGroupName'] = parameterGroupName;
  parameters?.also((arg) => $request['Parameters'] = arg);
  resetAllParameters?.also((arg) => $request['ResetAllParameters'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'ResetClusterParameterGroup',
    version: '2012-12-01',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['ResetClusterParameterGroupMessage'],
    shapes: shapes,
    resultWrapper: 'ResetClusterParameterGroupResult',
  );
  return ClusterParameterGroupNameMessage.fromXml($result);
}