FinSpace User Environment Management service

2023/10/30 - FinSpace User Environment Management service - 1 new api methods

Changes  Introducing new API UpdateKxClusterCodeConfiguration, introducing new cache types for clusters and introducing new deployment modes for updating clusters.

UpdateKxClusterCodeConfiguration (new) Link ¶

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.

See also: AWS API Documentation

Request Syntax

        's3Bucket': 'string',
        's3Key': 'string',
        's3ObjectVersion': 'string'
            'key': 'string',
            'value': 'string'
        'deploymentStrategy': 'ROLLING'|'FORCE'
type environmentId


param environmentId


A unique identifier of the kdb environment.

type clusterName


param clusterName


The name of the cluster.

type clientToken


param clientToken

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

This field is autopopulated if not provided.

type code


param code


The structure of the customer code available within the running cluster.

  • s3Bucket (string) --

    A unique name for the S3 bucket.

  • s3Key (string) --

    The full S3 path (excluding bucket) to the .zip file. This file contains the code that is loaded onto the cluster when it's started.

  • s3ObjectVersion (string) --

    The version of an S3 object.

type initializationScript


param 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 .

type commandLineArguments


param commandLineArguments

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

  • (dict) --

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

    • key (string) --

      The name of the key.

    • value (string) --

      The value of the key.

type deploymentConfiguration


param deploymentConfiguration

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

  • deploymentStrategy (string) -- [REQUIRED]

    The type of deployment that you want on a cluster.

    • ROLLING – This options updates the cluster by stopping the exiting q process and starting a new q process with updated configuration.

    • FORCE – This option updates the cluster by immediately stopping all the running processes before starting up new ones with the updated configuration.




Response Syntax


Response Structure

  • (dict) --