Struct aws_sdk_finspace::operation::create_kx_cluster::builders::CreateKxClusterOutputBuilder

#[non_exhaustive]
pub struct CreateKxClusterOutputBuilder { /* private fields */ }

A builder for CreateKxClusterOutput.

Implementations

impl CreateKxClusterOutputBuilder

pub fn environment_id(self, input: impl Into<String>) -> Self

A unique identifier for the kdb environment.

pub fn set_environment_id(self, input: Option<String>) -> Self

A unique identifier for the kdb environment.

pub fn get_environment_id(&self) -> &Option<String>

A unique identifier for the kdb environment.

pub fn status(self, input: KxClusterStatus) -> Self

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.

pub fn set_status(self, input: Option<KxClusterStatus>) -> Self

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.

pub fn get_status(&self) -> &Option<KxClusterStatus>

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.

pub fn status_reason(self, input: impl Into<String>) -> Self

The error message when a failed state occurs.

pub fn set_status_reason(self, input: Option<String>) -> Self

The error message when a failed state occurs.

pub fn get_status_reason(&self) -> &Option<String>

The error message when a failed state occurs.

pub fn cluster_name(self, input: impl Into<String>) -> Self

A unique name for the cluster.

pub fn set_cluster_name(self, input: Option<String>) -> Self

A unique name for the cluster.

pub fn get_cluster_name(&self) -> &Option<String>

A unique name for the cluster.

pub fn cluster_type(self, input: KxClusterType) -> Self

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.

pub fn set_cluster_type(self, input: Option<KxClusterType>) -> Self

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.

pub fn get_cluster_type(&self) -> &Option<KxClusterType>

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.

pub fn databases(self, input: KxDatabaseConfiguration) -> Self

Appends an item to databases.

To override the contents of this collection use set_databases.

A list of databases that will be available for querying.

pub fn set_databases(self, input: Option<Vec<KxDatabaseConfiguration>>) -> Self

A list of databases that will be available for querying.

pub fn get_databases(&self) -> &Option<Vec<KxDatabaseConfiguration>>

A list of databases that will be available for querying.

pub fn cache_storage_configurations( self, input: KxCacheStorageConfiguration ) -> Self

Appends an item to cache_storage_configurations.

To override the contents of this collection use set_cache_storage_configurations.

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.

pub fn set_cache_storage_configurations( self, input: Option<Vec<KxCacheStorageConfiguration>> ) -> Self

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.

pub fn get_cache_storage_configurations( &self ) -> &Option<Vec<KxCacheStorageConfiguration>>

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.

pub fn auto_scaling_configuration(self, input: AutoScalingConfiguration) -> Self

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

pub fn set_auto_scaling_configuration( self, input: Option<AutoScalingConfiguration> ) -> Self

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

pub fn get_auto_scaling_configuration( &self ) -> &Option<AutoScalingConfiguration>

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

pub fn cluster_description(self, input: impl Into<String>) -> Self

A description of the cluster.

pub fn set_cluster_description(self, input: Option<String>) -> Self

A description of the cluster.

pub fn get_cluster_description(&self) -> &Option<String>

A description of the cluster.

pub fn capacity_configuration(self, input: CapacityConfiguration) -> Self

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

pub fn set_capacity_configuration( self, input: Option<CapacityConfiguration> ) -> Self

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

pub fn get_capacity_configuration(&self) -> &Option<CapacityConfiguration>

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

pub fn release_label(self, input: impl Into<String>) -> Self

A version of the FinSpace managed kdb to run.

pub fn set_release_label(self, input: Option<String>) -> Self

A version of the FinSpace managed kdb to run.

pub fn get_release_label(&self) -> &Option<String>

A version of the FinSpace managed kdb to run.

pub fn vpc_configuration(self, input: VpcConfiguration) -> Self

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

pub fn set_vpc_configuration(self, input: Option<VpcConfiguration>) -> Self

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

pub fn get_vpc_configuration(&self) -> &Option<VpcConfiguration>

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

pub fn initialization_script(self, input: impl Into<String>) -> Self

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.

pub fn set_initialization_script(self, input: Option<String>) -> Self

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.

pub fn get_initialization_script(&self) -> &Option<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.

pub fn command_line_arguments(self, input: KxCommandLineArgument) -> Self

Appends an item to command_line_arguments.

To override the contents of this collection use set_command_line_arguments.

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

pub fn set_command_line_arguments( self, input: Option<Vec<KxCommandLineArgument>> ) -> Self

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

pub fn get_command_line_arguments(&self) -> &Option<Vec<KxCommandLineArgument>>

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

pub fn code(self, input: CodeConfiguration) -> Self

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.

pub fn set_code(self, input: Option<CodeConfiguration>) -> Self

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.

pub fn get_code(&self) -> &Option<CodeConfiguration>

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.

pub fn execution_role(self, input: impl Into<String>) -> Self

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.

pub fn set_execution_role(self, input: Option<String>) -> Self

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.

pub fn get_execution_role(&self) -> &Option<String>

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.

pub fn last_modified_timestamp(self, input: DateTime) -> Self

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.

pub fn set_last_modified_timestamp(self, input: Option<DateTime>) -> Self

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.

pub fn get_last_modified_timestamp(&self) -> &Option<DateTime>

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.

pub fn savedown_storage_configuration( self, input: KxSavedownStorageConfiguration ) -> Self

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.

pub fn set_savedown_storage_configuration( self, input: Option<KxSavedownStorageConfiguration> ) -> Self

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.

pub fn get_savedown_storage_configuration( &self ) -> &Option<KxSavedownStorageConfiguration>

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.

pub fn az_mode(self, input: KxAzMode) -> Self

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.

pub fn set_az_mode(self, input: Option<KxAzMode>) -> Self

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.

pub fn get_az_mode(&self) -> &Option<KxAzMode>

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.

pub fn availability_zone_id(self, input: impl Into<String>) -> Self

The availability zone identifiers for the requested regions.

pub fn set_availability_zone_id(self, input: Option<String>) -> Self

The availability zone identifiers for the requested regions.

pub fn get_availability_zone_id(&self) -> &Option<String>

The availability zone identifiers for the requested regions.

pub fn created_timestamp(self, input: DateTime) -> Self

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.

pub fn set_created_timestamp(self, input: Option<DateTime>) -> Self

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.

pub fn get_created_timestamp(&self) -> &Option<DateTime>

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.

pub fn build(self) -> CreateKxClusterOutput

Consumes the builder and constructs a CreateKxClusterOutput.

Trait Implementations

impl Clone for CreateKxClusterOutputBuilder

fn clone(&self) -> CreateKxClusterOutputBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateKxClusterOutputBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CreateKxClusterOutputBuilder

fn default() -> CreateKxClusterOutputBuilder

Returns the “default value” for a type.

impl PartialEq for CreateKxClusterOutputBuilder

fn eq(&self, other: &CreateKxClusterOutputBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateKxClusterOutputBuilder