aws_sdk_sagemaker/client/

update_cluster_software.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`UpdateClusterSoftware`](crate::operation::update_cluster_software::builders::UpdateClusterSoftwareFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`cluster_name(impl Into<String>)`](crate::operation::update_cluster_software::builders::UpdateClusterSoftwareFluentBuilder::cluster_name) / [`set_cluster_name(Option<String>)`](crate::operation::update_cluster_software::builders::UpdateClusterSoftwareFluentBuilder::set_cluster_name):<br>required: **true**<br><p>Specify the name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster you want to update for security patching.</p><br>
    ///   - [`instance_groups(UpdateClusterSoftwareInstanceGroupSpecification)`](crate::operation::update_cluster_software::builders::UpdateClusterSoftwareFluentBuilder::instance_groups) / [`set_instance_groups(Option<Vec::<UpdateClusterSoftwareInstanceGroupSpecification>>)`](crate::operation::update_cluster_software::builders::UpdateClusterSoftwareFluentBuilder::set_instance_groups):<br>required: **false**<br><p>The array of instance groups for which to update AMI versions.</p><br>
    ///   - [`deployment_config(DeploymentConfiguration)`](crate::operation::update_cluster_software::builders::UpdateClusterSoftwareFluentBuilder::deployment_config) / [`set_deployment_config(Option<DeploymentConfiguration>)`](crate::operation::update_cluster_software::builders::UpdateClusterSoftwareFluentBuilder::set_deployment_config):<br>required: **false**<br><p>The configuration to use when updating the AMI versions.</p><br>
    ///   - [`image_id(impl Into<String>)`](crate::operation::update_cluster_software::builders::UpdateClusterSoftwareFluentBuilder::image_id) / [`set_image_id(Option<String>)`](crate::operation::update_cluster_software::builders::UpdateClusterSoftwareFluentBuilder::set_image_id):<br>required: **false**<br><p>When configuring your HyperPod cluster, you can specify an image ID using one of the following options:</p> <ul>  <li>   <p><code>HyperPodPublicAmiId</code>: Use a HyperPod public AMI</p></li>  <li>   <p><code>CustomAmiId</code>: Use your custom AMI</p></li>  <li>   <p><code>default</code>: Use the default latest system image</p></li> </ul> <p>If you choose to use a custom AMI (<code>CustomAmiId</code>), ensure it meets the following requirements:</p> <ul>  <li>   <p>Encryption: The custom AMI must be unencrypted.</p></li>  <li>   <p>Ownership: The custom AMI must be owned by the same Amazon Web Services account that is creating the HyperPod cluster.</p></li>  <li>   <p>Volume support: Only the primary AMI snapshot volume is supported; additional AMI volumes are not supported.</p></li> </ul> <p>When updating the instance group's AMI through the <code>UpdateClusterSoftware</code> operation, if an instance group uses a custom AMI, you must provide an <code>ImageId</code> or use the default as input. Note that if you don't specify an instance group in your <code>UpdateClusterSoftware</code> request, then all of the instance groups are patched with the specified image.</p><br>
    /// - On success, responds with [`UpdateClusterSoftwareOutput`](crate::operation::update_cluster_software::UpdateClusterSoftwareOutput) with field(s):
    ///   - [`cluster_arn(Option<String>)`](crate::operation::update_cluster_software::UpdateClusterSoftwareOutput::cluster_arn): <p>The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster being updated for security patching.</p>
    /// - On failure, responds with [`SdkError<UpdateClusterSoftwareError>`](crate::operation::update_cluster_software::UpdateClusterSoftwareError)
    pub fn update_cluster_software(&self) -> crate::operation::update_cluster_software::builders::UpdateClusterSoftwareFluentBuilder {
        crate::operation::update_cluster_software::builders::UpdateClusterSoftwareFluentBuilder::new(self.handle.clone())
    }
}