parameters

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

Overview

Name	parameters
Type	Resource
Id	aws.memorydb.parameters

Fields

The following fields are returned by SELECT queries:

describe_parameters

Name	Datatype	Description
allowed_values	string	The valid range of values for the parameter.
data_type	string	The parameter's data type
description	string	A description of the parameter
minimum_engine_version	string	The earliest engine version to which the parameter can apply.
name	string	The name of the parameter
value	string	The value of the parameter

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_parameters	select	region		Returns the detailed parameter list for a particular parameter group.
reset_parameter_group	exec	region, ParameterGroupName		Modifies the parameters of a 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 parameter group, specify the AllParameters and ParameterGroupName 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
region	string	AWS region (default: us-east-1)

SELECT examples

describe_parameters

Returns the detailed parameter list for a particular parameter group.

SELECT
allowed_values,
data_type,
description,
minimum_engine_version,
name,
value
FROM aws.memorydb.parameters
WHERE region = '{{ region }}' -- required
;

Lifecycle Methods

reset_parameter_group

Modifies the parameters of a 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 parameter group, specify the AllParameters and ParameterGroupName parameters.

EXEC aws.memorydb.parameters.reset_parameter_group 
@region='{{ region }}' --required 
@@json=
'{
"ParameterGroupName": "{{ ParameterGroupName }}", 
"AllParameters": {{ AllParameters }}, 
"ParameterNames": "{{ ParameterNames }}"
}'
;