finspace / Client / update_kx_cluster_code_configuration

update_kx_cluster_code_configuration#

finspace.Client.update_kx_cluster_code_configuration(**kwargs)#

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

response = client.update_kx_cluster_code_configuration(
    environmentId='string',
    clusterName='string',
    clientToken='string',
    code={
        's3Bucket': 'string',
        's3Key': 'string',
        's3ObjectVersion': 'string'
    },
    initializationScript='string',
    commandLineArguments=[
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    deploymentConfiguration={
        'deploymentStrategy': 'NO_RESTART'|'ROLLING'|'FORCE'
    }
)
Parameters:

  • environmentId (string) –

    [REQUIRED]

    A unique identifier of the kdb environment.

  • clusterName (string) –

    [REQUIRED]

    The name of the cluster.

  • clientToken (string) –

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

    This field is autopopulated if not provided.

  • code (dict) –

    [REQUIRED]

    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.

  • initializationScript (string) –

    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 (list) –

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

    You cannot update this parameter for a NO_RESTART deployment.

    • (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.

  • deploymentConfiguration (dict) –

    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.

      • NO_RESTART – This option updates the cluster without stopping the running q process. It is only available for GP type cluster. This option is quicker as it reduces the turn around time to update configuration on a cluster. With this deployment mode, you cannot update the initializationScript and commandLineArguments parameters.

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

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • finspace.Client.exceptions.InternalServerException

  • finspace.Client.exceptions.ThrottlingException

  • finspace.Client.exceptions.AccessDeniedException

  • finspace.Client.exceptions.LimitExceededException

  • finspace.Client.exceptions.ValidationException

  • finspace.Client.exceptions.ConflictException

  • finspace.Client.exceptions.ResourceNotFoundException