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

Class UpdateNodegroupVersionRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.eks.model.EksRequest

software.amazon.awssdk.services.eks.model.UpdateNodegroupVersionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateNodegroupVersionRequest.Builder,UpdateNodegroupVersionRequest>

@Generated("software.amazon.awssdk:codegen")
public final class UpdateNodegroupVersionRequest
extends EksRequest
implements ToCopyableBuilder<UpdateNodegroupVersionRequest.Builder,UpdateNodegroupVersionRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateNodegroupVersionRequest.Builder

Method Summary

Modifier and Type	Method	Description
static UpdateNodegroupVersionRequest.Builder	builder()
String	clientRequestToken()	Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
String	clusterName()	The name of the Amazon EKS cluster that is associated with the managed node group to update.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Boolean	force()	Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
LaunchTemplateSpecification	launchTemplate()	An object representing a node group's launch template specification.
String	nodegroupName()	The name of the managed node group to update.
String	releaseVersion()	The AMI version of the Amazon EKS optimized AMI to use for the update.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateNodegroupVersionRequest.Builder>	serializableBuilderClass()
UpdateNodegroupVersionRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	version()	The Kubernetes version to update to.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

clusterName

public final String clusterName()

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

Returns:

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

nodegroupName

public final String nodegroupName()

The name of the managed node group to update.

Returns:

The name of the managed node group to update.

version

public final 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.

Returns:

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.

releaseVersion

public final 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.

Returns:

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.

launchTemplate

public final 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.

Returns:

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.

force

public final 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.

Returns:

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.

clientRequestToken

public final String clientRequestToken()

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

Returns:

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

toBuilder

public UpdateNodegroupVersionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateNodegroupVersionRequest.Builder,UpdateNodegroupVersionRequest>

Specified by:

toBuilder in class EksRequest

builder

public static UpdateNodegroupVersionRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateNodegroupVersionRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo