Struct CreateKxClusterOutput

#[non_exhaustive]
pub struct CreateKxClusterOutput {

    pub environment_id: Option<String>,
    pub status: Option<KxClusterStatus>,
    pub status_reason: Option<String>,
    pub cluster_name: Option<String>,
    pub cluster_type: Option<KxClusterType>,
    pub tickerplant_log_configuration: Option<TickerplantLogConfiguration>,
    pub volumes: Option<Vec<Volume>>,
    pub databases: Option<Vec<KxDatabaseConfiguration>>,
    pub cache_storage_configurations: Option<Vec<KxCacheStorageConfiguration>>,
    pub auto_scaling_configuration: Option<AutoScalingConfiguration>,
    pub cluster_description: Option<String>,
    pub capacity_configuration: Option<CapacityConfiguration>,
    pub release_label: Option<String>,
    pub vpc_configuration: Option<VpcConfiguration>,
    pub initialization_script: Option<String>,
    pub command_line_arguments: Option<Vec<KxCommandLineArgument>>,
    pub code: Option<CodeConfiguration>,
    pub execution_role: Option<String>,
    pub last_modified_timestamp: Option<DateTime>,
    pub savedown_storage_configuration: Option<KxSavedownStorageConfiguration>,
    pub az_mode: Option<KxAzMode>,
    pub availability_zone_id: Option<String>,
    pub created_timestamp: Option<DateTime>,
    pub scaling_group_configuration: Option<KxScalingGroupConfiguration>,
    /* private fields */
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

environment_id: Option<String>

A unique identifier for the kdb environment.

status: 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.

status_reason: Option<String>

The error message when a failed state occurs.

cluster_name: Option<String>

A unique name for the cluster.

cluster_type: 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.

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

tickerplant_log_configuration: Option<TickerplantLogConfiguration>

A configuration to store the 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.

volumes: Option<Vec<Volume>>

A list of volumes mounted on the cluster.

databases: Option<Vec<KxDatabaseConfiguration>>

A list of databases that will be available for querying.

cache_storage_configurations: 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.

auto_scaling_configuration: Option<AutoScalingConfiguration>

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

cluster_description: Option<String>

A description of the cluster.

capacity_configuration: Option<CapacityConfiguration>

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

release_label: Option<String>

A version of the FinSpace managed kdb to run.

vpc_configuration: Option<VpcConfiguration>

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

initialization_script: 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.

command_line_arguments: Option<Vec<KxCommandLineArgument>>

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

code: 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.

execution_role: 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.

last_modified_timestamp: 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.

savedown_storage_configuration: 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.

az_mode: 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.

availability_zone_id: Option<String>

The availability zone identifiers for the requested regions.

created_timestamp: 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.

scaling_group_configuration: Option<KxScalingGroupConfiguration>

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

Implementations

impl CreateKxClusterOutput

pub fn environment_id(&self) -> Option<&str>

A unique identifier for the kdb environment.

pub fn 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) -> Option<&str>

The error message when a failed state occurs.

pub fn cluster_name(&self) -> Option<&str>

A unique name for the cluster.

pub fn 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.

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

pub fn tickerplant_log_configuration( &self, ) -> Option<&TickerplantLogConfiguration>

A configuration to store the 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.

pub fn volumes(&self) -> &[Volume]

A list of volumes mounted on the cluster.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .volumes.is_none().

pub fn databases(&self) -> &[KxDatabaseConfiguration]

A list of databases that will be available for querying.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .databases.is_none().

pub fn cache_storage_configurations(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .cache_storage_configurations.is_none().

pub fn 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) -> Option<&str>

A description of the cluster.

pub fn 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) -> Option<&str>

A version of the FinSpace managed kdb to run.

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

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

pub fn initialization_script(&self) -> Option<&str>

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) -> &[KxCommandLineArgument]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .command_line_arguments.is_none().

pub fn 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) -> Option<&str>

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) -> 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, ) -> 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) -> 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) -> Option<&str>

The availability zone identifiers for the requested regions.

pub fn 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 scaling_group_configuration( &self, ) -> Option<&KxScalingGroupConfiguration>

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

impl CreateKxClusterOutput

pub fn builder() -> CreateKxClusterOutputBuilder

Creates a new builder-style object to manufacture CreateKxClusterOutput.

Trait Implementations

impl Clone for CreateKxClusterOutput

fn clone(&self) -> CreateKxClusterOutput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateKxClusterOutput

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

Formats the value using the given formatter.

impl PartialEq for CreateKxClusterOutput

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl RequestId for CreateKxClusterOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for CreateKxClusterOutput