aws_sdk_eks/client/

update_nodegroup_version.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`UpdateNodegroupVersion`](crate::operation::update_nodegroup_version::builders::UpdateNodegroupVersionFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`cluster_name(impl Into<String>)`](crate::operation::update_nodegroup_version::builders::UpdateNodegroupVersionFluentBuilder::cluster_name) / [`set_cluster_name(Option<String>)`](crate::operation::update_nodegroup_version::builders::UpdateNodegroupVersionFluentBuilder::set_cluster_name):<br>required: **true**<br><p>The name of your cluster.</p><br>
    ///   - [`nodegroup_name(impl Into<String>)`](crate::operation::update_nodegroup_version::builders::UpdateNodegroupVersionFluentBuilder::nodegroup_name) / [`set_nodegroup_name(Option<String>)`](crate::operation::update_nodegroup_version::builders::UpdateNodegroupVersionFluentBuilder::set_nodegroup_name):<br>required: **true**<br><p>The name of the managed node group to update.</p><br>
    ///   - [`version(impl Into<String>)`](crate::operation::update_nodegroup_version::builders::UpdateNodegroupVersionFluentBuilder::version) / [`set_version(Option<String>)`](crate::operation::update_nodegroup_version::builders::UpdateNodegroupVersionFluentBuilder::set_version):<br>required: **false**<br><p>The Kubernetes version to update to. If no version is specified, then the Kubernetes version of the node group does not change. You can specify the Kubernetes version of the cluster to update the node group to the latest AMI version of the cluster's Kubernetes version. If you specify <code>launchTemplate</code>, and your launch template uses a custom AMI, then don't specify <code>version</code>, or the node group update will fail. For more information about using launch templates with Amazon EKS, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html">Customizing managed nodes with launch templates</a> in the <i>Amazon EKS User Guide</i>.</p><br>
    ///   - [`release_version(impl Into<String>)`](crate::operation::update_nodegroup_version::builders::UpdateNodegroupVersionFluentBuilder::release_version) / [`set_release_version(Option<String>)`](crate::operation::update_nodegroup_version::builders::UpdateNodegroupVersionFluentBuilder::set_release_version):<br>required: **false**<br><p>The AMI version of the Amazon EKS optimized AMI to use for the update. By default, the latest available AMI version for the node group's Kubernetes version is used. For information about Linux versions, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/eks-linux-ami-versions.html">Amazon EKS optimized Amazon Linux AMI versions</a> in the <i>Amazon EKS User Guide</i>. Amazon EKS managed node groups support the November 2022 and later releases of the Windows AMIs. For information about Windows versions, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/eks-ami-versions-windows.html">Amazon EKS optimized Windows AMI versions</a> in the <i>Amazon EKS User Guide</i>.</p> <p>If you specify <code>launchTemplate</code>, and your launch template uses a custom AMI, then don't specify <code>releaseVersion</code>, or the node group update will fail. For more information about using launch templates with Amazon EKS, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html">Customizing managed nodes with launch templates</a> in the <i>Amazon EKS User Guide</i>.</p><br>
    ///   - [`launch_template(LaunchTemplateSpecification)`](crate::operation::update_nodegroup_version::builders::UpdateNodegroupVersionFluentBuilder::launch_template) / [`set_launch_template(Option<LaunchTemplateSpecification>)`](crate::operation::update_nodegroup_version::builders::UpdateNodegroupVersionFluentBuilder::set_launch_template):<br>required: **false**<br><p>An object representing a node group's launch template specification. You can only update a node group using a launch template if the node group was originally deployed with a launch template. When updating, you must specify the same launch template ID or name that was used to create the node group.</p><br>
    ///   - [`force(bool)`](crate::operation::update_nodegroup_version::builders::UpdateNodegroupVersionFluentBuilder::force) / [`set_force(Option<bool>)`](crate::operation::update_nodegroup_version::builders::UpdateNodegroupVersionFluentBuilder::set_force):<br>required: **false**<br><p>Force the update if any <code>Pod</code> on the existing node group can't be drained due to a <code>Pod</code> disruption budget issue. If an update fails because all Pods can't be drained, you can force the update after it fails to terminate the old node whether or not any <code>Pod</code> is running on the node.</p><br>
    ///   - [`client_request_token(impl Into<String>)`](crate::operation::update_nodegroup_version::builders::UpdateNodegroupVersionFluentBuilder::client_request_token) / [`set_client_request_token(Option<String>)`](crate::operation::update_nodegroup_version::builders::UpdateNodegroupVersionFluentBuilder::set_client_request_token):<br>required: **false**<br><p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p><br>
    /// - On success, responds with [`UpdateNodegroupVersionOutput`](crate::operation::update_nodegroup_version::UpdateNodegroupVersionOutput) with field(s):
    ///   - [`update(Option<Update>)`](crate::operation::update_nodegroup_version::UpdateNodegroupVersionOutput::update): <p>An object representing an asynchronous update.</p>
    /// - On failure, responds with [`SdkError<UpdateNodegroupVersionError>`](crate::operation::update_nodegroup_version::UpdateNodegroupVersionError)
    pub fn update_nodegroup_version(&self) -> crate::operation::update_nodegroup_version::builders::UpdateNodegroupVersionFluentBuilder {
        crate::operation::update_nodegroup_version::builders::UpdateNodegroupVersionFluentBuilder::new(self.handle.clone())
    }
}