Skip to content
AWS for Query.Farm

aws.finspace.list_kx_cluster_nodes

Example SQL Queries

SELECT * FROM
aws.finspace.list_kx_cluster_nodes
WHERE
"cluster_name" = 'VALUE'
AND "environment_id" = 'VALUE';

Description

Lists all the nodes in a kdb cluster.

Table Definition

Column NameColumn Data Type
cluster_name Required Input Column

A unique name for the cluster.

VARCHAR
environment_id Required Input Column

A unique identifier for the kdb environment.

VARCHAR
max_results Input Column

The maximum number of results to return in this request.

BIGINT
next_token Input Column

A token that indicates where a results page should begin.

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
nodes

A list of nodes associated with the cluster.

STRUCT(
    "node_id" VARCHAR,
    "availability_zone_id" VARCHAR,
    "launch_time" TIMESTAMP_S,
    "status" VARCHAR
)[]
Show child fields
nodes[]
Show child fields
nodes[].availability_zone_id

The identifier of the availability zones where subnets for the environment are created.

nodes[].launch_time

The time when a particular node is started. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

nodes[].node_id

A unique identifier for the node.

nodes[].status

Specifies the status of the cluster nodes.

  • RUNNING – The node is actively serving.

  • PROVISIONING – The node is being prepared.