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

Interface CreateKxClusterResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<CreateKxClusterResponse.Builder,CreateKxClusterResponse>, FinspaceResponse.Builder, SdkBuilder<CreateKxClusterResponse.Builder,CreateKxClusterResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
CreateKxClusterResponse
public static interface CreateKxClusterResponse.Builder extends FinspaceResponse.Builder, SdkPojo, CopyableBuilder<CreateKxClusterResponse.Builder,CreateKxClusterResponse>

  • Method Details

    • environmentId

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

    • status

      CreateKxClusterResponse.Builder status(String status)

      The status of cluster creation.

      • PENDING – The cluster is pending creation.

      • CREATING – The cluster creation process is in progress.

      • CREATE_FAILED – The cluster creation process has failed.

      • RUNNING – The cluster creation process is running.

      • UPDATING – The cluster is in the process of being updated.

      • DELETING – The cluster is in the process of being deleted.

      • DELETED – The cluster has been deleted.

      • DELETE_FAILED – The cluster failed to delete.

      Parameters:
      status - The status of cluster creation.

      • PENDING – The cluster is pending creation.

      • CREATING – The cluster creation process is in progress.

      • CREATE_FAILED – The cluster creation process has failed.

      • RUNNING – The cluster creation process is running.

      • UPDATING – The cluster is in the process of being updated.

      • DELETING – The cluster is in the process of being deleted.

      • DELETED – The cluster has been deleted.

      • DELETE_FAILED – The cluster failed to delete.

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

    • status

      CreateKxClusterResponse.Builder status(KxClusterStatus status)

      The status of cluster creation.

      • PENDING – The cluster is pending creation.

      • CREATING – The cluster creation process is in progress.

      • CREATE_FAILED – The cluster creation process has failed.

      • RUNNING – The cluster creation process is running.

      • UPDATING – The cluster is in the process of being updated.

      • DELETING – The cluster is in the process of being deleted.

      • DELETED – The cluster has been deleted.

      • DELETE_FAILED – The cluster failed to delete.

      Parameters:
      status - The status of cluster creation.

      • PENDING – The cluster is pending creation.

      • CREATING – The cluster creation process is in progress.

      • CREATE_FAILED – The cluster creation process has failed.

      • RUNNING – The cluster creation process is running.

      • UPDATING – The cluster is in the process of being updated.

      • DELETING – The cluster is in the process of being deleted.

      • DELETED – The cluster has been deleted.

      • DELETE_FAILED – The cluster failed to delete.

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

    • statusReason

      CreateKxClusterResponse.Builder statusReason(String statusReason)

      The error message when a failed state occurs.

      Parameters:
      statusReason - The error message when a failed state occurs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clusterName

      CreateKxClusterResponse.Builder clusterName(String clusterName)

      A unique name for the cluster.

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

    • clusterType

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

      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.

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

    • clusterType

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

      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.

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

    • databases

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

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

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

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

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

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

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

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

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

      CreateKxClusterResponse.Builder releaseLabel(String releaseLabel)

      A version of the FinSpace managed kdb to run.

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

    • vpcConfiguration

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

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

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

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

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

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

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

    • lastModifiedTimestamp

      CreateKxClusterResponse.Builder lastModifiedTimestamp(Instant lastModifiedTimestamp)

      The last time that the cluster was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

      Parameters:
      lastModifiedTimestamp - The last time that the cluster was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • savedownStorageConfiguration

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

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

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

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

    • createdTimestamp

      CreateKxClusterResponse.Builder createdTimestamp(Instant createdTimestamp)

      The timestamp at which the cluster was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

      Parameters:
      createdTimestamp - The timestamp at which the cluster was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
      Returns:
      Returns a reference to this object so that method calls can be chained together.