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 Summary

Modifier and Type	Method and Description
UpdateNodegroupVersionRequest.Builder	clientRequestToken(String clientRequestToken) Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
UpdateNodegroupVersionRequest.Builder	clusterName(String clusterName) The name of the Amazon EKS cluster that is associated with the managed node group to update.
UpdateNodegroupVersionRequest.Builder	force(Boolean force) Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue.
default UpdateNodegroupVersionRequest.Builder	launchTemplate(Consumer<LaunchTemplateSpecification.Builder> launchTemplate) An object representing a node group's launch template specification.
UpdateNodegroupVersionRequest.Builder	launchTemplate(LaunchTemplateSpecification launchTemplate) An object representing a node group's launch template specification.
UpdateNodegroupVersionRequest.Builder	nodegroupName(String nodegroupName) The name of the managed node group to update.
UpdateNodegroupVersionRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
UpdateNodegroupVersionRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
UpdateNodegroupVersionRequest.Builder	releaseVersion(String releaseVersion) The AMI version of the Amazon EKS optimized AMI to use for the update.
UpdateNodegroupVersionRequest.Builder	version(String version) The Kubernetes version to update to.

Methods inherited from interface software.amazon.awssdk.services.eks.model.EksRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

clusterName

UpdateNodegroupVersionRequest.Builder clusterName(String clusterName)

The name of the Amazon EKS cluster that is associated with the managed node group to update.

Parameters:

clusterName - The name of the Amazon EKS cluster that is associated with the managed node group to update.

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 more information, see Amazon EKS optimized Amazon Linux 2 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 more information, see Amazon EKS optimized Amazon Linux 2 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 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:

launchTemplate(LaunchTemplateSpecification)

force

UpdateNodegroupVersionRequest.Builder force(Boolean force)

Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. If an update fails because pods could not be drained, you can force the update after it fails to terminate the old node whether or not any pods are running on the node.

Parameters:

force - Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. If an update fails because pods could not be drained, you can force the update after it fails to terminate the old node whether or not any pods are 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)

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

Parameters:

clientRequestToken - 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)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

UpdateNodegroupVersionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder