kx_cluster_nodes

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

Overview

Name	kx_cluster_nodes
Type	Resource
Id	aws.finspace.kx_cluster_nodes

Fields

The following fields are returned by SELECT queries:

list_kx_cluster_nodes

Name	Datatype	Description
next_token	string	A token that indicates where a results page should begin. (pattern: <code>.*</code>)
nodes	array	A list of nodes associated with the cluster.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_kx_cluster_nodes	select	environment_id, cluster_name, region	nextToken, maxResults	Lists all the nodes in a kdb cluster.
delete_kx_cluster_node	delete	environment_id, cluster_name, node_id, region		Deletes the specified nodes from a cluster.

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
cluster_name	string	The name of the cluster, for which you want to delete the nodes.
environment_id	string	A unique identifier for the kdb environment.
node_id	string	A unique identifier for the node that you want to delete.
region	string	AWS region (default: us-east-1)
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

list_kx_cluster_nodes

Lists all the nodes in a kdb cluster.

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

DELETE examples

delete_kx_cluster_node

Deletes the specified nodes from a cluster.

DELETE FROM aws.finspace.kx_cluster_nodes
WHERE environment_id = '{{ environment_id }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND node_id = '{{ node_id }}' --required
AND region = '{{ region }}' --required
;