Returns a list of DBSubnetGroup descriptions¶

Description¶

Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.

For an overview of CIDR ranges, go to the Wikipedia Tutorial.

Usage¶

rds_describe_db_subnet_groups(DBSubnetGroupName, Filters, MaxRecords,
  Marker)

Arguments¶

DBSubnetGroupName

The name of the DB subnet group to return details for.
Filters

This parameter isn't currently supported.
MaxRecords

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.
Marker

An optional pagination token provided by a previous DescribeDBSubnetGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Value¶

A list with the following syntax:

list(
  Marker = "string",
  DBSubnetGroups = list(
    list(
      DBSubnetGroupName = "string",
      DBSubnetGroupDescription = "string",
      VpcId = "string",
      SubnetGroupStatus = "string",
      Subnets = list(
        list(
          SubnetIdentifier = "string",
          SubnetAvailabilityZone = list(
            Name = "string"
          ),
          SubnetOutpost = list(
            Arn = "string"
          ),
          SubnetStatus = "string"
        )
      ),
      DBSubnetGroupArn = "string",
      SupportedNetworkTypes = list(
        "string"
      )
    )
  )
)

Request syntax¶

svc$describe_db_subnet_groups(
  DBSubnetGroupName = "string",
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxRecords = 123,
  Marker = "string"
)

Examples¶

# This example lists information about the specified DB subnet group.
svc$describe_db_subnet_groups(
  DBSubnetGroupName = "mydbsubnetgroup"
)