Skip to content
AWS for Query.Farm

aws.redshift.describe_cluster_subnet_groups

Example SQL Queries

SELECT * FROM
aws.redshift.describe_cluster_subnet_groups;

Description

Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups. By default, this operation returns information about all cluster subnet groups that are defined in your Amazon Web Services account.

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all subnet groups that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all subnet groups that have any combination of those values are returned.

If both tag keys and values are omitted from the request, subnet groups are returned regardless of whether they have tag keys or values associated with them.

Table Definition

Column NameColumn Data Type
cluster_subnet_group_name Input Column

The name of the cluster subnet group.

VARCHAR
tag_keys Input Column

A tag key or keys for which you want to return all matching cluster subnet groups that are associated with the specified key or keys. For example, suppose that you have subnet groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the subnet groups that have either or both of these tag keys associated with them.

VARCHAR[]
Show child fields
tag_keys[]
tag_values Input Column

A tag value or values for which you want to return all matching cluster subnet groups that are associated with the specified tag value or values. For example, suppose that you have subnet groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the subnet groups that have either or both of these tag values associated with them.

VARCHAR[]
Show child fields
tag_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
description

The description of the cluster subnet group.

VARCHAR
subnet_group_status

The status of the cluster subnet group. Possible values are Complete, Incomplete and Invalid. 

VARCHAR
subnets

A list of the VPC Subnet elements. 

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

Show child fields
subnets[].subnet_availability_zone.name

The name of the availability zone.

subnets[].subnet_availability_zone.supported_platforms[]
Show child fields
subnets[].subnet_availability_zone.supported_platforms[].name

subnets[].subnet_identifier

The identifier of the subnet.

subnets[].subnet_status

The status of the subnet.

supported_cluster_ip_address_types

The IP address types supported by this cluster subnet group. Possible values are ipv4 and dualstack.

VARCHAR[]
Show child fields
supported_cluster_ip_address_types[]
tags

The list of tags for the cluster subnet group.

STRUCT(
    "key" VARCHAR,
    "value" VARCHAR
)[]
Show child fields
tags[]
Show child fields
tags[].key

The key, or name, for the resource tag.

tags[].value

The value for the resource tag.

vpc_id

The VPC ID of the cluster subnet group.

VARCHAR