ResetClusterParameterGroup - Amazon Redshift


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.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.


The name of the cluster parameter group to be reset.

Type: String

Required: Yes


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.

Type: Array of Parameter objects

Required: No


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

Default: true

Type: Boolean

Required: No

Response Elements

The following elements are returned by the service.


The name of the cluster parameter group.

Type: String


The status of the parameter group. For example, if you made a change to a parameter group name-value pair, then the change could be pending a reboot of an associated cluster.

Type: String


For information about the errors that are common to all actions, see Common Errors.


The parameter group name does not refer to an existing parameter group.

HTTP Status Code: 404


The cluster parameter group action can not be completed because another task is in progress that involves the parameter group. Wait a few moments and try the operation again.

HTTP Status Code: 400



This example illustrates one usage of ResetClusterParameterGroup.

Sample Request ?Action=ResetClusterParameterGroup &ParameterGroupName=myclusterparametergroup &ResetAllParameters=true &SignatureMethod=HmacSHA256&SignatureVersion=4 &Version=2012-12-01 &X-Amz-Algorithm=AWS4-HMAC-SHA256 &X-Amz-Credential=AKIAIOSFODNN7EXAMPLE/20190817/us-east-2/redshift/aws4_request &X-Amz-Date=20190825T160000Z &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date &X-Amz-Signature=0aa1234bb5cc678ddddd901ee2ff3aa45678b90c12d345e6ff789012345a6b7b

Sample Response

<ResetClusterParameterGroupResponse xmlns=""> <ResetClusterParameterGroupResult> <ParameterGroupName>myclusterparametergroup</ParameterGroupName> <ParameterGroupStatus>Your parameter group has been updated. If you changed only dynamic parameters, associated clusters are being modified now. If you changed static parameters, all updates, including dynamic parameters, will be applied when you reboot the associated clusters.</ParameterGroupStatus> </ResetClusterParameterGroupResult> <ResponseMetadata> <RequestId>9e0e57b9-28f5-11ea-9caa-c956bec1ce87</RequestId> </ResponseMetadata> </ResetClusterParameterGroupResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: