aws_sdk_sagemaker/client/
update_cluster.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 [`UpdateCluster`](crate::operation::update_cluster::builders::UpdateClusterFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`cluster_name(impl Into<String>)`](crate::operation::update_cluster::builders::UpdateClusterFluentBuilder::cluster_name) / [`set_cluster_name(Option<String>)`](crate::operation::update_cluster::builders::UpdateClusterFluentBuilder::set_cluster_name):<br>required: **true**<br><p>Specify the name of the SageMaker HyperPod cluster you want to update.</p><br>
7    ///   - [`instance_groups(ClusterInstanceGroupSpecification)`](crate::operation::update_cluster::builders::UpdateClusterFluentBuilder::instance_groups) / [`set_instance_groups(Option<Vec::<ClusterInstanceGroupSpecification>>)`](crate::operation::update_cluster::builders::UpdateClusterFluentBuilder::set_instance_groups):<br>required: **false**<br><p>Specify the instance groups to update.</p><br>
8    ///   - [`restricted_instance_groups(ClusterRestrictedInstanceGroupSpecification)`](crate::operation::update_cluster::builders::UpdateClusterFluentBuilder::restricted_instance_groups) / [`set_restricted_instance_groups(Option<Vec::<ClusterRestrictedInstanceGroupSpecification>>)`](crate::operation::update_cluster::builders::UpdateClusterFluentBuilder::set_restricted_instance_groups):<br>required: **false**<br><p>The specialized instance groups for training models like Amazon Nova to be created in the SageMaker HyperPod cluster.</p><br>
9    ///   - [`tiered_storage_config(ClusterTieredStorageConfig)`](crate::operation::update_cluster::builders::UpdateClusterFluentBuilder::tiered_storage_config) / [`set_tiered_storage_config(Option<ClusterTieredStorageConfig>)`](crate::operation::update_cluster::builders::UpdateClusterFluentBuilder::set_tiered_storage_config):<br>required: **false**<br><p>Updates the configuration for managed tier checkpointing on the HyperPod cluster. For example, you can enable or disable the feature and modify the percentage of cluster memory allocated for checkpoint storage.</p><br>
10    ///   - [`node_recovery(ClusterNodeRecovery)`](crate::operation::update_cluster::builders::UpdateClusterFluentBuilder::node_recovery) / [`set_node_recovery(Option<ClusterNodeRecovery>)`](crate::operation::update_cluster::builders::UpdateClusterFluentBuilder::set_node_recovery):<br>required: **false**<br><p>The node recovery mode to be applied to the SageMaker HyperPod cluster.</p><br>
11    ///   - [`instance_groups_to_delete(impl Into<String>)`](crate::operation::update_cluster::builders::UpdateClusterFluentBuilder::instance_groups_to_delete) / [`set_instance_groups_to_delete(Option<Vec::<String>>)`](crate::operation::update_cluster::builders::UpdateClusterFluentBuilder::set_instance_groups_to_delete):<br>required: **false**<br><p>Specify the names of the instance groups to delete. Use a single <code>,</code> as the separator between multiple names.</p><br>
12    ///   - [`cluster_role(impl Into<String>)`](crate::operation::update_cluster::builders::UpdateClusterFluentBuilder::cluster_role) / [`set_cluster_role(Option<String>)`](crate::operation::update_cluster::builders::UpdateClusterFluentBuilder::set_cluster_role):<br>required: **false**<br><p>The Amazon Resource Name (ARN) of the IAM role that HyperPod assumes for cluster autoscaling operations. Cannot be updated while autoscaling is enabled.</p><br>
13    ///   - [`auto_scaling(ClusterAutoScalingConfig)`](crate::operation::update_cluster::builders::UpdateClusterFluentBuilder::auto_scaling) / [`set_auto_scaling(Option<ClusterAutoScalingConfig>)`](crate::operation::update_cluster::builders::UpdateClusterFluentBuilder::set_auto_scaling):<br>required: **false**<br><p>Updates the autoscaling configuration for the cluster. Use to enable or disable automatic node scaling.</p><br>
14    /// - On success, responds with [`UpdateClusterOutput`](crate::operation::update_cluster::UpdateClusterOutput) with field(s):
15    ///   - [`cluster_arn(Option<String>)`](crate::operation::update_cluster::UpdateClusterOutput::cluster_arn): <p>The Amazon Resource Name (ARN) of the updated SageMaker HyperPod cluster.</p>
16    /// - On failure, responds with [`SdkError<UpdateClusterError>`](crate::operation::update_cluster::UpdateClusterError)
17    pub fn update_cluster(&self) -> crate::operation::update_cluster::builders::UpdateClusterFluentBuilder {
18        crate::operation::update_cluster::builders::UpdateClusterFluentBuilder::new(self.handle.clone())
19    }
20}
aws_sdk_sagemaker/client/update_cluster.rs

aws_sdk_sagemaker/client/
update_cluster.rs
