kx_scaling_groups

Creates, updates, deletes, gets or lists a kx_scaling_groups resource.

Overview

Name	kx_scaling_groups
Type	Resource
Id	aws.finspace.kx_scaling_groups

Fields

The following fields are returned by SELECT queries:

get_kx_scaling_group

Name	Datatype	Description
availability_zone_id	string	The identifier of the availability zones. (pattern: <code>^[a-zA-Z0-9-]+$</code>)
clusters	array	The list of Managed kdb clusters that are currently active in the given scaling group.
created_timestamp	string (date-time)	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.
host_type	string	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.large – The host type with a configuration of 16 GiB memory and 2 vCPUs. kx.sg.xlarge – The host type with a configuration of 32 GiB memory and 4 vCPUs. kx.sg.2xlarge – The host type with a configuration of 64 GiB memory and 8 vCPUs. 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. (pattern: <code>^[a-zA-Z0-9._]+</code>)
last_modified_timestamp	string (date-time)	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.
scaling_group_arn	string	The ARN identifier for the scaling group. (pattern: <code>^arn:::::*</code>)
scaling_group_name	string	A unique identifier for the kdb scaling group. (pattern: <code>^[a-zA-Z0-9][a-zA-Z0-9-_]*[a-zA-Z0-9]$</code>)
status	string	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. (CREATING, CREATE_FAILED, ACTIVE, DELETING, DELETED, DELETE_FAILED)
status_reason	string	The error message when a failed state occurs. (pattern: <code>^[a-zA-Z0-9_-.\s]+$</code>)

list_kx_scaling_groups

Name	Datatype	Description
next_token	string	A token that indicates where a results page should begin. (pattern: <code>.*</code>)
scaling_groups	array	A list of scaling groups available in a kdb environment.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_kx_scaling_group	select	environment_id, scaling_group_name, region		Retrieves details of a scaling group.
list_kx_scaling_groups	select	environment_id, region	maxResults, nextToken	Returns a list of scaling groups in a kdb environment.
create_kx_scaling_group	insert	environment_id, region, clientToken, scalingGroupName, hostType, availabilityZoneId		Creates a new scaling group.
delete_kx_scaling_group	delete	environment_id, scaling_group_name, region	clientToken	Deletes the specified scaling group. This action is irreversible. You cannot delete a scaling group until all the clusters running on it have been deleted.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
environment_id	string	A unique identifier for the kdb environment, from where you want to delete the dataview.
region	string	AWS region (default: us-east-1)
scaling_group_name	string	A unique identifier for the kdb scaling group.
clientToken	string	A token that ensures idempotency. This token expires in 10 minutes.
maxResults	integer	The maximum number of results to return in this request.
nextToken	string	A token that indicates where a results page should begin.

SELECT examples

get_kx_scaling_group

Retrieves details of a scaling group.

SELECT
availability_zone_id,
clusters,
created_timestamp,
host_type,
last_modified_timestamp,
scaling_group_arn,
scaling_group_name,
status,
status_reason
FROM aws.finspace.kx_scaling_groups
WHERE environment_id = '{{ environment_id }}' -- required
AND scaling_group_name = '{{ scaling_group_name }}' -- required
AND region = '{{ region }}' -- required
;

list_kx_scaling_groups

Returns a list of scaling groups in a kdb environment.

SELECT
next_token,
scaling_groups
FROM aws.finspace.kx_scaling_groups
WHERE environment_id = '{{ environment_id }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_kx_scaling_group

Creates a new scaling group.

INSERT INTO aws.finspace.kx_scaling_groups (
clientToken,
scalingGroupName,
hostType,
availabilityZoneId,
tags,
environment_id,
region
)
SELECT 
'{{ clientToken }}' /* required */,
'{{ scalingGroupName }}' /* required */,
'{{ hostType }}' /* required */,
'{{ availabilityZoneId }}' /* required */,
'{{ tags }}',
'{{ environment_id }}',
'{{ region }}'
RETURNING
availability_zone_id,
created_timestamp,
environment_id,
host_type,
last_modified_timestamp,
scaling_group_name,
status
;

Manifest

# Description fields are for documentation purposes
- name: kx_scaling_groups
props:
  - name: environment_id
    value: "{{ environment_id }}"
    description: Required parameter for the kx_scaling_groups resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the kx_scaling_groups resource.
  - name: clientToken
    value: "{{ clientToken }}"
  - name: scalingGroupName
    value: "{{ scalingGroupName }}"
  - name: hostType
    value: "{{ hostType }}"
  - name: availabilityZoneId
    value: "{{ availabilityZoneId }}"
  - name: tags
    value: "{{ tags }}"

DELETE examples

delete_kx_scaling_group

Deletes the specified scaling group. This action is irreversible. You cannot delete a scaling group until all the clusters running on it have been deleted.

DELETE FROM aws.finspace.kx_scaling_groups
WHERE environment_id = '{{ environment_id }}' --required
AND scaling_group_name = '{{ scaling_group_name }}' --required
AND region = '{{ region }}' --required
AND clientToken = '{{ clientToken }}'
;