parameter_groups
Creates, updates, deletes or gets a parameter_group
resource or lists parameter_groups
in a region
Overview
Name | parameter_groups |
Type | Resource |
Description | The AWS::MemoryDB::ParameterGroup resource creates an Amazon MemoryDB ParameterGroup. |
Id | aws.memorydb.parameter_groups |
Fields
Name | Datatype | Description |
---|---|---|
parameter_group_name | string | The name of the parameter group. |
family | string | The name of the parameter group family that this parameter group is compatible with. |
description | string | A description of the parameter group. |
tags | array | An array of key-value pairs to apply to this parameter group. |
parameters | object | An map of parameter names and values for the parameter update. You must supply at least one parameter name and value; subsequent arguments are optional. |
arn | string | The Amazon Resource Name (ARN) of the parameter group. |
region | string | AWS region. |
Methods
Name | Accessible by | Required Params |
---|---|---|
create_resource | INSERT | ParameterGroupName, Family, region |
delete_resource | DELETE | data__Identifier, region |
update_resource | UPDATE | data__Identifier, data__PatchDocument, region |
list_resources | SELECT | region |
get_resource | SELECT | data__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
.
- Required Properties
- All Properties
- Manifest
/*+ create */
INSERT INTO aws.memorydb.parameter_groups (
ParameterGroupName,
Family,
region
)
SELECT
'{{ ParameterGroupName }}',
'{{ Family }}',
'{{ region }}';
/*+ create */
INSERT INTO aws.memorydb.parameter_groups (
ParameterGroupName,
Family,
Description,
Tags,
Parameters,
region
)
SELECT
'{{ ParameterGroupName }}',
'{{ Family }}',
'{{ Description }}',
'{{ Tags }}',
'{{ Parameters }}',
'{{ region }}';
version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
value: '{{ vars.AWS_REGION }}'
resources:
- name: parameter_group
props:
- name: ParameterGroupName
value: '{{ ParameterGroupName }}'
- name: Family
value: '{{ Family }}'
- name: Description
value: '{{ Description }}'
- name: Tags
value:
- Key: '{{ Key }}'
Value: '{{ Value }}'
- name: Parameters
value: {}
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