parameter_groups

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

Overview

Name	parameter_groups
Type	Resource
Id	aws.memorydb.parameter_groups

Fields

The following fields are returned by SELECT queries:

describe_parameter_groups

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the parameter group
description	string	A description of the parameter group
family	string	The name of the parameter group family that this parameter group is compatible with.
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 contains only the descriptions for that group.
create_parameter_group	insert	region, ParameterGroupName		Creates a new MemoryDB parameter group. A parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster. For more information, see Configuring engine parameters using parameter groups.
update_parameter_group	update	region, ParameterGroupName, ParameterNameValues		Updates 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 clusters. You cannot delete the default parameter groups in your account.

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 contains only the descriptions for that group.

SELECT
arn,
description,
family,
name
FROM aws.memorydb.parameter_groups
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_parameter_group

Creates a new MemoryDB parameter group. A parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster. For more information, see Configuring engine parameters using parameter groups.

INSERT INTO aws.memorydb.parameter_groups (
ParameterGroupName,
Family,
Description,
Tags,
region
)
SELECT 
'{{ ParameterGroupName }}' /* required */,
'{{ Family }}',
'{{ Description }}',
'{{ Tags }}',
'{{ 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.
  - name: Family
    value: "{{ Family }}"
    description: |
      The name of the parameter group family that the parameter group can be used with.
  - name: Description
    value: "{{ Description }}"
    description: |
      An optional description of the parameter group.
  - name: Tags
    description: |
      A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

update_parameter_group

Updates 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.memorydb.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 clusters. You cannot delete the default parameter groups in your account.

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