ModifyClusterParameterGroup - Amazon Redshift

ModifyClusterParameterGroup

Modifies the parameters of a parameter group. For the parameters parameter, it can't contain ASCII characters.

For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

Request Parameters

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

ParameterGroupName

The name of the parameter group to be modified.

Type: String

Length Constraints: Maximum length of 2147483647.

Required: Yes

Parameters.Parameter.N

An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.

For each parameter to be modified, you must supply at least the parameter name and parameter value; other name-value pairs of the parameter are optional.

For the workload management (WLM) configuration, you must supply all the name-value pairs in the wlm_json_configuration parameter.

Type: Array of Parameter objects

Required: Yes

Response Elements

The following elements are returned by the service.

ParameterGroupName

The name of the cluster parameter group.

Type: String

Length Constraints: Maximum length of 2147483647.

ParameterGroupStatus

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

Length Constraints: Maximum length of 2147483647.

Errors

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

ClusterParameterGroupNotFound

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

HTTP Status Code: 404

InvalidClusterParameterGroupState

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

Examples

Example

This example illustrates one usage of ModifyClusterParameterGroup.

Sample Request

https://redshift.us-east-2.amazonaws.com/ ?Action=ModifyClusterParameterGroup &ParameterGroupName=myclusterparametergroup &Parameters.Parameter.1.ParameterName=auto_analyze &Parameters.Parameter.1.ParameterValue=false &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

<ModifyClusterParameterGroupResponse xmlns="http://redshift.amazonaws.com/doc/2012-12-01/"> <ModifyClusterParameterGroupResult> <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> </ModifyClusterParameterGroupResult> <ResponseMetadata> <RequestId>565b33e6-28e9-11ea-9939-5fccefa818c0</RequestId> </ResponseMetadata> </ModifyClusterParameterGroupResponse>

See Also

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