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 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. Constraints: + Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. + Must not be default. + First character must be a letter. Example: mydbsubnetgroup
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. Constraints: + Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. + Must not be default. + First character must be a letter. Example: mydbsubnetgroup
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 = '{{ region }}' 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 = '{{ region }}';

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 }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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 }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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 }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.rds.db_subnet_groups
WHERE
  Identifier = '{{ db_subnet_group_name }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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