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	awscc.redshift.cluster_parameter_groups

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
parameter_group_name	string	The name of the cluster parameter group.
region	string	AWS region.

For more information, see AWS::Redshift::ClusterParameterGroup.

Methods

Name	Resource	Accessible by	Required Params
create_resource	cluster_parameter_groups	INSERT	Description, ParameterGroupFamily, region
delete_resource	cluster_parameter_groups	DELETE	Identifier, region
update_resource	cluster_parameter_groups	UPDATE	Identifier, PatchDocument, region
list_resources	cluster_parameter_groups_list_only	SELECT	region
get_resource	cluster_parameter_groups	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual cluster_parameter_group.

SELECT
  region,
  parameter_group_name,
  description,
  parameter_group_family,
  parameters,
  tags
FROM awscc.redshift.cluster_parameter_groups
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ parameter_group_name }}';

list (identifiers only)

Lists all cluster_parameter_groups in a region.

SELECT
  region,
  parameter_group_name
FROM awscc.redshift.cluster_parameter_groups_list_only
WHERE
  region = 'us-east-1';

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 awscc.redshift.cluster_parameter_groups (
  Description,
  ParameterGroupFamily,
  region
)
SELECT
  '{{ description }}',
  '{{ parameter_group_family }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.redshift.cluster_parameter_groups (
  ParameterGroupName,
  Description,
  ParameterGroupFamily,
  Parameters,
  Tags,
  region
)
SELECT
  '{{ parameter_group_name }}',
  '{{ description }}',
  '{{ parameter_group_family }}',
  '{{ 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: parameter_group_name
        value: '{{ parameter_group_name }}'
      - name: description
        value: '{{ description }}'
      - name: parameter_group_family
        value: '{{ parameter_group_family }}'
      - name: parameters
        value:
          - parameter_name: '{{ parameter_name }}'
            parameter_value: '{{ parameter_value }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.redshift.cluster_parameter_groups
SET PatchDocument = string('{{ {
    "Parameters": parameters,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ parameter_group_name }}';

DELETE example

/*+ delete */
DELETE FROM awscc.redshift.cluster_parameter_groups
WHERE
  Identifier = '{{ parameter_group_name }}' 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:DeleteTags,
redshift:DescribeClusterParameterGroups,
redshift:DeleteClusterParameterGroup,
redshift:DescribeClusterParameters,
initech:DeleteReport

List

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