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	Resource Type definition for AWS::ElastiCache::ParameterGroup
Id	aws.elasticache.parameter_groups

Fields

Name	Datatype	Description
description	string	The description for this cache parameter group.
properties	object	A comma-delimited list of parameter name/value pairs. For more information see ModifyCacheParameterGroup in the Amazon ElastiCache API Reference Guide.
tags	array	Tags are composed of a Key/Value pair. You can use tags to categorize and track each parameter group. The tag value null is permitted.
cache_parameter_group_name	string	The name of the Cache Parameter Group.
cache_parameter_group_family	string	The name of the cache parameter group family that this cache parameter group is compatible with.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Description, CacheParameterGroupFamily, 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,
description,
properties,
tags,
cache_parameter_group_name,
cache_parameter_group_family
FROM aws.elasticache.parameter_groups
WHERE region = 'us-east-1';

Gets all properties from an individual parameter_group.

SELECT
region,
description,
properties,
tags,
cache_parameter_group_name,
cache_parameter_group_family
FROM aws.elasticache.parameter_groups
WHERE region = 'us-east-1' AND data__Identifier = '<CacheParameterGroupName>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.elasticache.parameter_groups (
 Description,
 CacheParameterGroupFamily,
 region
)
SELECT 
'{{ Description }}',
 '{{ CacheParameterGroupFamily }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.elasticache.parameter_groups (
 Description,
 Properties,
 Tags,
 CacheParameterGroupFamily,
 region
)
SELECT 
 '{{ Description }}',
 '{{ Properties }}',
 '{{ Tags }}',
 '{{ CacheParameterGroupFamily }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: parameter_group
    props:
      - name: Description
        value: '{{ Description }}'
      - name: Properties
        value: {}
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: CacheParameterGroupFamily
        value: '{{ CacheParameterGroupFamily }}'

DELETE example

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

Permissions

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

Create

ElastiCache:CreateCacheParameterGroup,
ElastiCache:DescribeCacheParameterGroups,
ElastiCache:AddTagsToResource,
ElastiCache:ModifyCacheParameterGroup

Read

ElastiCache:DescribeCacheParameterGroups,
ElastiCache:DescribeCacheParameters,
ElastiCache:ListTagsForResource

Update

ElastiCache:ModifyCacheParameterGroup,
ElastiCache:DescribeCacheParameterGroups,
ElastiCache:DescribeCacheParameters,
ElastiCache:DescribeEngineDefaultParameters,
ElastiCache:AddTagsToResource,
ElastiCache:RemoveTagsFromResource

Delete

ElastiCache:DescribeCacheParameterGroups,
ElastiCache:DeleteCacheParameterGroup

List

ElastiCache:DescribeCacheParameterGroups