aws_sdk_sagemaker/operation/update_cluster/

_update_cluster_input.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct UpdateClusterInput {
    /// <p>Specify the name of the SageMaker HyperPod cluster you want to update.</p>
    pub cluster_name: ::std::option::Option<::std::string::String>,
    /// <p>Specify the instance groups to update.</p>
    pub instance_groups: ::std::option::Option<::std::vec::Vec<crate::types::ClusterInstanceGroupSpecification>>,
    /// <p>The specialized instance groups for training models like Amazon Nova to be created in the SageMaker HyperPod cluster.</p>
    pub restricted_instance_groups: ::std::option::Option<::std::vec::Vec<crate::types::ClusterRestrictedInstanceGroupSpecification>>,
    /// <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>
    pub tiered_storage_config: ::std::option::Option<crate::types::ClusterTieredStorageConfig>,
    /// <p>The node recovery mode to be applied to the SageMaker HyperPod cluster.</p>
    pub node_recovery: ::std::option::Option<crate::types::ClusterNodeRecovery>,
    /// <p>Specify the names of the instance groups to delete. Use a single <code>,</code> as the separator between multiple names.</p>
    pub instance_groups_to_delete: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
    /// <p>Determines how instance provisioning is handled during cluster operations. In <code>Continuous</code> mode, the cluster provisions available instances incrementally and retries until the target count is reached. The cluster becomes operational once cluster-level resources are ready. Use <code>CurrentCount</code> and <code>TargetCount</code> in <code>DescribeCluster</code> to track provisioning progress.</p>
    pub node_provisioning_mode: ::std::option::Option<crate::types::ClusterNodeProvisioningMode>,
    /// <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>
    pub cluster_role: ::std::option::Option<::std::string::String>,
    /// <p>Updates the autoscaling configuration for the cluster. Use to enable or disable automatic node scaling.</p>
    pub auto_scaling: ::std::option::Option<crate::types::ClusterAutoScalingConfig>,
}
impl UpdateClusterInput {
    /// <p>Specify the name of the SageMaker HyperPod cluster you want to update.</p>
    pub fn cluster_name(&self) -> ::std::option::Option<&str> {
        self.cluster_name.as_deref()
    }
    /// <p>Specify the instance groups to update.</p>
    ///
    /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.instance_groups.is_none()`.
    pub fn instance_groups(&self) -> &[crate::types::ClusterInstanceGroupSpecification] {
        self.instance_groups.as_deref().unwrap_or_default()
    }
    /// <p>The specialized instance groups for training models like Amazon Nova to be created in the SageMaker HyperPod cluster.</p>
    ///
    /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.restricted_instance_groups.is_none()`.
    pub fn restricted_instance_groups(&self) -> &[crate::types::ClusterRestrictedInstanceGroupSpecification] {
        self.restricted_instance_groups.as_deref().unwrap_or_default()
    }
    /// <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>
    pub fn tiered_storage_config(&self) -> ::std::option::Option<&crate::types::ClusterTieredStorageConfig> {
        self.tiered_storage_config.as_ref()
    }
    /// <p>The node recovery mode to be applied to the SageMaker HyperPod cluster.</p>
    pub fn node_recovery(&self) -> ::std::option::Option<&crate::types::ClusterNodeRecovery> {
        self.node_recovery.as_ref()
    }
    /// <p>Specify the names of the instance groups to delete. Use a single <code>,</code> as the separator between multiple names.</p>
    ///
    /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.instance_groups_to_delete.is_none()`.
    pub fn instance_groups_to_delete(&self) -> &[::std::string::String] {
        self.instance_groups_to_delete.as_deref().unwrap_or_default()
    }
    /// <p>Determines how instance provisioning is handled during cluster operations. In <code>Continuous</code> mode, the cluster provisions available instances incrementally and retries until the target count is reached. The cluster becomes operational once cluster-level resources are ready. Use <code>CurrentCount</code> and <code>TargetCount</code> in <code>DescribeCluster</code> to track provisioning progress.</p>
    pub fn node_provisioning_mode(&self) -> ::std::option::Option<&crate::types::ClusterNodeProvisioningMode> {
        self.node_provisioning_mode.as_ref()
    }
    /// <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>
    pub fn cluster_role(&self) -> ::std::option::Option<&str> {
        self.cluster_role.as_deref()
    }
    /// <p>Updates the autoscaling configuration for the cluster. Use to enable or disable automatic node scaling.</p>
    pub fn auto_scaling(&self) -> ::std::option::Option<&crate::types::ClusterAutoScalingConfig> {
        self.auto_scaling.as_ref()
    }
}
impl UpdateClusterInput {
    /// Creates a new builder-style object to manufacture [`UpdateClusterInput`](crate::operation::update_cluster::UpdateClusterInput).
    pub fn builder() -> crate::operation::update_cluster::builders::UpdateClusterInputBuilder {
        crate::operation::update_cluster::builders::UpdateClusterInputBuilder::default()
    }
}

/// A builder for [`UpdateClusterInput`](crate::operation::update_cluster::UpdateClusterInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct UpdateClusterInputBuilder {
    pub(crate) cluster_name: ::std::option::Option<::std::string::String>,
    pub(crate) instance_groups: ::std::option::Option<::std::vec::Vec<crate::types::ClusterInstanceGroupSpecification>>,
    pub(crate) restricted_instance_groups: ::std::option::Option<::std::vec::Vec<crate::types::ClusterRestrictedInstanceGroupSpecification>>,
    pub(crate) tiered_storage_config: ::std::option::Option<crate::types::ClusterTieredStorageConfig>,
    pub(crate) node_recovery: ::std::option::Option<crate::types::ClusterNodeRecovery>,
    pub(crate) instance_groups_to_delete: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
    pub(crate) node_provisioning_mode: ::std::option::Option<crate::types::ClusterNodeProvisioningMode>,
    pub(crate) cluster_role: ::std::option::Option<::std::string::String>,
    pub(crate) auto_scaling: ::std::option::Option<crate::types::ClusterAutoScalingConfig>,
}
impl UpdateClusterInputBuilder {
    /// <p>Specify the name of the SageMaker HyperPod cluster you want to update.</p>
    /// This field is required.
    pub fn cluster_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.cluster_name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>Specify the name of the SageMaker HyperPod cluster you want to update.</p>
    pub fn set_cluster_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.cluster_name = input;
        self
    }
    /// <p>Specify the name of the SageMaker HyperPod cluster you want to update.</p>
    pub fn get_cluster_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.cluster_name
    }
    /// Appends an item to `instance_groups`.
    ///
    /// To override the contents of this collection use [`set_instance_groups`](Self::set_instance_groups).
    ///
    /// <p>Specify the instance groups to update.</p>
    pub fn instance_groups(mut self, input: crate::types::ClusterInstanceGroupSpecification) -> Self {
        let mut v = self.instance_groups.unwrap_or_default();
        v.push(input);
        self.instance_groups = ::std::option::Option::Some(v);
        self
    }
    /// <p>Specify the instance groups to update.</p>
    pub fn set_instance_groups(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::ClusterInstanceGroupSpecification>>) -> Self {
        self.instance_groups = input;
        self
    }
    /// <p>Specify the instance groups to update.</p>
    pub fn get_instance_groups(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::ClusterInstanceGroupSpecification>> {
        &self.instance_groups
    }
    /// Appends an item to `restricted_instance_groups`.
    ///
    /// To override the contents of this collection use [`set_restricted_instance_groups`](Self::set_restricted_instance_groups).
    ///
    /// <p>The specialized instance groups for training models like Amazon Nova to be created in the SageMaker HyperPod cluster.</p>
    pub fn restricted_instance_groups(mut self, input: crate::types::ClusterRestrictedInstanceGroupSpecification) -> Self {
        let mut v = self.restricted_instance_groups.unwrap_or_default();
        v.push(input);
        self.restricted_instance_groups = ::std::option::Option::Some(v);
        self
    }
    /// <p>The specialized instance groups for training models like Amazon Nova to be created in the SageMaker HyperPod cluster.</p>
    pub fn set_restricted_instance_groups(
        mut self,
        input: ::std::option::Option<::std::vec::Vec<crate::types::ClusterRestrictedInstanceGroupSpecification>>,
    ) -> Self {
        self.restricted_instance_groups = input;
        self
    }
    /// <p>The specialized instance groups for training models like Amazon Nova to be created in the SageMaker HyperPod cluster.</p>
    pub fn get_restricted_instance_groups(
        &self,
    ) -> &::std::option::Option<::std::vec::Vec<crate::types::ClusterRestrictedInstanceGroupSpecification>> {
        &self.restricted_instance_groups
    }
    /// <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>
    pub fn tiered_storage_config(mut self, input: crate::types::ClusterTieredStorageConfig) -> Self {
        self.tiered_storage_config = ::std::option::Option::Some(input);
        self
    }
    /// <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>
    pub fn set_tiered_storage_config(mut self, input: ::std::option::Option<crate::types::ClusterTieredStorageConfig>) -> Self {
        self.tiered_storage_config = input;
        self
    }
    /// <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>
    pub fn get_tiered_storage_config(&self) -> &::std::option::Option<crate::types::ClusterTieredStorageConfig> {
        &self.tiered_storage_config
    }
    /// <p>The node recovery mode to be applied to the SageMaker HyperPod cluster.</p>
    pub fn node_recovery(mut self, input: crate::types::ClusterNodeRecovery) -> Self {
        self.node_recovery = ::std::option::Option::Some(input);
        self
    }
    /// <p>The node recovery mode to be applied to the SageMaker HyperPod cluster.</p>
    pub fn set_node_recovery(mut self, input: ::std::option::Option<crate::types::ClusterNodeRecovery>) -> Self {
        self.node_recovery = input;
        self
    }
    /// <p>The node recovery mode to be applied to the SageMaker HyperPod cluster.</p>
    pub fn get_node_recovery(&self) -> &::std::option::Option<crate::types::ClusterNodeRecovery> {
        &self.node_recovery
    }
    /// Appends an item to `instance_groups_to_delete`.
    ///
    /// To override the contents of this collection use [`set_instance_groups_to_delete`](Self::set_instance_groups_to_delete).
    ///
    /// <p>Specify the names of the instance groups to delete. Use a single <code>,</code> as the separator between multiple names.</p>
    pub fn instance_groups_to_delete(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        let mut v = self.instance_groups_to_delete.unwrap_or_default();
        v.push(input.into());
        self.instance_groups_to_delete = ::std::option::Option::Some(v);
        self
    }
    /// <p>Specify the names of the instance groups to delete. Use a single <code>,</code> as the separator between multiple names.</p>
    pub fn set_instance_groups_to_delete(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
        self.instance_groups_to_delete = input;
        self
    }
    /// <p>Specify the names of the instance groups to delete. Use a single <code>,</code> as the separator between multiple names.</p>
    pub fn get_instance_groups_to_delete(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
        &self.instance_groups_to_delete
    }
    /// <p>Determines how instance provisioning is handled during cluster operations. In <code>Continuous</code> mode, the cluster provisions available instances incrementally and retries until the target count is reached. The cluster becomes operational once cluster-level resources are ready. Use <code>CurrentCount</code> and <code>TargetCount</code> in <code>DescribeCluster</code> to track provisioning progress.</p>
    pub fn node_provisioning_mode(mut self, input: crate::types::ClusterNodeProvisioningMode) -> Self {
        self.node_provisioning_mode = ::std::option::Option::Some(input);
        self
    }
    /// <p>Determines how instance provisioning is handled during cluster operations. In <code>Continuous</code> mode, the cluster provisions available instances incrementally and retries until the target count is reached. The cluster becomes operational once cluster-level resources are ready. Use <code>CurrentCount</code> and <code>TargetCount</code> in <code>DescribeCluster</code> to track provisioning progress.</p>
    pub fn set_node_provisioning_mode(mut self, input: ::std::option::Option<crate::types::ClusterNodeProvisioningMode>) -> Self {
        self.node_provisioning_mode = input;
        self
    }
    /// <p>Determines how instance provisioning is handled during cluster operations. In <code>Continuous</code> mode, the cluster provisions available instances incrementally and retries until the target count is reached. The cluster becomes operational once cluster-level resources are ready. Use <code>CurrentCount</code> and <code>TargetCount</code> in <code>DescribeCluster</code> to track provisioning progress.</p>
    pub fn get_node_provisioning_mode(&self) -> &::std::option::Option<crate::types::ClusterNodeProvisioningMode> {
        &self.node_provisioning_mode
    }
    /// <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>
    pub fn cluster_role(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.cluster_role = ::std::option::Option::Some(input.into());
        self
    }
    /// <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>
    pub fn set_cluster_role(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.cluster_role = input;
        self
    }
    /// <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>
    pub fn get_cluster_role(&self) -> &::std::option::Option<::std::string::String> {
        &self.cluster_role
    }
    /// <p>Updates the autoscaling configuration for the cluster. Use to enable or disable automatic node scaling.</p>
    pub fn auto_scaling(mut self, input: crate::types::ClusterAutoScalingConfig) -> Self {
        self.auto_scaling = ::std::option::Option::Some(input);
        self
    }
    /// <p>Updates the autoscaling configuration for the cluster. Use to enable or disable automatic node scaling.</p>
    pub fn set_auto_scaling(mut self, input: ::std::option::Option<crate::types::ClusterAutoScalingConfig>) -> Self {
        self.auto_scaling = input;
        self
    }
    /// <p>Updates the autoscaling configuration for the cluster. Use to enable or disable automatic node scaling.</p>
    pub fn get_auto_scaling(&self) -> &::std::option::Option<crate::types::ClusterAutoScalingConfig> {
        &self.auto_scaling
    }
    /// Consumes the builder and constructs a [`UpdateClusterInput`](crate::operation::update_cluster::UpdateClusterInput).
    pub fn build(
        self,
    ) -> ::std::result::Result<crate::operation::update_cluster::UpdateClusterInput, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::operation::update_cluster::UpdateClusterInput {
            cluster_name: self.cluster_name,
            instance_groups: self.instance_groups,
            restricted_instance_groups: self.restricted_instance_groups,
            tiered_storage_config: self.tiered_storage_config,
            node_recovery: self.node_recovery,
            instance_groups_to_delete: self.instance_groups_to_delete,
            node_provisioning_mode: self.node_provisioning_mode,
            cluster_role: self.cluster_role,
            auto_scaling: self.auto_scaling,
        })
    }
}