Skip to content
AWS for Query.Farm

aws.finspace.list_kx_clusters

Example SQL Queries

SELECT * FROM
aws.finspace.list_kx_clusters
WHERE
"environment_id" = 'VALUE';

Description

Returns a list of clusters.

Table Definition

Column NameColumn Data Type
environment_id Required Input Column

A unique identifier for the kdb environment.

VARCHAR
cluster_type Input Column

Specifies the type of KDB database that is being created. The following types are available:

  • HDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster.

  • RDB – A Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the savedownStorageConfiguration parameter.

  • GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.

  • GP – A general purpose cluster allows you to quickly iterate on code during development by granting greater access to system commands and enabling a fast reload of custom code. This cluster type can optionally mount databases including cache and savedown storage. For this cluster type, the node count is fixed at 1. It does not support autoscaling and supports only SINGLE AZ mode.

  • Tickerplant – A tickerplant cluster allows you to subscribe to feed handlers based on IAM permissions. It can publish to RDBs, other Tickerplants, and real-time subscribers (RTS). Tickerplants can persist messages to log, which is readable by any RDB environment. It supports only single-node that is only one kdb process.

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
kx_cluster_summaries

Lists the cluster details.

STRUCT(
    "status" VARCHAR,
    "status_reason" VARCHAR,
    "cluster_name" VARCHAR,
    "cluster_type" VARCHAR,
    "cluster_description" VARCHAR,
    "release_label" VARCHAR,
    "volumes" STRUCT(
        "volume_name" VARCHAR,
        "volume_type" VARCHAR
    )[],
    "initialization_script" VARCHAR,
    "execution_role" VARCHAR,
    "az_mode" VARCHAR,
    "availability_zone_id" VARCHAR,
    "last_modified_timestamp" TIMESTAMP_S,
    "created_timestamp" TIMESTAMP_S
)[]
Show child fields
kx_cluster_summaries[]
Show child fields
kx_cluster_summaries[].availability_zone_id

The availability zone identifiers for the requested regions.

kx_cluster_summaries[].az_mode

The number of availability zones assigned per cluster. This can be one of the following:

  • SINGLE – Assigns one availability zone per cluster.

  • MULTI – Assigns all the availability zones per cluster.

kx_cluster_summaries[].cluster_description

A description of the cluster.

kx_cluster_summaries[].cluster_name

A unique name for the cluster.

kx_cluster_summaries[].cluster_type

Specifies the type of KDB database that is being created. The following types are available:

  • HDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster.

  • RDB – A Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the savedownStorageConfiguration parameter.

  • GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.

  • GP – A general purpose cluster allows you to quickly iterate on code during development by granting greater access to system commands and enabling a fast reload of custom code. This cluster type can optionally mount databases including cache and savedown storage. For this cluster type, the node count is fixed at 1. It does not support autoscaling and supports only SINGLE AZ mode.

  • Tickerplant – A tickerplant cluster allows you to subscribe to feed handlers based on IAM permissions. It can publish to RDBs, other Tickerplants, and real-time subscribers (RTS). Tickerplants can persist messages to log, which is readable by any RDB environment. It supports only single-node that is only one kdb process.

kx_cluster_summaries[].created_timestamp

The timestamp at which the cluster was created in FinSpace. 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.

kx_cluster_summaries[].execution_role

An IAM role that defines a set of permissions associated with a cluster. These permissions are assumed when a cluster attempts to access another cluster.

kx_cluster_summaries[].initialization_script

Specifies a Q program that will be run at launch of a cluster. It is a relative path within .zip file that contains the custom code, which will be loaded on the cluster. It must include the file name itself. For example, somedir/init.q.

kx_cluster_summaries[].last_modified_timestamp

The last time that the cluster was modified. 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.

kx_cluster_summaries[].release_label

A version of the FinSpace managed kdb to run.

kx_cluster_summaries[].status

The status of a cluster.

  • PENDING – The cluster is pending creation.

  • CREATING –The cluster creation process is in progress.

  • CREATE_FAILED– The cluster creation process has failed.

  • RUNNING – The cluster creation process is running.

  • UPDATING – The cluster is in the process of being updated.

  • DELETING – The cluster is in the process of being deleted.

  • DELETED – The cluster has been deleted.

  • DELETE_FAILED – The cluster failed to delete.

kx_cluster_summaries[].status_reason

The error message when a failed state occurs.

kx_cluster_summaries[].volumes[]
Show child fields
kx_cluster_summaries[].volumes[].volume_name

A unique identifier for the volume.

kx_cluster_summaries[].volumes[].volume_type

The type of file system volume. Currently, FinSpace only supports NAS_1 volume type.