AWS Fundamentals Logo
AWS Fundamentals
AWS::RDS::DBSubnetGroup

RDS DBSubnetGroup

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*.

Properties

4 configurable properties. 2 required. Click a row to see details.

Filter:
PropertyTypeFlags
DBSubnetGroupDescription
string
Required
SubnetIds
Array<string>
Required
DBSubnetGroupName
string
Create-only
Tags
Array<Tag>

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::RDS::DBSubnetGroup

Resources:
  MyResource:
    Type: AWS::RDS::DBSubnetGroup
    Properties:
      DBSubnetGroupDescription: "value"
      SubnetIds: "my-subnetids"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

iam:CreateServiceLinkedRolerds:CreateDBSubnetGrouprds:DescribeDBSubnetGroupsrds:AddTagsToResourcerds:RemoveTagsFromResourcerds:ListTagsForResource

read

rds:DescribeDBSubnetGroupsrds:ListTagsForResource

update

rds:ModifyDBSubnetGrouprds:DescribeDBSubnetGroupsrds:AddTagsToResourcerds:RemoveTagsFromResourcerds:ListTagsForResource

delete

rds:DeleteDBSubnetGrouprds:DescribeDBSubnetGroupsrds:ListTagsForResource

list

rds:DescribeDBSubnetGroups

Get the RDS Cheat Sheet

Everything you need to know about RDS on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

ServiceRDS
Properties4
Required2
TaggingSupported
Primary IDDBSubnetGroupName

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

DBSubnetGroupName

Related Resources

External Links