Skip to main content

db_subnet_groups_list_only

Lists db_subnet_groups in a region or regions, for all properties use db_subnet_groups

Overview

Namedb_subnet_groups_list_only
TypeResource
DescriptionThe 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*.
Idaws.rds.db_subnet_groups_list_only

Fields

NameDatatypeDescription
db_subnet_group_descriptionstringThe description for the DB subnet group.
db_subnet_group_namestringThe 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_idsarrayThe EC2 Subnet IDs for the DB subnet group.
tagsarrayAn optional array of key-value pairs to apply to this DB subnet group.
regionstringAWS region.

Methods

NameAccessible byRequired Params
list_resourcesSELECTregion

SELECT examples

Lists all db_subnet_groups in a region.

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

Permissions

For permissions required to operate on the db_subnet_groups_list_only resource, see db_subnet_groups