Skip to content
AWS for Query.Farm

aws.redshift.describe_cluster_security_groups

Example SQL Queries

SELECT * FROM
aws.redshift.describe_cluster_security_groups;

Description

Returns information about Amazon Redshift security groups. If the name of a security group is specified, the response will contain only information about only that security group.

For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all security 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 security groups that have any combination of those values are returned.

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

Table Definition

Column NameColumn Data Type
cluster_security_group_name Input Column

The name of the cluster security group to which the operation was applied.

VARCHAR
tag_keys Input Column

A tag key or keys for which you want to return all matching cluster security groups that are associated with the specified key or keys. For example, suppose that you have security 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 security 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 security groups that are associated with the specified tag value or values. For example, suppose that you have security 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 security 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

A description of the security group.

VARCHAR
ec2_security_groups

A list of EC2 security groups that are permitted to access clusters associated with this cluster security group.

STRUCT(
    "status" VARCHAR,
    "ec2_security_group_name" VARCHAR,
    "ec2_security_group_owner_id" VARCHAR,
    "tags" STRUCT(
        "key" VARCHAR,
        "value" VARCHAR
    )[]
)[]
Show child fields
ec2_security_groups[]
Show child fields
ec2_security_groups[].ec2_security_group_name

The name of the EC2 Security Group.

ec2_security_groups[].ec2_security_group_owner_id

The Amazon Web Services account ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.

ec2_security_groups[].status

The status of the EC2 security group.

ec2_security_groups[].tags[]
Show child fields
ec2_security_groups[].tags[].key

The key, or name, for the resource tag.

ec2_security_groups[].tags[].value

The value for the resource tag.

ip_ranges

A list of IP ranges (CIDR blocks) that are permitted to access clusters associated with this cluster security group.

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

The IP range in Classless Inter-Domain Routing (CIDR) notation.

ip_ranges[].status

The status of the IP range, for example, "authorized".

ip_ranges[].tags[]
Show child fields
ip_ranges[].tags[].key

The key, or name, for the resource tag.

ip_ranges[].tags[].value

The value for the resource tag.

tags

The list of tags for the cluster security 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.