db_subnet_groups

Creates, updates, deletes or gets a db_subnet_group resource or lists db_subnet_groups in a region

Overview

Name	db_subnet_groups
Type	Resource
Description	The ``AWS::RDS::DBSubnetGroup`` resource creates a database subnet group. Subnet groups must contain at least two subnets in two different Availability Zones in the same region. For more information, see [Working with DB subnet groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html#USER_VPC.Subnets) in the *Amazon RDS User Guide*.
Id	awscc.rds.db_subnet_groups

Fields

get (all properties)

Name	Datatype	Description
db_subnet_group_description	string	The description for the DB subnet group.
db_subnet_group_name	string	The name for the DB subnet group. This value is stored as a lowercase string.<br />Constraints:<br />+ Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens.<br />+ Must not be default.<br />+ First character must be a letter.<br /><br />Example: &#96;&#96;mydbsubnetgroup&#96;&#96;
subnet_ids	array	The EC2 Subnet IDs for the DB subnet group.
▶tags	array	Tags to assign to the DB subnet group.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
db_subnet_group_name	string	The name for the DB subnet group. This value is stored as a lowercase string.<br />Constraints:<br />+ Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens.<br />+ Must not be default.<br />+ First character must be a letter.<br /><br />Example: &#96;&#96;mydbsubnetgroup&#96;&#96;
region	string	AWS region.

For more information, see AWS::RDS::DBSubnetGroup.

Methods

Name	Resource	Accessible by	Required Params
create_resource	db_subnet_groups	INSERT	DBSubnetGroupDescription, SubnetIds, region
delete_resource	db_subnet_groups	DELETE	Identifier, region
update_resource	db_subnet_groups	UPDATE	Identifier, PatchDocument, region
list_resources	db_subnet_groups_list_only	SELECT	region
get_resource	db_subnet_groups	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual db_subnet_group.

SELECT
  region,
  db_subnet_group_description,
  db_subnet_group_name,
  subnet_ids,
  tags
FROM awscc.rds.db_subnet_groups
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ db_subnet_group_name }}';

list (identifiers only)

Lists all db_subnet_groups in a region.

SELECT
  region,
  db_subnet_group_name
FROM awscc.rds.db_subnet_groups_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.rds.db_subnet_groups (
  DBSubnetGroupDescription,
  SubnetIds,
  region
)
SELECT
  '{{ db_subnet_group_description }}',
  '{{ subnet_ids }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.rds.db_subnet_groups (
  DBSubnetGroupDescription,
  DBSubnetGroupName,
  SubnetIds,
  Tags,
  region
)
SELECT
  '{{ db_subnet_group_description }}',
  '{{ db_subnet_group_name }}',
  '{{ subnet_ids }}',
  '{{ tags }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: db_subnet_group
    props:
      - name: db_subnet_group_description
        value: '{{ db_subnet_group_description }}'
      - name: db_subnet_group_name
        value: '{{ db_subnet_group_name }}'
      - 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 db_subnet_group resource, using stack-deploy.

/*+ update */
UPDATE awscc.rds.db_subnet_groups
SET PatchDocument = string('{{ {
    "DBSubnetGroupDescription": db_subnet_group_description,
    "SubnetIds": subnet_ids,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ db_subnet_group_name }}';

DELETE example

/*+ delete */
DELETE FROM awscc.rds.db_subnet_groups
WHERE
  Identifier = '{{ db_subnet_group_name }}' AND
  region = 'us-east-1';

Permissions

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

Create

iam:CreateServiceLinkedRole,
rds:CreateDBSubnetGroup,
rds:DescribeDBSubnetGroups,
rds:AddTagsToResource,
rds:RemoveTagsFromResource,
rds:ListTagsForResource

Read

rds:DescribeDBSubnetGroups,
rds:ListTagsForResource

Update

rds:ModifyDBSubnetGroup,
rds:DescribeDBSubnetGroups,
rds:AddTagsToResource,
rds:RemoveTagsFromResource,
rds:ListTagsForResource

Delete

rds:DeleteDBSubnetGroup,
rds:DescribeDBSubnetGroups,
rds:ListTagsForResource

List

rds:DescribeDBSubnetGroups