GETKXCONNECTIONSTRING()`¶

About GetKxConnectionString¶

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.

Method Signature¶

IMPORTING¶

Required arguments:¶

`iv_userarn` `TYPE /AWS1/FNSKXUSERARN` `/AWS1/FNSKXUSERARN`¶

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.

`iv_environmentid` `TYPE /AWS1/FNSIDTYPE` `/AWS1/FNSIDTYPE`¶

A unique identifier for the kdb environment.

`iv_clustername` `TYPE /AWS1/FNSKXCLUSTERNAME` `/AWS1/FNSKXCLUSTERNAME`¶

A name of the kdb cluster.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_fnsgetkxconnstringrsp` `/AWS1/CL_FNSGETKXCONNSTRINGRSP`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->/aws1/if_fns~getkxconnectionstring(
  iv_clustername = |string|
  iv_environmentid = |string|
  iv_userarn = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_signedkxconnectionstrin = lo_result->get_signedconnectionstring( ).
ENDIF.

/AWS1/IF_FNS=>GETKXCONNECTIONSTRING()¶