Update Kx Cluster Code Configuration

finspace_update_kx_cluster_code_configuration

R Documentation

Allows you to update code configuration on a running cluster¶

Description¶

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.

Usage¶

finspace_update_kx_cluster_code_configuration(environmentId,
  clusterName, clientToken, code, initializationScript,
  commandLineArguments, deploymentConfiguration)

Arguments¶

environmentId

[required] A unique identifier of the kdb environment.

clusterName

[required] The name of the cluster.

clientToken

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

code

[required]

initializationScript

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.

commandLineArguments

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

You cannot update this parameter for a NO_RESTART deployment.

deploymentConfiguration

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

Value¶

An empty list.

Request syntax¶

svc$update_kx_cluster_code_configuration(
  environmentId = "string",
  clusterName = "string",
  clientToken = "string",
  code = list(
    s3Bucket = "string",
    s3Key = "string",
    s3ObjectVersion = "string"
  ),
  initializationScript = "string",
  commandLineArguments = list(
    list(
      key = "string",
      value = "string"
    )
  ),
  deploymentConfiguration = list(
    deploymentStrategy = "NO_RESTART"|"ROLLING"|"FORCE"
  )
)