Package software.amazon.awssdk.services.eks.model

Interface UpdateNodegroupVersionRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<UpdateNodegroupVersionRequest.Builder,UpdateNodegroupVersionRequest>, EksRequest.Builder, SdkBuilder<UpdateNodegroupVersionRequest.Builder,UpdateNodegroupVersionRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
UpdateNodegroupVersionRequest
public static interface UpdateNodegroupVersionRequest.Builder extends EksRequest.Builder, SdkPojo, CopyableBuilder<UpdateNodegroupVersionRequest.Builder,UpdateNodegroupVersionRequest>

  • Method Details

    • clusterName

      UpdateNodegroupVersionRequest.Builder clusterName(String clusterName)

      The name of your cluster.

      Parameters:
      clusterName - The name of your cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nodegroupName

      UpdateNodegroupVersionRequest.Builder nodegroupName(String nodegroupName)

      The name of the managed node group to update.

      Parameters:
      nodegroupName - The name of the managed node group to update.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • version

      UpdateNodegroupVersionRequest.Builder version(String version)

      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 launchTemplate, and your launch template uses a custom AMI, then don't specify version, or the node group update will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

      Parameters:
      version - 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 launchTemplate, and your launch template uses a custom AMI, then don't specify version, or the node group update will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • releaseVersion

      UpdateNodegroupVersionRequest.Builder releaseVersion(String releaseVersion)

      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 Amazon EKS optimized Amazon Linux AMI versions in the Amazon EKS User Guide. Amazon EKS managed node groups support the November 2022 and later releases of the Windows AMIs. For information about Windows versions, see Amazon EKS optimized Windows AMI versions in the Amazon EKS User Guide.

      If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify releaseVersion, or the node group update will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

      Parameters:
      releaseVersion - 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 Amazon EKS optimized Amazon Linux AMI versions in the Amazon EKS User Guide. Amazon EKS managed node groups support the November 2022 and later releases of the Windows AMIs. For information about Windows versions, see Amazon EKS optimized Windows AMI versions in the Amazon EKS User Guide.

      If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify releaseVersion, or the node group update will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • launchTemplate

      UpdateNodegroupVersionRequest.Builder launchTemplate(LaunchTemplateSpecification launchTemplate)

      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.

      Parameters:
      launchTemplate - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • launchTemplate

      default UpdateNodegroupVersionRequest.Builder launchTemplate(Consumer<LaunchTemplateSpecification.Builder> launchTemplate)

      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.

      This is a convenience method that creates an instance of the LaunchTemplateSpecification.Builder avoiding the need to create one manually via LaunchTemplateSpecification.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to launchTemplate(LaunchTemplateSpecification).

      Parameters:
      launchTemplate - a consumer that will call methods on LaunchTemplateSpecification.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • force

      UpdateNodegroupVersionRequest.Builder force(Boolean force)

      Force the update if any Pod on the existing node group can't be drained due to a Pod 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 Pod is running on the node.

      Parameters:
      force - Force the update if any Pod on the existing node group can't be drained due to a Pod 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 Pod is running on the node.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientRequestToken

      UpdateNodegroupVersionRequest.Builder clientRequestToken(String clientRequestToken)

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

      Parameters:
      clientRequestToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      UpdateNodegroupVersionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      UpdateNodegroupVersionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.