ModifyClusterParameterGroupCommand

Suggest an Edit

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { RedshiftClient, ModifyClusterParameterGroupCommand } from "@aws-sdk/client-redshift"; // ES Modules import
// const { RedshiftClient, ModifyClusterParameterGroupCommand } = require("@aws-sdk/client-redshift"); // CommonJS import
const client = new RedshiftClient(config);
const input = { // ModifyClusterParameterGroupMessage
  ParameterGroupName: "STRING_VALUE", // required
  Parameters: [ // ParametersList // required
    { // Parameter
      ParameterName: "STRING_VALUE",
      ParameterValue: "STRING_VALUE",
      Description: "STRING_VALUE",
      Source: "STRING_VALUE",
      DataType: "STRING_VALUE",
      AllowedValues: "STRING_VALUE",
      ApplyType: "static" || "dynamic",
      IsModifiable: true || false,
      MinimumEngineVersion: "STRING_VALUE",
    },
  ],
};
const command = new ModifyClusterParameterGroupCommand(input);
const response = await client.send(command);
// { // ClusterParameterGroupNameMessage
//   ParameterGroupName: "STRING_VALUE",
//   ParameterGroupStatus: "STRING_VALUE",
// };

ModifyClusterParameterGroupCommand Input

See ModifyClusterParameterGroupCommandInput for more details

Parameter
Type
Description
ParameterGroupName
Required
string | undefined

The name of the parameter group to be modified.

Parameters
Required
Parameter[] | undefined

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.

ModifyClusterParameterGroupCommand Output

See ModifyClusterParameterGroupCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
ParameterGroupName
string | undefined

The name of the cluster parameter group.

ParameterGroupStatus
string | undefined

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.

Throws

Name
Fault
Details
ClusterParameterGroupNotFoundFault
client

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

InvalidClusterParameterGroupStateFault
client

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.

RedshiftServiceException
Base exception class for all service exceptions from Redshift service.