kx_connection_strings

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

Overview

Name	kx_connection_strings
Type	Resource
Id	aws.finspace.kx_connection_strings

Fields

The following fields are returned by SELECT queries:

get_kx_connection_string

Name	Datatype	Description
signed_connection_string	string	The signed connection string that you can use to connect to clusters. (pattern: <code>^(:|:tcps://)[a-zA-Z0-9-._]+:\d+:[a-zA-Z0-9-._]+:\S+$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_kx_connection_string	select	userArn, environment_id, clusterName, region		Retrieves a connection string for a user to connect to a kdb cluster. You must call this API using the same role that you have defined while creating a user.

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
clusterName	string	A name of the kdb cluster.
environment_id	string	A unique identifier for the kdb environment.
region	string	AWS region (default: us-east-1)
userArn	string	The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the IAM User Guide.

SELECT examples

get_kx_connection_string

Retrieves a connection string for a user to connect to a kdb cluster. You must call this API using the same role that you have defined while creating a user.

SELECT
signed_connection_string
FROM aws.finspace.kx_connection_strings
WHERE userArn = '{{ userArn }}' -- required
AND environment_id = '{{ environment_id }}' -- required
AND clusterName = '{{ clusterName }}' -- required
AND region = '{{ region }}' -- required
;