subnet_groups

Creates, updates, deletes or gets a subnet_group resource or lists subnet_groups in a region

Overview

Name	subnet_groups
Type	Resource
Description	Resource Type definition for AWS::ElastiCache::SubnetGroup
Id	awscc.elasticache.subnet_groups

Fields

get (all properties)

Name	Datatype	Description
description	string	The description for the cache subnet group.
subnet_ids	array	The EC2 subnet IDs for the cache subnet group.
cache_subnet_group_name	string	The name for the cache subnet group. This value is stored as a lowercase string.
▶tags	array
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
cache_subnet_group_name	string	The name for the cache subnet group. This value is stored as a lowercase string.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	subnet_groups	INSERT	Description, SubnetIds, region
delete_resource	subnet_groups	DELETE	Identifier, region
update_resource	subnet_groups	UPDATE	Identifier, PatchDocument, region
list_resources	subnet_groups_list_only	SELECT	region
get_resource	subnet_groups	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual subnet_group.

SELECT
  region,
  description,
  subnet_ids,
  cache_subnet_group_name,
  tags
FROM awscc.elasticache.subnet_groups
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ cache_subnet_group_name }}';

list (identifiers only)

Lists all subnet_groups in a region.

SELECT
  region,
  cache_subnet_group_name
FROM awscc.elasticache.subnet_groups_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.elasticache.subnet_groups (
  Description,
  SubnetIds,
  region
)
SELECT
  '{{ description }}',
  '{{ subnet_ids }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.elasticache.subnet_groups (
  Description,
  SubnetIds,
  CacheSubnetGroupName,
  Tags,
  region
)
SELECT
  '{{ description }}',
  '{{ subnet_ids }}',
  '{{ cache_subnet_group_name }}',
  '{{ tags }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: subnet_group
    props:
      - name: description
        value: '{{ description }}'
      - name: subnet_ids
        value:
          - '{{ subnet_ids[0] }}'
      - name: cache_subnet_group_name
        value: '{{ cache_subnet_group_name }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.elasticache.subnet_groups
SET PatchDocument = string('{{ {
    "Description": description,
    "SubnetIds": subnet_ids,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ cache_subnet_group_name }}';

DELETE example

/*+ delete */
DELETE FROM awscc.elasticache.subnet_groups
WHERE
  Identifier = '{{ cache_subnet_group_name }}' AND
  region = 'us-east-1';

Permissions

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

Create

elasticache:CreateCacheSubnetGroup,
elasticache:AddTagsToResource,
elasticache:DescribeCacheSubnetGroups,
elasticache:ListTagsForResource

Read

elasticache:DescribeCacheSubnetGroups,
elasticache:ListTagsForResource

Delete

elasticache:DeleteCacheSubnetGroup,
elasticache:DescribeCacheSubnetGroups,
elasticache:ListTagsForResource

List

elasticache:DescribeCacheSubnetGroups

Update

elasticache:ModifyCacheSubnetGroup,
elasticache:DescribeCacheSubnetGroups,
elasticache:AddTagsToResource,
elasticache:RemoveTagsFromResource