com.amazonaws.services.eks.model

Class UpdateNodegroupVersionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.eks.model.UpdateNodegroupVersionRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateNodegroupVersionRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateNodegroupVersionRequest()

Method Summary

Modifier and Type	Method and Description
UpdateNodegroupVersionRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getClientRequestToken() A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
String	getClusterName() The name of your cluster.
Boolean	getForce() Force the update if any Pod on the existing node group can't be drained due to a Pod disruption budget issue.
LaunchTemplateSpecification	getLaunchTemplate() An object representing a node group's launch template specification.
String	getNodegroupName() The name of the managed node group to update.
String	getReleaseVersion() The AMI version of the Amazon EKS optimized AMI to use for the update.
String	getVersion() The Kubernetes version to update to.
int	hashCode()
Boolean	isForce() Force the update if any Pod on the existing node group can't be drained due to a Pod disruption budget issue.
void	setClientRequestToken(String clientRequestToken) A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
void	setClusterName(String clusterName) The name of your cluster.
void	setForce(Boolean force) Force the update if any Pod on the existing node group can't be drained due to a Pod disruption budget issue.
void	setLaunchTemplate(LaunchTemplateSpecification launchTemplate) An object representing a node group's launch template specification.
void	setNodegroupName(String nodegroupName) The name of the managed node group to update.
void	setReleaseVersion(String releaseVersion) The AMI version of the Amazon EKS optimized AMI to use for the update.
void	setVersion(String version) The Kubernetes version to update to.
String	toString() Returns a string representation of this object.
UpdateNodegroupVersionRequest	withClientRequestToken(String clientRequestToken) A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
UpdateNodegroupVersionRequest	withClusterName(String clusterName) The name of your cluster.
UpdateNodegroupVersionRequest	withForce(Boolean force) Force the update if any Pod on the existing node group can't be drained due to a Pod disruption budget issue.
UpdateNodegroupVersionRequest	withLaunchTemplate(LaunchTemplateSpecification launchTemplate) An object representing a node group's launch template specification.
UpdateNodegroupVersionRequest	withNodegroupName(String nodegroupName) The name of the managed node group to update.
UpdateNodegroupVersionRequest	withReleaseVersion(String releaseVersion) The AMI version of the Amazon EKS optimized AMI to use for the update.
UpdateNodegroupVersionRequest	withVersion(String version) The Kubernetes version to update to.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateNodegroupVersionRequest

public UpdateNodegroupVersionRequest()

Method Detail

setClusterName

public void setClusterName(String clusterName)

The name of your cluster.

Parameters:

clusterName - The name of your cluster.

getClusterName

public String getClusterName()

The name of your cluster.

Returns:

The name of your cluster.

withClusterName

public UpdateNodegroupVersionRequest withClusterName(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.

setNodegroupName

public void setNodegroupName(String nodegroupName)

The name of the managed node group to update.

Parameters:

nodegroupName - The name of the managed node group to update.

getNodegroupName

public String getNodegroupName()

The name of the managed node group to update.

Returns:

The name of the managed node group to update.

withNodegroupName

public UpdateNodegroupVersionRequest withNodegroupName(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.

setVersion

public void setVersion(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.

getVersion

public String getVersion()

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.

withVersion

public UpdateNodegroupVersionRequest withVersion(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.

setReleaseVersion

public void setReleaseVersion(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.

getReleaseVersion

public String getReleaseVersion()

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.

withReleaseVersion

public UpdateNodegroupVersionRequest withReleaseVersion(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.

setLaunchTemplate

public void setLaunchTemplate(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.

getLaunchTemplate

public LaunchTemplateSpecification getLaunchTemplate()

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.

withLaunchTemplate

public UpdateNodegroupVersionRequest withLaunchTemplate(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.

setForce

public void setForce(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.

getForce

public Boolean getForce()

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:

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.

withForce

public UpdateNodegroupVersionRequest withForce(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.

isForce

public Boolean isForce()

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:

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.

setClientRequestToken

public void setClientRequestToken(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.

getClientRequestToken

public String getClientRequestToken()

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

Returns:

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

withClientRequestToken

public UpdateNodegroupVersionRequest withClientRequestToken(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.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public UpdateNodegroupVersionRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()