ElastiCache / Client / modify_cache_parameter_group

modify_cache_parameter_group

ElastiCache.Client.modify_cache_parameter_group(**kwargs)

Modifies the parameters of a cache parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs.

See also: AWS API Documentation

Request Syntax

response = client.modify_cache_parameter_group(
    CacheParameterGroupName='string',
    ParameterNameValues=[
        {
            'ParameterName': 'string',
            'ParameterValue': 'string'
        },
    ]
)

Parameters:

• CacheParameterGroupName (string) –

  [REQUIRED]

  The name of the cache parameter group to modify.

• ParameterNameValues (list) –

  [REQUIRED]

  An array of parameter names and values for the parameter update. You must supply at least one parameter name and value; subsequent arguments are optional. A maximum of 20 parameters may be modified per request.

  • (dict) –

    Describes a name-value pair that is used to update the value of a parameter.

    • ParameterName (string) –

      The name of the parameter.

    • ParameterValue (string) –

      The value of the parameter.

Return type:

dict

Returns:

Response Syntax

{
    'CacheParameterGroupName': 'string'
}

Response Structure

• (dict) –

  Represents the output of one of the following operations:

  • ModifyCacheParameterGroup

  • ResetCacheParameterGroup

  • CacheParameterGroupName (string) –

    The name of the cache parameter group.

Exceptions

• ElastiCache.Client.exceptions.CacheParameterGroupNotFoundFault

• ElastiCache.Client.exceptions.InvalidCacheParameterGroupStateFault

• ElastiCache.Client.exceptions.InvalidParameterValueException

• ElastiCache.Client.exceptions.InvalidParameterCombinationException

• ElastiCache.Client.exceptions.InvalidGlobalReplicationGroupStateFault

Examples

Modifies one or more parameter values in the specified parameter group. You cannot modify any default parameter group.

response = client.modify_cache_parameter_group(
    CacheParameterGroupName='custom-mem1-4',
    ParameterNameValues=[
        {
            'ParameterName': 'binding_protocol',
            'ParameterValue': 'ascii',
        },
        {
            'ParameterName': 'chunk_size',
            'ParameterValue': '96',
        },
    ],
)

print(response)

Expected Output:

{
    'CacheParameterGroupName': 'custom-mem1-4',
    'ResponseMetadata': {
        '...': '...',
    },
}