/AWS1/IF_FNS=>UPDATEKXCLUSTERCODECONF()

About UpdateKxClusterCodeConfiguration

Allows you to update code configuration on a running cluster. By using this API you can update the code, the initialization script path, and the command line arguments for a specific cluster. The configuration that you want to update will override any existing configurations on the cluster.

Method Signature

METHODS /AWS1/IF_FNS~UPDATEKXCLUSTERCODECONF
  IMPORTING
    !IV_ENVIRONMENTID TYPE /AWS1/FNSKXENVIRONMENTID OPTIONAL
    !IV_CLUSTERNAME TYPE /AWS1/FNSKXCLUSTERNAME OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/FNSCLIENTTOKENSTRING OPTIONAL
    !IO_CODE TYPE REF TO /AWS1/CL_FNSCODECONFIGURATION OPTIONAL
    !IV_INITIALIZATIONSCRIPT TYPE /AWS1/FNSINITIALIZATIONSCRIP00 OPTIONAL
    !IT_COMMANDLINEARGUMENTS TYPE /AWS1/CL_FNSKXCMDLINEARGUMENT=>TT_KXCOMMANDLINEARGUMENTS OPTIONAL
    !IO_DEPLOYMENTCONFIGURATION TYPE REF TO /AWS1/CL_FNSKXCLSTCODEDEPLOY00 OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_fnsupkxclstcodeconf01
  RAISING
    /AWS1/CX_FNSACCESSDENIEDEX
    /AWS1/CX_FNSCONFLICTEXCEPTION
    /AWS1/CX_FNSINTERNALSERVEREX
    /AWS1/CX_FNSLIMITEXCEEDEDEX
    /AWS1/CX_FNSRESOURCENOTFOUNDEX
    /AWS1/CX_FNSTHROTTLINGEX
    /AWS1/CX_FNSVALIDATIONEX
    /AWS1/CX_FNSCLIENTEXC
    /AWS1/CX_FNSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_environmentid TYPE /AWS1/FNSKXENVIRONMENTID /AWS1/FNSKXENVIRONMENTID

A unique identifier of the kdb environment.

iv_clustername TYPE /AWS1/FNSKXCLUSTERNAME /AWS1/FNSKXCLUSTERNAME

The name of the cluster.

io_code TYPE REF TO /AWS1/CL_FNSCODECONFIGURATION /AWS1/CL_FNSCODECONFIGURATION

code

Optional arguments:

iv_clienttoken TYPE /AWS1/FNSCLIENTTOKENSTRING /AWS1/FNSCLIENTTOKENSTRING

A token that ensures idempotency. This token expires in 10 minutes.

iv_initializationscript TYPE /AWS1/FNSINITIALIZATIONSCRIP00 /AWS1/FNSINITIALIZATIONSCRIP00

Specifies a Q program that will be run at launch of a cluster. It is a relative path within .zip file that contains the custom code, which will be loaded on the cluster. It must include the file name itself. For example, somedir/init.q.

You cannot update this parameter for a NO_RESTART deployment.

it_commandlinearguments TYPE /AWS1/CL_FNSKXCMDLINEARGUMENT=>TT_KXCOMMANDLINEARGUMENTS TT_KXCOMMANDLINEARGUMENTS

Specifies the key-value pairs to make them available inside the cluster.

You cannot update this parameter for a NO_RESTART deployment.

io_deploymentconfiguration TYPE REF TO /AWS1/CL_FNSKXCLSTCODEDEPLOY00 /AWS1/CL_FNSKXCLSTCODEDEPLOY00

The configuration that allows you to choose how you want to update the code on a cluster.

RETURNING

oo_output TYPE REF TO /aws1/cl_fnsupkxclstcodeconf01 /AWS1/CL_FNSUPKXCLSTCODECONF01

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->updatekxclustercodeconf(
  io_code = new /aws1/cl_fnscodeconfiguration(
    iv_s3bucket = |string|
    iv_s3key = |string|
    iv_s3objectversion = |string|
  )
  io_deploymentconfiguration = new /aws1/cl_fnskxclstcodedeploy00( |string| )
  it_commandlinearguments = VALUE /aws1/cl_fnskxcmdlineargument=>tt_kxcommandlinearguments(
    (
      new /aws1/cl_fnskxcmdlineargument(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_clienttoken = |string|
  iv_clustername = |string|
  iv_environmentid = |string|
  iv_initializationscript = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
ENDIF.