Skip to content
AWS for Query.Farm

aws.finspace.get_kx_scaling_group

Example SQL Queries

SELECT * FROM
aws.finspace.get_kx_scaling_group
WHERE
"environment_id" = 'VALUE'
AND "scaling_group_name" = 'VALUE';

Description

Retrieves details of a scaling group.

Table Definition

Column NameColumn Data Type
environment_id Required Input Column

A unique identifier for the kdb environment. 

VARCHAR
scaling_group_name Required Input Column

A unique identifier for the kdb scaling group. 

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
availability_zone_id

The identifier of the availability zones.

VARCHAR
clusters

The list of Managed kdb clusters that are currently active in the given scaling group. 

VARCHAR[]
Show child fields
clusters[]
created_timestamp

The timestamp at which the scaling group 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.

TIMESTAMP_S
host_type

The memory and CPU capabilities of the scaling group host on which FinSpace Managed kdb clusters will be placed.

It can have one of the following values:

  • kx.sg.4xlarge – The host type with a configuration of 108 GiB memory and 16 vCPUs.

  • kx.sg.8xlarge – The host type with a configuration of 216 GiB memory and 32 vCPUs.

  • kx.sg.16xlarge – The host type with a configuration of 432 GiB memory and 64 vCPUs.

  • kx.sg.32xlarge – The host type with a configuration of 864 GiB memory and 128 vCPUs.

  • kx.sg1.16xlarge – The host type with a configuration of 1949 GiB memory and 64 vCPUs.

  • kx.sg1.24xlarge – The host type with a configuration of 2948 GiB memory and 96 vCPUs.

VARCHAR
last_modified_timestamp

The last time that the scaling group was updated 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. 

TIMESTAMP_S
scaling_group_arn

The ARN identifier for the scaling group. 

VARCHAR
status

The status of scaling group.

  • CREATING – The scaling group creation is in progress.

  • CREATE_FAILED – The scaling group creation has failed.

  • ACTIVE – The scaling group is active.

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

  • UPDATE_FAILED – The update action failed.

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

  • DELETE_FAILED – The system failed to delete the scaling group.

  • DELETED – The scaling group is successfully deleted.

VARCHAR
status_reason

The error message when a failed state occurs. 

VARCHAR