Skip to content
AWS for Query.Farm

aws.docdb.describe_db_subnet_groups

Example SQL Queries

SELECT * FROM
aws.docdb.describe_db_subnet_groups;

Description

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

Table Definition

Column NameColumn Data Type
db_subnet_group_name Input Column

The name of the subnet group.

VARCHAR
filters Input Column

This parameter is not currently supported.

STRUCT(
    "name" VARCHAR,
    "values" VARCHAR[]
)[]
Show child fields
filters[]
Show child fields
filters[].name

The name of the filter. Filter names are case sensitive.

filters[].values[]
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
db_subnet_group_arn

The Amazon Resource Name (ARN) for the DB subnet group.

VARCHAR
db_subnet_group_description

Provides the description of the subnet group.

VARCHAR
subnet_group_status

Provides the status of the subnet group.

VARCHAR
subnets

Detailed information about one or more subnets within a subnet group.

STRUCT(
    "subnet_identifier" VARCHAR,
    "subnet_availability_zone" STRUCT(
        "name" VARCHAR
    ),
    "subnet_status" VARCHAR
)[]
Show child fields
subnets[]
Show child fields
subnets[].subnet_availability_zone

Specifies the Availability Zone for the subnet.

Show child fields
subnets[].subnet_availability_zone.name

The name of the Availability Zone.

subnets[].subnet_identifier

Specifies the identifier of the subnet.

subnets[].subnet_status

Specifies the status of the subnet.

vpc_id

Provides the virtual private cloud (VPC) ID of the subnet group.

VARCHAR