cluster_parameter_groups

Creates, updates, deletes or gets a cluster_parameter_group resource or lists cluster_parameter_groups in a region

Overview

Name	cluster_parameter_groups
Type	Resource
Description	Resource Type definition for AWS::Redshift::ClusterParameterGroup
Id	aws.redshift.cluster_parameter_groups

Fields

Name	Datatype	Description
parameter_group_name	string	The name of the cluster parameter group.
description	string	A description of the parameter group.
parameter_group_family	string	The Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters.
parameters	array	An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.
tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Description, ParameterGroupFamily, 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 cluster_parameter_groups in a region.

SELECT
region,
parameter_group_name,
description,
parameter_group_family,
parameters,
tags
FROM aws.redshift.cluster_parameter_groups
WHERE region = 'us-east-1';

Gets all properties from an individual cluster_parameter_group.

SELECT
region,
parameter_group_name,
description,
parameter_group_family,
parameters,
tags
FROM aws.redshift.cluster_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 cluster_parameter_group resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.redshift.cluster_parameter_groups (
 Description,
 ParameterGroupFamily,
 region
)
SELECT 
'{{ Description }}',
 '{{ ParameterGroupFamily }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.redshift.cluster_parameter_groups (
 ParameterGroupName,
 Description,
 ParameterGroupFamily,
 Parameters,
 Tags,
 region
)
SELECT 
 '{{ ParameterGroupName }}',
 '{{ Description }}',
 '{{ ParameterGroupFamily }}',
 '{{ Parameters }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: cluster_parameter_group
    props:
      - name: ParameterGroupName
        value: '{{ ParameterGroupName }}'
      - name: Description
        value: '{{ Description }}'
      - name: ParameterGroupFamily
        value: '{{ ParameterGroupFamily }}'
      - name: Parameters
        value:
          - ParameterName: '{{ ParameterName }}'
            ParameterValue: '{{ ParameterValue }}'
      - name: Tags
        value:
          - Value: '{{ Value }}'
            Key: '{{ Key }}'

DELETE example

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

Permissions

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

Create

redshift:CreateClusterParameterGroup,
redshift:ModifyClusterParameterGroup,
redshift:DescribeClusterParameterGroups,
redshift:DescribeClusterParameters,
redshift:DescribeTags,
redshift:CreateTags,
ec2:AllocateAddress,
ec2:AssociateAddress,
ec2:AttachNetworkInterface,
ec2:DescribeAccountAttributes,
ec2:DescribeAddresses,
ec2:DescribeAvailabilityZones,
ec2:DescribeInternetGateways,
ec2:DescribeSecurityGroups,
ec2:DescribeSubnets,
ec2:DescribeVpcs

Read

redshift:DescribeClusterParameterGroups,
initech:DescribeReport,
redshift:DescribeClusterParameters,
redshift:DescribeTags

Update

redshift:DescribeClusterParameterGroups,
redshift:ResetClusterParameterGroup,
redshift:ModifyClusterParameterGroup,
redshift:DescribeClusterParameters,
redshift:DescribeTags,
redshift:CreateTags,
redshift:DeleteTags,
initech:UpdateReport

Delete

redshift:DescribeTags,
redshift:DescribeClusterParameterGroups,
redshift:DeleteClusterParameterGroup,
redshift:DescribeClusterParameters,
initech:DeleteReport

List

redshift:DescribeTags,
redshift:DescribeClusterParameterGroups,
redshift:DescribeClusterParameters,
initech:ListReports