Package software.amazon.awssdk.services.finspace.model

Interface CreateKxClusterRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateKxClusterRequest.Builder,CreateKxClusterRequest>, FinspaceRequest.Builder, SdkBuilder<CreateKxClusterRequest.Builder,CreateKxClusterRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateKxClusterRequest
public static interface CreateKxClusterRequest.Builder extends FinspaceRequest.Builder, SdkPojo, CopyableBuilder<CreateKxClusterRequest.Builder,CreateKxClusterRequest>

  • Method Details

    • clientToken

      CreateKxClusterRequest.Builder clientToken(String clientToken)

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

      Parameters:
      clientToken - A token that ensures idempotency. This token expires in 10 minutes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • environmentId

      CreateKxClusterRequest.Builder environmentId(String environmentId)

      A unique identifier for the kdb environment.

      Parameters:
      environmentId - A unique identifier for the kdb environment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clusterName

      CreateKxClusterRequest.Builder clusterName(String clusterName)

      A unique name for the cluster that you want to create.

      Parameters:
      clusterName - A unique name for the cluster that you want to create.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clusterType

      CreateKxClusterRequest.Builder clusterType(String clusterType)

      Specifies the type of KDB database that is being created. The following types are available:

      • HDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster.

      • RDB – A Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the savedownStorageConfiguration parameter.

      • GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.

      • GP – A general purpose cluster allows you to quickly iterate on code during development by granting greater access to system commands and enabling a fast reload of custom code. This cluster type can optionally mount databases including cache and savedown storage. For this cluster type, the node count is fixed at 1. It does not support autoscaling and supports only SINGLE AZ mode.

      • Tickerplant – A tickerplant cluster allows you to subscribe to feed handlers based on IAM permissions. It can publish to RDBs, other Tickerplants, and real-time subscribers (RTS). Tickerplants can persist messages to log, which is readable by any RDB environment. It supports only single-node that is only one kdb process.

      Parameters:
      clusterType - Specifies the type of KDB database that is being created. The following types are available:

      • HDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster.

      • RDB – A Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the savedownStorageConfiguration parameter.

      • GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.

      • GP – A general purpose cluster allows you to quickly iterate on code during development by granting greater access to system commands and enabling a fast reload of custom code. This cluster type can optionally mount databases including cache and savedown storage. For this cluster type, the node count is fixed at 1. It does not support autoscaling and supports only SINGLE AZ mode.

      • Tickerplant – A tickerplant cluster allows you to subscribe to feed handlers based on IAM permissions. It can publish to RDBs, other Tickerplants, and real-time subscribers (RTS). Tickerplants can persist messages to log, which is readable by any RDB environment. It supports only single-node that is only one kdb process.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • clusterType

      CreateKxClusterRequest.Builder clusterType(KxClusterType clusterType)

      Specifies the type of KDB database that is being created. The following types are available:

      • HDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster.

      • RDB – A Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the savedownStorageConfiguration parameter.

      • GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.

      • GP – A general purpose cluster allows you to quickly iterate on code during development by granting greater access to system commands and enabling a fast reload of custom code. This cluster type can optionally mount databases including cache and savedown storage. For this cluster type, the node count is fixed at 1. It does not support autoscaling and supports only SINGLE AZ mode.

      • Tickerplant – A tickerplant cluster allows you to subscribe to feed handlers based on IAM permissions. It can publish to RDBs, other Tickerplants, and real-time subscribers (RTS). Tickerplants can persist messages to log, which is readable by any RDB environment. It supports only single-node that is only one kdb process.

      Parameters:
      clusterType - Specifies the type of KDB database that is being created. The following types are available:

      • HDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster.

      • RDB – A Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the savedownStorageConfiguration parameter.

      • GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.

      • GP – A general purpose cluster allows you to quickly iterate on code during development by granting greater access to system commands and enabling a fast reload of custom code. This cluster type can optionally mount databases including cache and savedown storage. For this cluster type, the node count is fixed at 1. It does not support autoscaling and supports only SINGLE AZ mode.

      • Tickerplant – A tickerplant cluster allows you to subscribe to feed handlers based on IAM permissions. It can publish to RDBs, other Tickerplants, and real-time subscribers (RTS). Tickerplants can persist messages to log, which is readable by any RDB environment. It supports only single-node that is only one kdb process.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tickerplantLogConfiguration

      CreateKxClusterRequest.Builder tickerplantLogConfiguration(TickerplantLogConfiguration tickerplantLogConfiguration)

      A configuration to store Tickerplant logs. It consists of a list of volumes that will be mounted to your cluster. For the cluster type Tickerplant, the location of the TP volume on the cluster will be available by using the global variable .aws.tp_log_path.

      Parameters:
      tickerplantLogConfiguration - A configuration to store Tickerplant logs. It consists of a list of volumes that will be mounted to your cluster. For the cluster type Tickerplant, the location of the TP volume on the cluster will be available by using the global variable .aws.tp_log_path.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tickerplantLogConfiguration

      default CreateKxClusterRequest.Builder tickerplantLogConfiguration(Consumer<TickerplantLogConfiguration.Builder> tickerplantLogConfiguration)

      A configuration to store Tickerplant logs. It consists of a list of volumes that will be mounted to your cluster. For the cluster type Tickerplant, the location of the TP volume on the cluster will be available by using the global variable .aws.tp_log_path.

      This is a convenience method that creates an instance of the TickerplantLogConfiguration.Builder avoiding the need to create one manually via TickerplantLogConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tickerplantLogConfiguration(TickerplantLogConfiguration).

      Parameters:
      tickerplantLogConfiguration - a consumer that will call methods on TickerplantLogConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • databases

      CreateKxClusterRequest.Builder databases(Collection<KxDatabaseConfiguration> databases)

      A list of databases that will be available for querying.

      Parameters:
      databases - A list of databases that will be available for querying.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • databases

      CreateKxClusterRequest.Builder databases(KxDatabaseConfiguration... databases)

      A list of databases that will be available for querying.

      Parameters:
      databases - A list of databases that will be available for querying.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • databases

      CreateKxClusterRequest.Builder databases(Consumer<KxDatabaseConfiguration.Builder>... databases)

      A list of databases that will be available for querying.

      This is a convenience method that creates an instance of the KxDatabaseConfiguration.Builder avoiding the need to create one manually via KxDatabaseConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to databases(List<KxDatabaseConfiguration>).

      Parameters:
      databases - a consumer that will call methods on KxDatabaseConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • cacheStorageConfigurations

      CreateKxClusterRequest.Builder cacheStorageConfigurations(Collection<KxCacheStorageConfiguration> cacheStorageConfigurations)

      The configurations for a read only cache storage associated with a cluster. This cache will be stored as an FSx Lustre that reads from the S3 store.

      Parameters:
      cacheStorageConfigurations - The configurations for a read only cache storage associated with a cluster. This cache will be stored as an FSx Lustre that reads from the S3 store.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • cacheStorageConfigurations

      CreateKxClusterRequest.Builder cacheStorageConfigurations(KxCacheStorageConfiguration... cacheStorageConfigurations)

      The configurations for a read only cache storage associated with a cluster. This cache will be stored as an FSx Lustre that reads from the S3 store.

      Parameters:
      cacheStorageConfigurations - The configurations for a read only cache storage associated with a cluster. This cache will be stored as an FSx Lustre that reads from the S3 store.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • cacheStorageConfigurations

      CreateKxClusterRequest.Builder cacheStorageConfigurations(Consumer<KxCacheStorageConfiguration.Builder>... cacheStorageConfigurations)

      The configurations for a read only cache storage associated with a cluster. This cache will be stored as an FSx Lustre that reads from the S3 store.

      This is a convenience method that creates an instance of the KxCacheStorageConfiguration.Builder avoiding the need to create one manually via KxCacheStorageConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to cacheStorageConfigurations(List<KxCacheStorageConfiguration>).

      Parameters:
      cacheStorageConfigurations - a consumer that will call methods on KxCacheStorageConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • autoScalingConfiguration

      CreateKxClusterRequest.Builder autoScalingConfiguration(AutoScalingConfiguration autoScalingConfiguration)

      The configuration based on which FinSpace will scale in or scale out nodes in your cluster.

      Parameters:
      autoScalingConfiguration - The configuration based on which FinSpace will scale in or scale out nodes in your cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • autoScalingConfiguration

      default CreateKxClusterRequest.Builder autoScalingConfiguration(Consumer<AutoScalingConfiguration.Builder> autoScalingConfiguration)

      The configuration based on which FinSpace will scale in or scale out nodes in your cluster.

      This is a convenience method that creates an instance of the AutoScalingConfiguration.Builder avoiding the need to create one manually via AutoScalingConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to autoScalingConfiguration(AutoScalingConfiguration).

      Parameters:
      autoScalingConfiguration - a consumer that will call methods on AutoScalingConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • clusterDescription

      CreateKxClusterRequest.Builder clusterDescription(String clusterDescription)

      A description of the cluster.

      Parameters:
      clusterDescription - A description of the cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • capacityConfiguration

      CreateKxClusterRequest.Builder capacityConfiguration(CapacityConfiguration capacityConfiguration)

      A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.

      Parameters:
      capacityConfiguration - A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • capacityConfiguration

      default CreateKxClusterRequest.Builder capacityConfiguration(Consumer<CapacityConfiguration.Builder> capacityConfiguration)

      A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.

      This is a convenience method that creates an instance of the CapacityConfiguration.Builder avoiding the need to create one manually via CapacityConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to capacityConfiguration(CapacityConfiguration).

      Parameters:
      capacityConfiguration - a consumer that will call methods on CapacityConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • releaseLabel

      CreateKxClusterRequest.Builder releaseLabel(String releaseLabel)

      The version of FinSpace managed kdb to run.

      Parameters:
      releaseLabel - The version of FinSpace managed kdb to run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vpcConfiguration

      CreateKxClusterRequest.Builder vpcConfiguration(VpcConfiguration vpcConfiguration)

      Configuration details about the network where the Privatelink endpoint of the cluster resides.

      Parameters:
      vpcConfiguration - Configuration details about the network where the Privatelink endpoint of the cluster resides.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vpcConfiguration

      default CreateKxClusterRequest.Builder vpcConfiguration(Consumer<VpcConfiguration.Builder> vpcConfiguration)

      Configuration details about the network where the Privatelink endpoint of the cluster resides.

      This is a convenience method that creates an instance of the VpcConfiguration.Builder avoiding the need to create one manually via VpcConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to vpcConfiguration(VpcConfiguration).

      Parameters:
      vpcConfiguration - a consumer that will call methods on VpcConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • initializationScript

      CreateKxClusterRequest.Builder initializationScript(String 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • commandLineArguments

      CreateKxClusterRequest.Builder commandLineArguments(Collection<KxCommandLineArgument> commandLineArguments)

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

      Parameters:
      commandLineArguments - Defines the key-value pairs to make them available inside the cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • commandLineArguments

      CreateKxClusterRequest.Builder commandLineArguments(KxCommandLineArgument... commandLineArguments)

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

      Parameters:
      commandLineArguments - Defines the key-value pairs to make them available inside the cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • commandLineArguments

      CreateKxClusterRequest.Builder commandLineArguments(Consumer<KxCommandLineArgument.Builder>... commandLineArguments)

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

      This is a convenience method that creates an instance of the KxCommandLineArgument.Builder avoiding the need to create one manually via KxCommandLineArgument.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to commandLineArguments(List<KxCommandLineArgument>).

      Parameters:
      commandLineArguments - a consumer that will call methods on KxCommandLineArgument.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • code

      CreateKxClusterRequest.Builder code(CodeConfiguration code)

      The details of the custom code that you want to use inside a cluster when analyzing a data. It consists of the S3 source bucket, location, S3 object version, and the relative path from where the custom code is loaded into the cluster.

      Parameters:
      code - The details of the custom code that you want to use inside a cluster when analyzing a data. It consists of the S3 source bucket, location, S3 object version, and the relative path from where the custom code is loaded into the cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • code

      default CreateKxClusterRequest.Builder code(Consumer<CodeConfiguration.Builder> code)

      The details of the custom code that you want to use inside a cluster when analyzing a data. It consists of the S3 source bucket, location, S3 object version, and the relative path from where the custom code is loaded into the cluster.

      This is a convenience method that creates an instance of the CodeConfiguration.Builder avoiding the need to create one manually via CodeConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to code(CodeConfiguration).

      Parameters:
      code - a consumer that will call methods on CodeConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • executionRole

      CreateKxClusterRequest.Builder executionRole(String executionRole)

      An IAM role that defines a set of permissions associated with a cluster. These permissions are assumed when a cluster attempts to access another cluster.

      Parameters:
      executionRole - An IAM role that defines a set of permissions associated with a cluster. These permissions are assumed when a cluster attempts to access another cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • savedownStorageConfiguration

      CreateKxClusterRequest.Builder savedownStorageConfiguration(KxSavedownStorageConfiguration savedownStorageConfiguration)

      The size and type of the temporary storage that is used to hold data during the savedown process. This parameter is required when you choose clusterType as RDB. All the data written to this storage space is lost when the cluster node is restarted.

      Parameters:
      savedownStorageConfiguration - The size and type of the temporary storage that is used to hold data during the savedown process. This parameter is required when you choose clusterType as RDB. All the data written to this storage space is lost when the cluster node is restarted.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • savedownStorageConfiguration

      default CreateKxClusterRequest.Builder savedownStorageConfiguration(Consumer<KxSavedownStorageConfiguration.Builder> savedownStorageConfiguration)

      The size and type of the temporary storage that is used to hold data during the savedown process. This parameter is required when you choose clusterType as RDB. All the data written to this storage space is lost when the cluster node is restarted.

      This is a convenience method that creates an instance of the KxSavedownStorageConfiguration.Builder avoiding the need to create one manually via KxSavedownStorageConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to savedownStorageConfiguration(KxSavedownStorageConfiguration).

      Parameters:
      savedownStorageConfiguration - a consumer that will call methods on KxSavedownStorageConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • azMode

      CreateKxClusterRequest.Builder azMode(String azMode)

      The number of availability zones you want to assign per cluster. This can be one of the following

      • SINGLE – Assigns one availability zone per cluster.

      • MULTI – Assigns all the availability zones per cluster.

      Parameters:
      azMode - The number of availability zones you want to assign per cluster. This can be one of the following

      • SINGLE – Assigns one availability zone per cluster.

      • MULTI – Assigns all the availability zones per cluster.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • azMode

      CreateKxClusterRequest.Builder azMode(KxAzMode azMode)

      The number of availability zones you want to assign per cluster. This can be one of the following

      • SINGLE – Assigns one availability zone per cluster.

      • MULTI – Assigns all the availability zones per cluster.

      Parameters:
      azMode - The number of availability zones you want to assign per cluster. This can be one of the following

      • SINGLE – Assigns one availability zone per cluster.

      • MULTI – Assigns all the availability zones per cluster.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • availabilityZoneId

      CreateKxClusterRequest.Builder availabilityZoneId(String availabilityZoneId)

      The availability zone identifiers for the requested regions.

      Parameters:
      availabilityZoneId - The availability zone identifiers for the requested regions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateKxClusterRequest.Builder tags(Map<String,String> tags)

      A list of key-value pairs to label the cluster. You can add up to 50 tags to a cluster.

      Parameters:
      tags - A list of key-value pairs to label the cluster. You can add up to 50 tags to a cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scalingGroupConfiguration

      CreateKxClusterRequest.Builder scalingGroupConfiguration(KxScalingGroupConfiguration scalingGroupConfiguration)

      The structure that stores the configuration details of a scaling group.

      Parameters:
      scalingGroupConfiguration - The structure that stores the configuration details of a scaling group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scalingGroupConfiguration

      default CreateKxClusterRequest.Builder scalingGroupConfiguration(Consumer<KxScalingGroupConfiguration.Builder> scalingGroupConfiguration)

      The structure that stores the configuration details of a scaling group.

      This is a convenience method that creates an instance of the KxScalingGroupConfiguration.Builder avoiding the need to create one manually via KxScalingGroupConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to scalingGroupConfiguration(KxScalingGroupConfiguration).

      Parameters:
      scalingGroupConfiguration - a consumer that will call methods on KxScalingGroupConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      CreateKxClusterRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateKxClusterRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.