Skip to content
AWS for Query.Farm

aws.kafka.list_nodes

Example SQL Queries

SELECT * FROM
aws.kafka.list_nodes
WHERE
"cluster_arn" = 'VALUE';

Description

Returns a list of the broker nodes in the cluster.

Table Definition

Column NameColumn Data Type
cluster_arn Required Input Column

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

VARCHAR
_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
added_to_cluster_time

The start time.

VARCHAR
broker_node_info

The broker node info.

STRUCT(
    "attached_eni_id" VARCHAR,
    "broker_id" DOUBLE,
    "client_subnet" VARCHAR,
    "client_vpc_ip_address" VARCHAR,
    "current_broker_software_info" STRUCT(
        "configuration_arn" VARCHAR,
        "configuration_revision" BIGINT,
        "kafka_version" VARCHAR
    ),
    "endpoints" VARCHAR[]
)
Show child fields
broker_node_info.attached_eni_id

The attached elastic network interface of the broker.

broker_node_info.broker_id

The ID of the broker.

broker_node_info.client_subnet

The client subnet to which this broker node belongs.

broker_node_info.client_vpc_ip_address

The virtual private cloud (VPC) of the client.

broker_node_info.current_broker_software_info

Information about the version of software currently deployed on the Apache Kafka brokers in the cluster.

Show child fields
broker_node_info.current_broker_software_info.configuration_arn

The Amazon Resource Name (ARN) of the configuration used for the cluster. This field isn't visible in this preview release.

broker_node_info.current_broker_software_info.configuration_revision

The revision of the configuration to use. This field isn't visible in this preview release.

broker_node_info.current_broker_software_info.kafka_version

The version of Apache Kafka.

broker_node_info.endpoints[]
controller_node_info

The ControllerNodeInfo.

STRUCT(
    "endpoints" VARCHAR[]
)
Show child fields
controller_node_info.endpoints[]
instance_type

The instance type.

VARCHAR
node_arn

The Amazon Resource Name (ARN) of the node.

VARCHAR
node_type

The node type.

VARCHAR
zookeeper_node_info

The ZookeeperNodeInfo.

STRUCT(
    "attached_eni_id" VARCHAR,
    "client_vpc_ip_address" VARCHAR,
    "endpoints" VARCHAR[],
    "zookeeper_id" DOUBLE,
    "zookeeper_version" VARCHAR
)
Show child fields
zookeeper_node_info.attached_eni_id

The attached elastic network interface of the broker.

zookeeper_node_info.client_vpc_ip_address

The virtual private cloud (VPC) IP address of the client.

zookeeper_node_info.endpoints[]
zookeeper_node_info.zookeeper_id

The role-specific ID for Zookeeper.

zookeeper_node_info.zookeeper_version

The version of Zookeeper.