ElastiCache / Client / reset_cache_parameter_group

reset_cache_parameter_group

ElastiCache.Client.reset_cache_parameter_group(**kwargs)

Modifies the parameters of a cache parameter group to the engine or system default value. You can reset specific parameters by submitting a list of parameter names. To reset the entire cache parameter group, specify the ResetAllParameters and CacheParameterGroupName parameters.

See also: AWS API Documentation

Request Syntax

response = client.reset_cache_parameter_group(
    CacheParameterGroupName='string',
    ResetAllParameters=True|False,
    ParameterNameValues=[
        {
            'ParameterName': 'string',
            'ParameterValue': 'string'
        },
    ]
)

Parameters:

• CacheParameterGroupName (string) –

  [REQUIRED]

  The name of the cache parameter group to reset.

• ResetAllParameters (boolean) –

  If true, all parameters in the cache parameter group are reset to their default values. If false, only the parameters listed by ParameterNameValues are reset to their default values.

  Valid values: true | false

• ParameterNameValues (list) –

  An array of parameter names to reset to their default values. If ResetAllParameters is true, do not use ParameterNameValues. If ResetAllParameters is false, you must specify the name of at least one parameter to reset.

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

• ElastiCache.Client.exceptions.CacheParameterGroupNotFoundFault

• ElastiCache.Client.exceptions.InvalidParameterValueException

• ElastiCache.Client.exceptions.InvalidParameterCombinationException

• ElastiCache.Client.exceptions.InvalidGlobalReplicationGroupStateFault

Examples

Modifies the parameters of a cache parameter group to the engine or system default value.

response = client.reset_cache_parameter_group(
    CacheParameterGroupName='custom-mem1-4',
    ResetAllParameters=True,
)

print(response)

Expected Output:

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