v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14238527879.4 KB

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 <i>ResetAllParameters</i> parameter. For parameter changes to take effect you must reboot any associated clusters.

get/#Action=ResetClusterParameterGroup

Query parameters

ParameterGroupNamestring required

The name of the cluster parameter group to be reset.

ResetAllParametersboolean
<p>If <code>true</code>, all parameters in the specified parameter group will be reset to their default values. </p> <p>Default: <code>true</code> </p>
ParameterNamestring

The name of the parameter.

ParameterValuestring

The value of the parameter. If <code>ParameterName</code> is <code>wlm_json_configuration</code>, then the maximum size of <code>ParameterValue</code> is 8000 characters.

Descriptionstring

A description of the parameter.

Sourcestring

The source of the parameter value, such as "engine-default" or "user".

DataTypestring

The data type of the parameter.

AllowedValuesstring

The valid range of values for the parameter.

ApplyType'static' | 'dynamic'

Specifies how to apply the WLM configuration parameter. Some properties can be applied dynamically, while other properties require that any associated clusters be rebooted for the configuration changes to be applied. For more information about parameters and parameter groups, go to <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html">Amazon Redshift Parameter Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>.

IsModifiableboolean

If <code>true</code>, the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

MinimumEngineVersionstring

The earliest engine version to which the parameter can apply.

<p>An array of names of parameters to be reset. If <i>ResetAllParameters</i> option is not used, then at least one parameter name must be supplied. </p> <p>Constraints: A maximum of 20 parameters can be reset in a single request.</p>
Action'ResetClusterParameterGroup' required
Version'2012-12-01' required

Response

Success