parameter_groups

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

Overview

Name	parameter_groups
Type	Resource
Id	aws.dax.parameter_groups

Fields

The following fields are returned by SELECT queries:

describe_parameter_groups

Name	Datatype	Description
description	string	A description of the parameter group.
parameter_group_name	string	The name of the parameter group.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_parameter_groups	select	region		Returns a list of parameter group descriptions. If a parameter group name is specified, the list will contain only the descriptions for that group.
create_parameter_group	insert	region, ParameterGroupName		Creates a new parameter group. A parameter group is a collection of parameters that you apply to all of the nodes in a DAX cluster.
update_parameter_group	update	region, ParameterGroupName, ParameterNameValues		Modifies the parameters of a parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs.
delete_parameter_group	delete	region		Deletes the specified parameter group. You cannot delete a parameter group if it is associated with any DAX clusters.

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_parameter_groups

Returns a list of parameter group descriptions. If a parameter group name is specified, the list will contain only the descriptions for that group.

SELECT
description,
parameter_group_name
FROM aws.dax.parameter_groups
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_parameter_group

Creates a new parameter group. A parameter group is a collection of parameters that you apply to all of the nodes in a DAX cluster.

INSERT INTO aws.dax.parameter_groups (
ParameterGroupName,
Description,
region
)
SELECT 
'{{ ParameterGroupName }}' /* required */,
'{{ Description }}',
'{{ region }}'
RETURNING
parameter_group
;

Manifest

# Description fields are for documentation purposes
- name: parameter_groups
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the parameter_groups resource.
  - name: ParameterGroupName
    value: "{{ ParameterGroupName }}"
    description: |
      The name of the parameter group to apply to all of the clusters in this replication group.
  - name: Description
    value: "{{ Description }}"
    description: |
      A description of the parameter group.

UPDATE examples

update_parameter_group

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

UPDATE aws.dax.parameter_groups
SET 
ParameterGroupName = '{{ ParameterGroupName }}',
ParameterNameValues = '{{ ParameterNameValues }}'
WHERE 
region = '{{ region }}' --required
AND ParameterGroupName = '{{ ParameterGroupName }}' --required
AND ParameterNameValues = '{{ ParameterNameValues }}' --required
RETURNING
parameter_group;

DELETE examples

delete_parameter_group

Deletes the specified parameter group. You cannot delete a parameter group if it is associated with any DAX clusters.

DELETE FROM aws.dax.parameter_groups
WHERE region = '{{ region }}' --required
;