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	awscc.elasticache.parameter_groups

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
cache_parameter_group_name	string	The name of the Cache Parameter Group.
region	string	AWS region.

For more information, see AWS::ElastiCache::ParameterGroup.

Methods

Name	Resource	Accessible by	Required Params
create_resource	parameter_groups	INSERT	Description, CacheParameterGroupFamily, region
delete_resource	parameter_groups	DELETE	Identifier, region
update_resource	parameter_groups	UPDATE	Identifier, PatchDocument, region
list_resources	parameter_groups_list_only	SELECT	region
get_resource	parameter_groups	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual parameter_group.

SELECT
  region,
  description,
  properties,
  tags,
  cache_parameter_group_name,
  cache_parameter_group_family
FROM awscc.elasticache.parameter_groups
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ cache_parameter_group_name }}';

list (identifiers only)

Lists all parameter_groups in a region.

SELECT
  region,
  cache_parameter_group_name
FROM awscc.elasticache.parameter_groups_list_only
WHERE
  region = '{{ region }}';

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 awscc.elasticache.parameter_groups (
  Description,
  CacheParameterGroupFamily,
  region
)
SELECT
  '{{ description }}',
  '{{ cache_parameter_group_family }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.elasticache.parameter_groups (
  Description,
  Properties,
  Tags,
  CacheParameterGroupFamily,
  region
)
SELECT
  '{{ description }}',
  '{{ properties }}',
  '{{ tags }}',
  '{{ cache_parameter_group_family }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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: cache_parameter_group_family
      value: '{{ cache_parameter_group_family }}'

UPDATE example

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

/*+ update */
UPDATE awscc.elasticache.parameter_groups
SET PatchDocument = string('{{ {
    "Description": description,
    "Properties": properties,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ cache_parameter_group_name }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.elasticache.parameter_groups
WHERE
  Identifier = '{{ cache_parameter_group_name }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

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

Create

elasticache:CreateCacheParameterGroup,
elasticache:DescribeCacheParameterGroups,
elasticache:AddTagsToResource,
elasticache:ModifyCacheParameterGroup,
iam:CreateServiceLinkedRole,
iam:PutRolePolicy

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