Redshift / Client / modify_cluster_parameter_group

modify_cluster_parameter_group#

Redshift.Client.modify_cluster_parameter_group(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.modify_cluster_parameter_group(
    ParameterGroupName='string',
    Parameters=[
        {
            'ParameterName': 'string',
            'ParameterValue': 'string',
            'Description': 'string',
            'Source': 'string',
            'DataType': 'string',
            'AllowedValues': 'string',
            'ApplyType': 'static'|'dynamic',
            'IsModifiable': True|False,
            'MinimumEngineVersion': 'string'
        },
    ]
)
Parameters:

  • ParameterGroupName (string) –

    [REQUIRED]

    The name of the parameter group to be modified.

  • Parameters (list) –

    [REQUIRED]

    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.

    • (dict) –

      Describes a parameter in a cluster parameter group.

      • ParameterName (string) –

        The name of the parameter.

      • ParameterValue (string) –

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

      • Description (string) –

        A description of the parameter.

      • Source (string) –

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

      • DataType (string) –

        The data type of the parameter.

      • AllowedValues (string) –

        The valid range of values for the parameter.

      • ApplyType (string) –

        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 Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

      • IsModifiable (boolean) –

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

      • MinimumEngineVersion (string) –

        The earliest engine version to which the parameter can apply.

Return type:

dict

Returns:

Response Syntax

{
    'ParameterGroupName': 'string',
    'ParameterGroupStatus': 'string'
}

Response Structure

  • (dict) –

    • ParameterGroupName (string) –

      The name of the cluster parameter group.

    • ParameterGroupStatus (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.

Exceptions