cluster_subnet_groups

Creates, updates, deletes or gets a cluster_subnet_group resource or lists cluster_subnet_groups in a region

Overview

Name	cluster_subnet_groups
Type	Resource
Description	Specifies an Amazon Redshift subnet group.
Id	aws.redshift.cluster_subnet_groups

Fields

Name	Datatype	Description
description	string	The description of the parameter group.
subnet_ids	array	The list of VPC subnet IDs
tags	array	The list of tags for the cluster parameter group.
cluster_subnet_group_name	string	This name must be unique for all subnet groups that are created by your AWS account. If costumer do not provide it, cloudformation will generate it. Must not be "Default".
region	string	AWS region.

Methods

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

SELECT
region,
description,
subnet_ids,
tags,
cluster_subnet_group_name
FROM aws.redshift.cluster_subnet_groups
WHERE region = 'us-east-1';

Gets all properties from an individual cluster_subnet_group.

SELECT
region,
description,
subnet_ids,
tags,
cluster_subnet_group_name
FROM aws.redshift.cluster_subnet_groups
WHERE region = 'us-east-1' AND data__Identifier = '<ClusterSubnetGroupName>';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO aws.redshift.cluster_subnet_groups (
 Description,
 SubnetIds,
 Tags,
 region
)
SELECT 
 '{{ Description }}',
 '{{ SubnetIds }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: cluster_subnet_group
    props:
      - name: Description
        value: '{{ Description }}'
      - name: SubnetIds
        value:
          - '{{ SubnetIds[0] }}'
      - name: Tags
        value:
          - Value: '{{ Value }}'
            Key: '{{ Key }}'

DELETE example

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

Permissions

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

Create

redshift:CreateClusterSubnetGroup,
redshift:CreateTags,
redshift:DescribeClusterSubnetGroups,
redshift:DescribeTags,
ec2:AllocateAddress,
ec2:AssociateAddress,
ec2:AttachNetworkInterface,
ec2:DescribeAccountAttributes,
ec2:DescribeAddresses,
ec2:DescribeAvailabilityZones,
ec2:DescribeInternetGateways,
ec2:DescribeSecurityGroups,
ec2:DescribeSubnets,
ec2:DescribeVpcs

Read

redshift:DescribeClusterSubnetGroups,
redshift:DescribeTags,
ec2:AllocateAddress,
ec2:AssociateAddress,
ec2:AttachNetworkInterface,
ec2:DescribeAccountAttributes,
ec2:DescribeAddresses,
ec2:DescribeAvailabilityZones,
ec2:DescribeInternetGateways,
ec2:DescribeSecurityGroups,
ec2:DescribeSubnets,
ec2:DescribeVpcs

Update

redshift:ModifyClusterSubnetGroup,
redshift:DescribeClusterSubnetGroups,
redshift:DescribeTags,
redshift:CreateTags,
redshift:DeleteTags,
ec2:AllocateAddress,
ec2:AssociateAddress,
ec2:AttachNetworkInterface,
ec2:DescribeAccountAttributes,
ec2:DescribeAddresses,
ec2:DescribeAvailabilityZones,
ec2:DescribeInternetGateways,
ec2:DescribeSecurityGroups,
ec2:DescribeSubnets,
ec2:DescribeVpcs

Delete

redshift:DeleteClusterSubnetGroup,
redshift:DescribeClusterSubnetGroups,
redshift:DescribeTags,
ec2:AllocateAddress,
ec2:AssociateAddress,
ec2:AttachNetworkInterface,
ec2:DescribeAccountAttributes,
ec2:DescribeAddresses,
ec2:DescribeAvailabilityZones,
ec2:DescribeInternetGateways,
ec2:DescribeSecurityGroups,
ec2:DescribeSubnets,
ec2:DescribeVpcs

List

redshift:DescribeClusterSubnetGroups,
redshift:DescribeTags,
ec2:AllocateAddress,
ec2:AssociateAddress,
ec2:AttachNetworkInterface,
ec2:DescribeAccountAttributes,
ec2:DescribeAddresses,
ec2:DescribeAvailabilityZones,
ec2:DescribeInternetGateways,
ec2:DescribeSecurityGroups,
ec2:DescribeSubnets,
ec2:DescribeVpcs