cache_parameters

Creates, updates, deletes, gets or lists a cache_parameters resource.

Overview

Name	cache_parameters
Type	Resource
Id	aws.elasticache.cache_parameters

Fields

The following fields are returned by SELECT queries:

describe_cache_parameters

Name	Datatype	Description
allowed_values	string	The valid range of values for the parameter.
change_type	string	Indicates whether a change to the parameter is applied immediately or requires a reboot for the change to be applied. You can force a reboot or wait until the next maintenance window's reboot. For more information, see Rebooting a Cluster.
data_type	string	The valid data type for the parameter.
description	string	A description of the parameter.
is_modifiable	boolean	Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
minimum_engine_version	string	The earliest cache engine version to which the parameter can apply.
parameter_name	string	The name of the parameter.
parameter_value	string	The value of the parameter.
source	string	The source of the parameter.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_cache_parameters	select	CacheParameterGroupName, region	Source, MaxRecords, Marker	Returns the detailed parameter list for a particular cache parameter group.
reset_cache_parameter_group	exec	CacheParameterGroupName, region	ResetAllParameters, ParameterNameValues	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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
CacheParameterGroupName	string	The name of the cache parameter group to reset.
region	string	AWS region (default: us-east-1)
Marker	string	An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
MaxRecords	integer	The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: minimum 20; maximum 100.
ParameterNameValues	array	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.
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
Source	string	The parameter types to return. Valid values: user | system | engine-default

SELECT examples

describe_cache_parameters

Returns the detailed parameter list for a particular cache parameter group.

SELECT
allowed_values,
change_type,
data_type,
description,
is_modifiable,
minimum_engine_version,
parameter_name,
parameter_value,
source
FROM aws.elasticache.cache_parameters
WHERE CacheParameterGroupName = '{{ CacheParameterGroupName }}' -- required
AND region = '{{ region }}' -- required
AND Source = '{{ Source }}'
AND MaxRecords = '{{ MaxRecords }}'
AND Marker = '{{ Marker }}'
;

Lifecycle Methods

reset_cache_parameter_group

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.

EXEC aws.elasticache.cache_parameters.reset_cache_parameter_group 
@CacheParameterGroupName='{{ CacheParameterGroupName }}' --required, 
@region='{{ region }}' --required, 
@ResetAllParameters={{ ResetAllParameters }}, 
@ParameterNameValues='{{ ParameterNameValues }}'
;