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	The AWS::MemoryDB::SubnetGroup resource creates an Amazon MemoryDB Subnet Group.
Id	awscc.memorydb.subnet_groups

Fields

get (all properties)

Name	Datatype	Description
subnet_group_name	string	The name of the subnet group. This value must be unique as it also serves as the subnet group identifier.
description	string	An optional description of the subnet group.
subnet_ids	array	A list of VPC subnet IDs for the subnet group.
▶tags	array	An array of key-value pairs to apply to this subnet group.
arn	string	The Amazon Resource Name (ARN) of the subnet group.
supported_network_types	array	Supported network types would be a list of network types supported by subnet group and can be either [ipv4] or [ipv4, dual_stack] or [ipv6].
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
subnet_group_name	string	The name of the subnet group. This value must be unique as it also serves as the subnet group identifier.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	subnet_groups	INSERT	SubnetGroupName, 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,
  subnet_group_name,
  description,
  subnet_ids,
  tags,
  arn,
  supported_network_types
FROM awscc.memorydb.subnet_groups
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ subnet_group_name }}';

list (identifiers only)

Lists all subnet_groups in a region.

SELECT
  region,
  subnet_group_name
FROM awscc.memorydb.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.memorydb.subnet_groups (
  SubnetGroupName,
  SubnetIds,
  region
)
SELECT
  '{{ subnet_group_name }}',
  '{{ subnet_ids }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.memorydb.subnet_groups (
  SubnetGroupName,
  Description,
  SubnetIds,
  Tags,
  region
)
SELECT
  '{{ subnet_group_name }}',
  '{{ description }}',
  '{{ subnet_ids }}',
  '{{ 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: subnet_group_name
        value: '{{ subnet_group_name }}'
      - name: description
        value: '{{ description }}'
      - name: subnet_ids
        value:
          - '{{ subnet_ids[0] }}'
      - 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.memorydb.subnet_groups
SET PatchDocument = string('{{ {
    "Description": description,
    "SubnetIds": subnet_ids,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ subnet_group_name }}';

DELETE example

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

Permissions

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

Create

memorydb:CreateSubnetGroup,
memorydb:DescribeSubnetGroups,
memorydb:TagResource,
memorydb:ListTags,
iam:CreateServiceLinkedRole

Read

memorydb:DescribeSubnetGroups,
memorydb:ListTags

Update

memorydb:UpdateSubnetGroup,
memorydb:DescribeSubnetGroups,
memorydb:ListTags,
memorydb:TagResource,
memorydb:UntagResource

Delete

memorydb:DeleteSubnetGroup,
memorydb:DescribeSubnetGroups

List

memorydb:DescribeSubnetGroups