1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
/// Constructs a fluent builder for the [`CreateKxCluster`](crate::operation::create_kx_cluster::builders::CreateKxClusterFluentBuilder) operation.
///
/// - The fluent builder is configurable:
/// - [`client_token(impl Into<String>)`](crate::operation::create_kx_cluster::builders::CreateKxClusterFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::create_kx_cluster::builders::CreateKxClusterFluentBuilder::set_client_token):<br>required: **false**<br><p>A token that ensures idempotency. This token expires in 10 minutes.</p><br>
/// - [`environment_id(impl Into<String>)`](crate::operation::create_kx_cluster::builders::CreateKxClusterFluentBuilder::environment_id) / [`set_environment_id(Option<String>)`](crate::operation::create_kx_cluster::builders::CreateKxClusterFluentBuilder::set_environment_id):<br>required: **true**<br><p>A unique identifier for the kdb environment.</p><br>
/// - [`cluster_name(impl Into<String>)`](crate::operation::create_kx_cluster::builders::CreateKxClusterFluentBuilder::cluster_name) / [`set_cluster_name(Option<String>)`](crate::operation::create_kx_cluster::builders::CreateKxClusterFluentBuilder::set_cluster_name):<br>required: **true**<br><p>A unique name for the cluster that you want to create.</p><br>
/// - [`cluster_type(KxClusterType)`](crate::operation::create_kx_cluster::builders::CreateKxClusterFluentBuilder::cluster_type) / [`set_cluster_type(Option<KxClusterType>)`](crate::operation::create_kx_cluster::builders::CreateKxClusterFluentBuilder::set_cluster_type):<br>required: **true**<br><p>Specifies the type of KDB database that is being created. The following types are available: </p> <ul> <li> <p>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.</p> </li> <li> <p>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 <code>savedownStorageConfiguration</code> parameter.</p> </li> <li> <p>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.</p> </li> </ul><br>
/// - [`databases(KxDatabaseConfiguration)`](crate::operation::create_kx_cluster::builders::CreateKxClusterFluentBuilder::databases) / [`set_databases(Option<Vec::<KxDatabaseConfiguration>>)`](crate::operation::create_kx_cluster::builders::CreateKxClusterFluentBuilder::set_databases):<br>required: **false**<br><p>A list of databases that will be available for querying.</p><br>
/// - [`cache_storage_configurations(KxCacheStorageConfiguration)`](crate::operation::create_kx_cluster::builders::CreateKxClusterFluentBuilder::cache_storage_configurations) / [`set_cache_storage_configurations(Option<Vec::<KxCacheStorageConfiguration>>)`](crate::operation::create_kx_cluster::builders::CreateKxClusterFluentBuilder::set_cache_storage_configurations):<br>required: **false**<br><p>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. </p><br>
/// - [`auto_scaling_configuration(AutoScalingConfiguration)`](crate::operation::create_kx_cluster::builders::CreateKxClusterFluentBuilder::auto_scaling_configuration) / [`set_auto_scaling_configuration(Option<AutoScalingConfiguration>)`](crate::operation::create_kx_cluster::builders::CreateKxClusterFluentBuilder::set_auto_scaling_configuration):<br>required: **false**<br><p>The configuration based on which FinSpace will scale in or scale out nodes in your cluster.</p><br>
/// - [`cluster_description(impl Into<String>)`](crate::operation::create_kx_cluster::builders::CreateKxClusterFluentBuilder::cluster_description) / [`set_cluster_description(Option<String>)`](crate::operation::create_kx_cluster::builders::CreateKxClusterFluentBuilder::set_cluster_description):<br>required: **false**<br><p>A description of the cluster.</p><br>
/// - [`capacity_configuration(CapacityConfiguration)`](crate::operation::create_kx_cluster::builders::CreateKxClusterFluentBuilder::capacity_configuration) / [`set_capacity_configuration(Option<CapacityConfiguration>)`](crate::operation::create_kx_cluster::builders::CreateKxClusterFluentBuilder::set_capacity_configuration):<br>required: **true**<br><p>A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.</p><br>
/// - [`release_label(impl Into<String>)`](crate::operation::create_kx_cluster::builders::CreateKxClusterFluentBuilder::release_label) / [`set_release_label(Option<String>)`](crate::operation::create_kx_cluster::builders::CreateKxClusterFluentBuilder::set_release_label):<br>required: **true**<br><p>The version of FinSpace managed kdb to run.</p><br>
/// - [`vpc_configuration(VpcConfiguration)`](crate::operation::create_kx_cluster::builders::CreateKxClusterFluentBuilder::vpc_configuration) / [`set_vpc_configuration(Option<VpcConfiguration>)`](crate::operation::create_kx_cluster::builders::CreateKxClusterFluentBuilder::set_vpc_configuration):<br>required: **false**<br><p>Configuration details about the network where the Privatelink endpoint of the cluster resides.</p><br>
/// - [`initialization_script(impl Into<String>)`](crate::operation::create_kx_cluster::builders::CreateKxClusterFluentBuilder::initialization_script) / [`set_initialization_script(Option<String>)`](crate::operation::create_kx_cluster::builders::CreateKxClusterFluentBuilder::set_initialization_script):<br>required: **false**<br><p>Specifies a Q program that will be run at launch of a cluster. It is a relative path within <i>.zip</i> file that contains the custom code, which will be loaded on the cluster. It must include the file name itself. For example, <code>somedir/init.q</code>.</p><br>
/// - [`command_line_arguments(KxCommandLineArgument)`](crate::operation::create_kx_cluster::builders::CreateKxClusterFluentBuilder::command_line_arguments) / [`set_command_line_arguments(Option<Vec::<KxCommandLineArgument>>)`](crate::operation::create_kx_cluster::builders::CreateKxClusterFluentBuilder::set_command_line_arguments):<br>required: **false**<br><p>Defines the key-value pairs to make them available inside the cluster.</p><br>
/// - [`code(CodeConfiguration)`](crate::operation::create_kx_cluster::builders::CreateKxClusterFluentBuilder::code) / [`set_code(Option<CodeConfiguration>)`](crate::operation::create_kx_cluster::builders::CreateKxClusterFluentBuilder::set_code):<br>required: **false**<br><p>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. </p><br>
/// - [`execution_role(impl Into<String>)`](crate::operation::create_kx_cluster::builders::CreateKxClusterFluentBuilder::execution_role) / [`set_execution_role(Option<String>)`](crate::operation::create_kx_cluster::builders::CreateKxClusterFluentBuilder::set_execution_role):<br>required: **false**<br><p>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.</p><br>
/// - [`savedown_storage_configuration(KxSavedownStorageConfiguration)`](crate::operation::create_kx_cluster::builders::CreateKxClusterFluentBuilder::savedown_storage_configuration) / [`set_savedown_storage_configuration(Option<KxSavedownStorageConfiguration>)`](crate::operation::create_kx_cluster::builders::CreateKxClusterFluentBuilder::set_savedown_storage_configuration):<br>required: **false**<br><p>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 <code>clusterType</code> as RDB. All the data written to this storage space is lost when the cluster node is restarted.</p><br>
/// - [`az_mode(KxAzMode)`](crate::operation::create_kx_cluster::builders::CreateKxClusterFluentBuilder::az_mode) / [`set_az_mode(Option<KxAzMode>)`](crate::operation::create_kx_cluster::builders::CreateKxClusterFluentBuilder::set_az_mode):<br>required: **true**<br><p>The number of availability zones you want to assign per cluster. This can be one of the following </p> <ul> <li> <p> <code>SINGLE</code> – Assigns one availability zone per cluster.</p> </li> <li> <p> <code>MULTI</code> – Assigns all the availability zones per cluster.</p> </li> </ul><br>
/// - [`availability_zone_id(impl Into<String>)`](crate::operation::create_kx_cluster::builders::CreateKxClusterFluentBuilder::availability_zone_id) / [`set_availability_zone_id(Option<String>)`](crate::operation::create_kx_cluster::builders::CreateKxClusterFluentBuilder::set_availability_zone_id):<br>required: **false**<br><p>The availability zone identifiers for the requested regions.</p><br>
/// - [`tags(impl Into<String>, impl Into<String>)`](crate::operation::create_kx_cluster::builders::CreateKxClusterFluentBuilder::tags) / [`set_tags(Option<HashMap::<String, String>>)`](crate::operation::create_kx_cluster::builders::CreateKxClusterFluentBuilder::set_tags):<br>required: **false**<br><p>A list of key-value pairs to label the cluster. You can add up to 50 tags to a cluster.</p><br>
/// - On success, responds with [`CreateKxClusterOutput`](crate::operation::create_kx_cluster::CreateKxClusterOutput) with field(s):
/// - [`environment_id(Option<String>)`](crate::operation::create_kx_cluster::CreateKxClusterOutput::environment_id): <p>A unique identifier for the kdb environment.</p>
/// - [`status(Option<KxClusterStatus>)`](crate::operation::create_kx_cluster::CreateKxClusterOutput::status): <p>The status of cluster creation.</p> <ul> <li> <p>PENDING – The cluster is pending creation.</p> </li> <li> <p>CREATING – The cluster creation process is in progress.</p> </li> <li> <p>CREATE_FAILED – The cluster creation process has failed.</p> </li> <li> <p>RUNNING – The cluster creation process is running.</p> </li> <li> <p>UPDATING – The cluster is in the process of being updated.</p> </li> <li> <p>DELETING – The cluster is in the process of being deleted.</p> </li> <li> <p>DELETED – The cluster has been deleted.</p> </li> <li> <p>DELETE_FAILED – The cluster failed to delete.</p> </li> </ul>
/// - [`status_reason(Option<String>)`](crate::operation::create_kx_cluster::CreateKxClusterOutput::status_reason): <p>The error message when a failed state occurs. </p>
/// - [`cluster_name(Option<String>)`](crate::operation::create_kx_cluster::CreateKxClusterOutput::cluster_name): <p>A unique name for the cluster.</p>
/// - [`cluster_type(Option<KxClusterType>)`](crate::operation::create_kx_cluster::CreateKxClusterOutput::cluster_type): <p>Specifies the type of KDB database that is being created. The following types are available: </p> <ul> <li> <p>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.</p> </li> <li> <p>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 <code>savedownStorageConfiguration</code> parameter.</p> </li> <li> <p>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.</p> </li> </ul>
/// - [`databases(Option<Vec::<KxDatabaseConfiguration>>)`](crate::operation::create_kx_cluster::CreateKxClusterOutput::databases): <p>A list of databases that will be available for querying.</p>
/// - [`cache_storage_configurations(Option<Vec::<KxCacheStorageConfiguration>>)`](crate::operation::create_kx_cluster::CreateKxClusterOutput::cache_storage_configurations): <p>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. </p>
/// - [`auto_scaling_configuration(Option<AutoScalingConfiguration>)`](crate::operation::create_kx_cluster::CreateKxClusterOutput::auto_scaling_configuration): <p>The configuration based on which FinSpace will scale in or scale out nodes in your cluster.</p>
/// - [`cluster_description(Option<String>)`](crate::operation::create_kx_cluster::CreateKxClusterOutput::cluster_description): <p>A description of the cluster.</p>
/// - [`capacity_configuration(Option<CapacityConfiguration>)`](crate::operation::create_kx_cluster::CreateKxClusterOutput::capacity_configuration): <p>A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.</p>
/// - [`release_label(Option<String>)`](crate::operation::create_kx_cluster::CreateKxClusterOutput::release_label): <p>A version of the FinSpace managed kdb to run.</p>
/// - [`vpc_configuration(Option<VpcConfiguration>)`](crate::operation::create_kx_cluster::CreateKxClusterOutput::vpc_configuration): <p>Configuration details about the network where the Privatelink endpoint of the cluster resides.</p>
/// - [`initialization_script(Option<String>)`](crate::operation::create_kx_cluster::CreateKxClusterOutput::initialization_script): <p>Specifies a Q program that will be run at launch of a cluster. It is a relative path within <i>.zip</i> file that contains the custom code, which will be loaded on the cluster. It must include the file name itself. For example, <code>somedir/init.q</code>.</p>
/// - [`command_line_arguments(Option<Vec::<KxCommandLineArgument>>)`](crate::operation::create_kx_cluster::CreateKxClusterOutput::command_line_arguments): <p>Defines the key-value pairs to make them available inside the cluster.</p>
/// - [`code(Option<CodeConfiguration>)`](crate::operation::create_kx_cluster::CreateKxClusterOutput::code): <p>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. </p>
/// - [`execution_role(Option<String>)`](crate::operation::create_kx_cluster::CreateKxClusterOutput::execution_role): <p> 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. </p>
/// - [`last_modified_timestamp(Option<DateTime>)`](crate::operation::create_kx_cluster::CreateKxClusterOutput::last_modified_timestamp): <p>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.</p>
/// - [`savedown_storage_configuration(Option<KxSavedownStorageConfiguration>)`](crate::operation::create_kx_cluster::CreateKxClusterOutput::savedown_storage_configuration): <p>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 <code>clusterType</code> as RDB. All the data written to this storage space is lost when the cluster node is restarted.</p>
/// - [`az_mode(Option<KxAzMode>)`](crate::operation::create_kx_cluster::CreateKxClusterOutput::az_mode): <p>The number of availability zones you want to assign per cluster. This can be one of the following </p> <ul> <li> <p> <code>SINGLE</code> – Assigns one availability zone per cluster.</p> </li> <li> <p> <code>MULTI</code> – Assigns all the availability zones per cluster.</p> </li> </ul>
/// - [`availability_zone_id(Option<String>)`](crate::operation::create_kx_cluster::CreateKxClusterOutput::availability_zone_id): <p> The availability zone identifiers for the requested regions. </p>
/// - [`created_timestamp(Option<DateTime>)`](crate::operation::create_kx_cluster::CreateKxClusterOutput::created_timestamp): <p>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.</p>
/// - On failure, responds with [`SdkError<CreateKxClusterError>`](crate::operation::create_kx_cluster::CreateKxClusterError)
pub fn create_kx_cluster(&self) -> crate::operation::create_kx_cluster::builders::CreateKxClusterFluentBuilder {
crate::operation::create_kx_cluster::builders::CreateKxClusterFluentBuilder::new(self.handle.clone())
}
}