aws_sdk_finspace/client/create_kx_scaling_group.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`CreateKxScalingGroup`](crate::operation::create_kx_scaling_group::builders::CreateKxScalingGroupFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`client_token(impl Into<String>)`](crate::operation::create_kx_scaling_group::builders::CreateKxScalingGroupFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::create_kx_scaling_group::builders::CreateKxScalingGroupFluentBuilder::set_client_token):<br>required: **true**<br><p>A token that ensures idempotency. This token expires in 10 minutes.</p><br>
7 /// - [`environment_id(impl Into<String>)`](crate::operation::create_kx_scaling_group::builders::CreateKxScalingGroupFluentBuilder::environment_id) / [`set_environment_id(Option<String>)`](crate::operation::create_kx_scaling_group::builders::CreateKxScalingGroupFluentBuilder::set_environment_id):<br>required: **true**<br><p>A unique identifier for the kdb environment, where you want to create the scaling group.</p><br>
8 /// - [`scaling_group_name(impl Into<String>)`](crate::operation::create_kx_scaling_group::builders::CreateKxScalingGroupFluentBuilder::scaling_group_name) / [`set_scaling_group_name(Option<String>)`](crate::operation::create_kx_scaling_group::builders::CreateKxScalingGroupFluentBuilder::set_scaling_group_name):<br>required: **true**<br><p>A unique identifier for the kdb scaling group.</p><br>
9 /// - [`host_type(impl Into<String>)`](crate::operation::create_kx_scaling_group::builders::CreateKxScalingGroupFluentBuilder::host_type) / [`set_host_type(Option<String>)`](crate::operation::create_kx_scaling_group::builders::CreateKxScalingGroupFluentBuilder::set_host_type):<br>required: **true**<br><p>The memory and CPU capabilities of the scaling group host on which FinSpace Managed kdb clusters will be placed.</p> <p>You can add one of the following values:</p> <ul> <li> <p><code>kx.sg.large</code> – The host type with a configuration of 16 GiB memory and 2 vCPUs.</p></li> <li> <p><code>kx.sg.xlarge</code> – The host type with a configuration of 32 GiB memory and 4 vCPUs.</p></li> <li> <p><code>kx.sg.2xlarge</code> – The host type with a configuration of 64 GiB memory and 8 vCPUs.</p></li> <li> <p><code>kx.sg.4xlarge</code> – The host type with a configuration of 108 GiB memory and 16 vCPUs.</p></li> <li> <p><code>kx.sg.8xlarge</code> – The host type with a configuration of 216 GiB memory and 32 vCPUs.</p></li> <li> <p><code>kx.sg.16xlarge</code> – The host type with a configuration of 432 GiB memory and 64 vCPUs.</p></li> <li> <p><code>kx.sg.32xlarge</code> – The host type with a configuration of 864 GiB memory and 128 vCPUs.</p></li> <li> <p><code>kx.sg1.16xlarge</code> – The host type with a configuration of 1949 GiB memory and 64 vCPUs.</p></li> <li> <p><code>kx.sg1.24xlarge</code> – The host type with a configuration of 2948 GiB memory and 96 vCPUs.</p></li> </ul><br>
10 /// - [`availability_zone_id(impl Into<String>)`](crate::operation::create_kx_scaling_group::builders::CreateKxScalingGroupFluentBuilder::availability_zone_id) / [`set_availability_zone_id(Option<String>)`](crate::operation::create_kx_scaling_group::builders::CreateKxScalingGroupFluentBuilder::set_availability_zone_id):<br>required: **true**<br><p>The identifier of the availability zones.</p><br>
11 /// - [`tags(impl Into<String>, impl Into<String>)`](crate::operation::create_kx_scaling_group::builders::CreateKxScalingGroupFluentBuilder::tags) / [`set_tags(Option<HashMap::<String, String>>)`](crate::operation::create_kx_scaling_group::builders::CreateKxScalingGroupFluentBuilder::set_tags):<br>required: **false**<br><p>A list of key-value pairs to label the scaling group. You can add up to 50 tags to a scaling group.</p><br>
12 /// - On success, responds with [`CreateKxScalingGroupOutput`](crate::operation::create_kx_scaling_group::CreateKxScalingGroupOutput) with field(s):
13 /// - [`environment_id(Option<String>)`](crate::operation::create_kx_scaling_group::CreateKxScalingGroupOutput::environment_id): <p>A unique identifier for the kdb environment, where you create the scaling group.</p>
14 /// - [`scaling_group_name(Option<String>)`](crate::operation::create_kx_scaling_group::CreateKxScalingGroupOutput::scaling_group_name): <p>A unique identifier for the kdb scaling group.</p>
15 /// - [`host_type(Option<String>)`](crate::operation::create_kx_scaling_group::CreateKxScalingGroupOutput::host_type): <p>The memory and CPU capabilities of the scaling group host on which FinSpace Managed kdb clusters will be placed.</p>
16 /// - [`availability_zone_id(Option<String>)`](crate::operation::create_kx_scaling_group::CreateKxScalingGroupOutput::availability_zone_id): <p>The identifier of the availability zones.</p>
17 /// - [`status(Option<KxScalingGroupStatus>)`](crate::operation::create_kx_scaling_group::CreateKxScalingGroupOutput::status): <p>The status of scaling group.</p> <ul> <li> <p>CREATING – The scaling group creation is in progress.</p></li> <li> <p>CREATE_FAILED – The scaling group creation has failed.</p></li> <li> <p>ACTIVE – The scaling group is active.</p></li> <li> <p>UPDATING – The scaling group is in the process of being updated.</p></li> <li> <p>UPDATE_FAILED – The update action failed.</p></li> <li> <p>DELETING – The scaling group is in the process of being deleted.</p></li> <li> <p>DELETE_FAILED – The system failed to delete the scaling group.</p></li> <li> <p>DELETED – The scaling group is successfully deleted.</p></li> </ul>
18 /// - [`last_modified_timestamp(Option<DateTime>)`](crate::operation::create_kx_scaling_group::CreateKxScalingGroupOutput::last_modified_timestamp): <p>The last time that the scaling group was updated 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>
19 /// - [`created_timestamp(Option<DateTime>)`](crate::operation::create_kx_scaling_group::CreateKxScalingGroupOutput::created_timestamp): <p>The timestamp at which the scaling group 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>
20 /// - On failure, responds with [`SdkError<CreateKxScalingGroupError>`](crate::operation::create_kx_scaling_group::CreateKxScalingGroupError)
21 pub fn create_kx_scaling_group(&self) -> crate::operation::create_kx_scaling_group::builders::CreateKxScalingGroupFluentBuilder {
22 crate::operation::create_kx_scaling_group::builders::CreateKxScalingGroupFluentBuilder::new(self.handle.clone())
23 }
24}