Skip to content

modify_cache_parameter_group

modify_cache_parameter_group(
    *,
    config_overrides: Optional[ElastiCacheClientConfig] = None,
    cache_parameter_group_name: Optional[String] = None,
    parameter_name_values: Optional[ParameterNameValueList] = None,
) -> CacheParameterGroupNameMessage

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.

Parameters:

  • cache_parameter_group_name (Optional[String], default: None ) –

    The name of the cache parameter group to modify.

  • parameter_name_values (Optional[ParameterNameValueList], default: None ) –

    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.

Raises:

Examples:

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

>>> client.modify_cache_parameter_group(cache_parameter_group_name='custom-mem1-4', parameter_name_values=[{'ParameterName': 'binding_protocol', 'ParameterValue': 'ascii'}, {'ParameterName': 'chunk_size', 'ParameterValue': '96'}])
Source code in docs_src/capo_elasticache/_services/elasti_cache.py
def modify_cache_parameter_group(
    self,
    *,
    config_overrides: Optional[ElastiCacheClientConfig] = None,
    cache_parameter_group_name: Optional[
        "capo_elasticache.types.string.String"
    ] = None,
    parameter_name_values: Optional[
        "capo_elasticache.types.parameter_name_value_list.ParameterNameValueList"
    ] = None,
) -> "capo_elasticache.types.cache_parameter_group_name_message.CacheParameterGroupNameMessage":
    """<p>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.</p>

    Args:
        cache_parameter_group_name: <p>The name of the cache parameter group to modify.</p>
        parameter_name_values: <p>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.</p>

    Raises:
        capo_elasticache.errors.cache_parameter_group_not_found_fault.CacheParameterGroupNotFoundFault: <p>The requested cache parameter group name does not refer to an existing cache parameter group.</p>
        capo_elasticache.errors.invalid_cache_parameter_group_state_fault.InvalidCacheParameterGroupStateFault: <p>The current state of the cache parameter group does not allow the requested operation to occur.</p>
        capo_elasticache.errors.invalid_global_replication_group_state_fault.InvalidGlobalReplicationGroupStateFault: <p>The Global datastore is not available or in primary-only state.</p>
        capo_elasticache.errors.invalid_parameter_combination_exception.InvalidParameterCombinationException: <p>Two or more incompatible parameters were specified.</p>
        capo_elasticache.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>The value for a parameter is invalid.</p>
        capo_elasticache.errors.UnknownServiceError: The service returned an error code this client does not model.

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

        >>> client.modify_cache_parameter_group(cache_parameter_group_name='custom-mem1-4', parameter_name_values=[{'ParameterName': 'binding_protocol', 'ParameterValue': 'ascii'}, {'ParameterName': 'chunk_size', 'ParameterValue': '96'}])
    """

    def _handler(
        req: "OperationRequest[capo_elasticache.types.modify_cache_parameter_group_message.ModifyCacheParameterGroupMessage]",
    ) -> OperationResponse[
        "capo_elasticache.types.cache_parameter_group_name_message.CacheParameterGroupNameMessage"
    ]:
        import capo_elasticache._operations.amazon_elasti_cache_v9.modify_cache_parameter_group

        output, http_response = (
            capo_elasticache._operations.amazon_elasti_cache_v9.modify_cache_parameter_group.modify_cache_parameter_group(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ModifyCacheParameterGroup")
    )
    input_: capo_elasticache.types.modify_cache_parameter_group_message.ModifyCacheParameterGroupMessage = {}
    if cache_parameter_group_name is not None:
        input_["cache_parameter_group_name"] = cache_parameter_group_name
    if parameter_name_values is not None:
        input_["parameter_name_values"] = parameter_name_values

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output