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	aws.rds.db_subnet_groups

Fields

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. Constraints: Must contain no more than 255 lowercase alphanumeric characters or hyphens. Must not be "Default". Example: mysubnetgroup
subnet_ids	array	The EC2 Subnet IDs for the DB subnet group.
tags	array	An optional array of key-value pairs to apply to this DB subnet group.
region	string	AWS region.

Methods

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

SELECT
region,
db_subnet_group_description,
db_subnet_group_name,
subnet_ids,
tags
FROM aws.rds.db_subnet_groups
WHERE region = 'us-east-1';

Gets all properties from an individual db_subnet_group.

SELECT
region,
db_subnet_group_description,
db_subnet_group_name,
subnet_ids,
tags
FROM aws.rds.db_subnet_groups
WHERE region = 'us-east-1' AND data__Identifier = '<DBSubnetGroupName>';

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 aws.rds.db_subnet_groups (
 DBSubnetGroupDescription,
 SubnetIds,
 region
)
SELECT 
'{{ DBSubnetGroupDescription }}',
 '{{ SubnetIds }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.rds.db_subnet_groups (
 DBSubnetGroupDescription,
 DBSubnetGroupName,
 SubnetIds,
 Tags,
 region
)
SELECT 
 '{{ DBSubnetGroupDescription }}',
 '{{ DBSubnetGroupName }}',
 '{{ SubnetIds }}',
 '{{ 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: DBSubnetGroupDescription
        value: '{{ DBSubnetGroupDescription }}'
      - name: DBSubnetGroupName
        value: '{{ DBSubnetGroupName }}'
      - name: SubnetIds
        value:
          - '{{ SubnetIds[0] }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.rds.db_subnet_groups
WHERE data__Identifier = '<DBSubnetGroupName>'
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