Get Kx Connection String

finspace_get_kx_connection_string

R Documentation

Retrieves a connection string for a user to connect to a kdb cluster¶

Description¶

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.

Usage¶

finspace_get_kx_connection_string(userArn, environmentId, clusterName)

Arguments¶

userArn

[required] 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.

environmentId

[required] A unique identifier for the kdb environment.

clusterName

[required] A name of the kdb cluster.

Value¶

A list with the following syntax:

list(
  signedConnectionString = "string"
)

Request syntax¶

svc$get_kx_connection_string(
  userArn = "string",
  environmentId = "string",
  clusterName = "string"
)