Skip to main content

parameter_groups

Creates, updates, deletes or gets a parameter_group resource or lists parameter_groups in a region

Overview

Nameparameter_groups
TypeResource
DescriptionThe AWS::MemoryDB::ParameterGroup resource creates an Amazon MemoryDB ParameterGroup.
Idaws.memorydb.parameter_groups

Fields

NameDatatypeDescription
parameter_group_namestringThe name of the parameter group.
familystringThe name of the parameter group family that this parameter group is compatible with.
descriptionstringA description of the parameter group.
tagsarrayAn array of key-value pairs to apply to this parameter group.
parametersobjectAn map of parameter names and values for the parameter update. You must supply at least one parameter name and value; subsequent arguments are optional.
arnstringThe Amazon Resource Name (ARN) of the parameter group.
regionstringAWS region.

Methods

NameAccessible byRequired Params
create_resourceINSERTParameterGroupName, Family, region
delete_resourceDELETEdata__Identifier, region
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
list_resourcesSELECTregion
get_resourceSELECTdata__Identifier, region

SELECT examples

Gets all parameter_groups in a region.

SELECT
region,
parameter_group_name,
family,
description,
tags,
parameters,
arn
FROM aws.memorydb.parameter_groups
WHERE region = 'us-east-1';

Gets all properties from an individual parameter_group.

SELECT
region,
parameter_group_name,
family,
description,
tags,
parameters,
arn
FROM aws.memorydb.parameter_groups
WHERE region = 'us-east-1' AND data__Identifier = '<ParameterGroupName>';

INSERT example

Use the following StackQL query and manifest file to create a new parameter_group resource, using stack-deploy.

/*+ create */
INSERT INTO aws.memorydb.parameter_groups (
ParameterGroupName,
Family,
region
)
SELECT
'{{ ParameterGroupName }}',
'{{ Family }}',
'{{ region }}';

DELETE example

/*+ delete */
DELETE FROM aws.memorydb.parameter_groups
WHERE data__Identifier = '<ParameterGroupName>'
AND region = 'us-east-1';

Permissions

To operate on the parameter_groups resource, the following permissions are required:

Create

memorydb:CreateParameterGroup,
memorydb:DescribeParameterGroups,
memorydb:TagResource,
memorydb:ListTags

Read

memorydb:DescribeParameterGroups,
memorydb:ListTags

Update

memorydb:UpdateParameterGroup,
memorydb:DescribeParameterGroups,
memorydb:DescribeParameters,
memorydb:DescribeClusters,
memorydb:ListTags,
memorydb:TagResource,
memorydb:UntagResource

Delete

memorydb:DeleteParameterGroup

List

memorydb:DescribeParameterGroups