com.amazonaws.services.eks.model

Class CreateNodegroupRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.eks.model.CreateNodegroupRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateNodegroupRequest
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
CreateNodegroupRequest()

Method Summary

Modifier and Type	Method and Description
CreateNodegroupRequest	addLabelsEntry(String key, String value) Add a single Labels entry
CreateNodegroupRequest	addTagsEntry(String key, String value) Add a single Tags entry
CreateNodegroupRequest	clearLabelsEntries() Removes all the entries added into Labels.
CreateNodegroupRequest	clearTagsEntries() Removes all the entries added into Tags.
CreateNodegroupRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAmiType() The AMI type for your node group.
String	getCapacityType() The capacity type for your node group.
String	getClientRequestToken() Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
String	getClusterName() The name of the cluster to create the node group in.
Integer	getDiskSize() The root device disk size (in GiB) for your node group instances.
List<String>	getInstanceTypes() Specify the instance types for a node group.
Map<String,String>	getLabels() The Kubernetes labels to be applied to the nodes in the node group when they are created.
LaunchTemplateSpecification	getLaunchTemplate() An object representing a node group's launch template specification.
String	getNodegroupName() The unique name to give your node group.
String	getNodeRole() The Amazon Resource Name (ARN) of the IAM role to associate with your node group.
String	getReleaseVersion() The AMI version of the Amazon EKS optimized AMI to use with your node group.
RemoteAccessConfig	getRemoteAccess() The remote access configuration to use with your node group.
NodegroupScalingConfig	getScalingConfig() The scaling configuration details for the Auto Scaling group that is created for your node group.
List<String>	getSubnets() The subnets to use for the Auto Scaling group that is created for your node group.
Map<String,String>	getTags() The metadata to apply to the node group to assist with categorization and organization.
List<Taint>	getTaints() The Kubernetes taints to be applied to the nodes in the node group.
NodegroupUpdateConfig	getUpdateConfig() The node group update configuration.
String	getVersion() The Kubernetes version to use for your managed nodes.
int	hashCode()
void	setAmiType(String amiType) The AMI type for your node group.
void	setCapacityType(String capacityType) The capacity type for your node group.
void	setClientRequestToken(String clientRequestToken) Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
void	setClusterName(String clusterName) The name of the cluster to create the node group in.
void	setDiskSize(Integer diskSize) The root device disk size (in GiB) for your node group instances.
void	setInstanceTypes(Collection<String> instanceTypes) Specify the instance types for a node group.
void	setLabels(Map<String,String> labels) The Kubernetes labels to be applied to the nodes in the node group when they are created.
void	setLaunchTemplate(LaunchTemplateSpecification launchTemplate) An object representing a node group's launch template specification.
void	setNodegroupName(String nodegroupName) The unique name to give your node group.
void	setNodeRole(String nodeRole) The Amazon Resource Name (ARN) of the IAM role to associate with your node group.
void	setReleaseVersion(String releaseVersion) The AMI version of the Amazon EKS optimized AMI to use with your node group.
void	setRemoteAccess(RemoteAccessConfig remoteAccess) The remote access configuration to use with your node group.
void	setScalingConfig(NodegroupScalingConfig scalingConfig) The scaling configuration details for the Auto Scaling group that is created for your node group.
void	setSubnets(Collection<String> subnets) The subnets to use for the Auto Scaling group that is created for your node group.
void	setTags(Map<String,String> tags) The metadata to apply to the node group to assist with categorization and organization.
void	setTaints(Collection<Taint> taints) The Kubernetes taints to be applied to the nodes in the node group.
void	setUpdateConfig(NodegroupUpdateConfig updateConfig) The node group update configuration.
void	setVersion(String version) The Kubernetes version to use for your managed nodes.
String	toString() Returns a string representation of this object.
CreateNodegroupRequest	withAmiType(AMITypes amiType) The AMI type for your node group.
CreateNodegroupRequest	withAmiType(String amiType) The AMI type for your node group.
CreateNodegroupRequest	withCapacityType(CapacityTypes capacityType) The capacity type for your node group.
CreateNodegroupRequest	withCapacityType(String capacityType) The capacity type for your node group.
CreateNodegroupRequest	withClientRequestToken(String clientRequestToken) Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
CreateNodegroupRequest	withClusterName(String clusterName) The name of the cluster to create the node group in.
CreateNodegroupRequest	withDiskSize(Integer diskSize) The root device disk size (in GiB) for your node group instances.
CreateNodegroupRequest	withInstanceTypes(Collection<String> instanceTypes) Specify the instance types for a node group.
CreateNodegroupRequest	withInstanceTypes(String... instanceTypes) Specify the instance types for a node group.
CreateNodegroupRequest	withLabels(Map<String,String> labels) The Kubernetes labels to be applied to the nodes in the node group when they are created.
CreateNodegroupRequest	withLaunchTemplate(LaunchTemplateSpecification launchTemplate) An object representing a node group's launch template specification.
CreateNodegroupRequest	withNodegroupName(String nodegroupName) The unique name to give your node group.
CreateNodegroupRequest	withNodeRole(String nodeRole) The Amazon Resource Name (ARN) of the IAM role to associate with your node group.
CreateNodegroupRequest	withReleaseVersion(String releaseVersion) The AMI version of the Amazon EKS optimized AMI to use with your node group.
CreateNodegroupRequest	withRemoteAccess(RemoteAccessConfig remoteAccess) The remote access configuration to use with your node group.
CreateNodegroupRequest	withScalingConfig(NodegroupScalingConfig scalingConfig) The scaling configuration details for the Auto Scaling group that is created for your node group.
CreateNodegroupRequest	withSubnets(Collection<String> subnets) The subnets to use for the Auto Scaling group that is created for your node group.
CreateNodegroupRequest	withSubnets(String... subnets) The subnets to use for the Auto Scaling group that is created for your node group.
CreateNodegroupRequest	withTags(Map<String,String> tags) The metadata to apply to the node group to assist with categorization and organization.
CreateNodegroupRequest	withTaints(Collection<Taint> taints) The Kubernetes taints to be applied to the nodes in the node group.
CreateNodegroupRequest	withTaints(Taint... taints) The Kubernetes taints to be applied to the nodes in the node group.
CreateNodegroupRequest	withUpdateConfig(NodegroupUpdateConfig updateConfig) The node group update configuration.
CreateNodegroupRequest	withVersion(String version) The Kubernetes version to use for your managed nodes.

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

CreateNodegroupRequest

public CreateNodegroupRequest()

Method Detail

setClusterName

public void setClusterName(String clusterName)

The name of the cluster to create the node group in.

Parameters:

clusterName - The name of the cluster to create the node group in.

getClusterName

public String getClusterName()

The name of the cluster to create the node group in.

Returns:

The name of the cluster to create the node group in.

withClusterName

public CreateNodegroupRequest withClusterName(String clusterName)

The name of the cluster to create the node group in.

Parameters:

clusterName - The name of the cluster to create the node group in.

Returns:

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

setNodegroupName

public void setNodegroupName(String nodegroupName)

The unique name to give your node group.

Parameters:

nodegroupName - The unique name to give your node group.

getNodegroupName

public String getNodegroupName()

The unique name to give your node group.

Returns:

The unique name to give your node group.

withNodegroupName

public CreateNodegroupRequest withNodegroupName(String nodegroupName)

The unique name to give your node group.

Parameters:

nodegroupName - The unique name to give your node group.

Returns:

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

setScalingConfig

public void setScalingConfig(NodegroupScalingConfig scalingConfig)

The scaling configuration details for the Auto Scaling group that is created for your node group.

Parameters:

scalingConfig - The scaling configuration details for the Auto Scaling group that is created for your node group.

getScalingConfig

public NodegroupScalingConfig getScalingConfig()

The scaling configuration details for the Auto Scaling group that is created for your node group.

Returns:

The scaling configuration details for the Auto Scaling group that is created for your node group.

withScalingConfig

public CreateNodegroupRequest withScalingConfig(NodegroupScalingConfig scalingConfig)

The scaling configuration details for the Auto Scaling group that is created for your node group.

Parameters:

scalingConfig - The scaling configuration details for the Auto Scaling group that is created for your node group.

Returns:

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

setDiskSize

public void setDiskSize(Integer diskSize)

The root device disk size (in GiB) for your node group instances. The default disk size is 20 GiB for Linux and Bottlerocket. The default disk size is 50 GiB for Windows. If you specify launchTemplate, then don't specify diskSize, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

Parameters:

diskSize - The root device disk size (in GiB) for your node group instances. The default disk size is 20 GiB for Linux and Bottlerocket. The default disk size is 50 GiB for Windows. If you specify launchTemplate, then don't specify diskSize, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

getDiskSize

public Integer getDiskSize()

The root device disk size (in GiB) for your node group instances. The default disk size is 20 GiB for Linux and Bottlerocket. The default disk size is 50 GiB for Windows. If you specify launchTemplate, then don't specify diskSize, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

Returns:

The root device disk size (in GiB) for your node group instances. The default disk size is 20 GiB for Linux and Bottlerocket. The default disk size is 50 GiB for Windows. If you specify launchTemplate, then don't specify diskSize, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

withDiskSize

public CreateNodegroupRequest withDiskSize(Integer diskSize)

The root device disk size (in GiB) for your node group instances. The default disk size is 20 GiB for Linux and Bottlerocket. The default disk size is 50 GiB for Windows. If you specify launchTemplate, then don't specify diskSize, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

Parameters:

diskSize - The root device disk size (in GiB) for your node group instances. The default disk size is 20 GiB for Linux and Bottlerocket. The default disk size is 50 GiB for Windows. If you specify launchTemplate, then don't specify diskSize, or the node group deployment 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.

getSubnets

public List<String> getSubnets()

The subnets to use for the Auto Scaling group that is created for your node group. If you specify launchTemplate, then don't specify SubnetId in your launch template, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

Returns:

The subnets to use for the Auto Scaling group that is created for your node group. If you specify launchTemplate, then don't specify SubnetId in your launch template, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

setSubnets

public void setSubnets(Collection<String> subnets)

The subnets to use for the Auto Scaling group that is created for your node group. If you specify launchTemplate, then don't specify SubnetId in your launch template, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

Parameters:

subnets - The subnets to use for the Auto Scaling group that is created for your node group. If you specify launchTemplate, then don't specify SubnetId in your launch template, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

withSubnets

public CreateNodegroupRequest withSubnets(String... subnets)

The subnets to use for the Auto Scaling group that is created for your node group. If you specify launchTemplate, then don't specify SubnetId in your launch template, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

NOTE: This method appends the values to the existing list (if any). Use setSubnets(java.util.Collection) or withSubnets(java.util.Collection) if you want to override the existing values.

Parameters:

subnets - The subnets to use for the Auto Scaling group that is created for your node group. If you specify launchTemplate, then don't specify SubnetId in your launch template, or the node group deployment 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.

withSubnets

public CreateNodegroupRequest withSubnets(Collection<String> subnets)

The subnets to use for the Auto Scaling group that is created for your node group. If you specify launchTemplate, then don't specify SubnetId in your launch template, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

Parameters:

subnets - The subnets to use for the Auto Scaling group that is created for your node group. If you specify launchTemplate, then don't specify SubnetId in your launch template, or the node group deployment 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.

getInstanceTypes

public List<String> getInstanceTypes()

Specify the instance types for a node group. If you specify a GPU instance type, make sure to also specify an applicable GPU AMI type with the amiType parameter. If you specify launchTemplate, then you can specify zero or one instance type in your launch template or you can specify 0-20 instance types for instanceTypes. If however, you specify an instance type in your launch template and specify any instanceTypes, the node group deployment will fail. If you don't specify an instance type in a launch template or for instanceTypes, then t3.medium is used, by default. If you specify Spot for capacityType, then we recommend specifying multiple values for instanceTypes. For more information, see Managed node group capacity types and Launch template support in the Amazon EKS User Guide.

Returns:

Specify the instance types for a node group. If you specify a GPU instance type, make sure to also specify an applicable GPU AMI type with the amiType parameter. If you specify launchTemplate, then you can specify zero or one instance type in your launch template or you can specify 0-20 instance types for instanceTypes. If however, you specify an instance type in your launch template and specify any instanceTypes, the node group deployment will fail. If you don't specify an instance type in a launch template or for instanceTypes, then t3.medium is used, by default. If you specify Spot for capacityType, then we recommend specifying multiple values for instanceTypes. For more information, see Managed node group capacity types and Launch template support in the Amazon EKS User Guide.

setInstanceTypes

public void setInstanceTypes(Collection<String> instanceTypes)

Specify the instance types for a node group. If you specify a GPU instance type, make sure to also specify an applicable GPU AMI type with the amiType parameter. If you specify launchTemplate, then you can specify zero or one instance type in your launch template or you can specify 0-20 instance types for instanceTypes. If however, you specify an instance type in your launch template and specify any instanceTypes, the node group deployment will fail. If you don't specify an instance type in a launch template or for instanceTypes, then t3.medium is used, by default. If you specify Spot for capacityType, then we recommend specifying multiple values for instanceTypes. For more information, see Managed node group capacity types and Launch template support in the Amazon EKS User Guide.

Parameters:

instanceTypes - Specify the instance types for a node group. If you specify a GPU instance type, make sure to also specify an applicable GPU AMI type with the amiType parameter. If you specify launchTemplate, then you can specify zero or one instance type in your launch template or you can specify 0-20 instance types for instanceTypes. If however, you specify an instance type in your launch template and specify any instanceTypes, the node group deployment will fail. If you don't specify an instance type in a launch template or for instanceTypes, then t3.medium is used, by default. If you specify Spot for capacityType, then we recommend specifying multiple values for instanceTypes. For more information, see Managed node group capacity types and Launch template support in the Amazon EKS User Guide.

withInstanceTypes

public CreateNodegroupRequest withInstanceTypes(String... instanceTypes)

Specify the instance types for a node group. If you specify a GPU instance type, make sure to also specify an applicable GPU AMI type with the amiType parameter. If you specify launchTemplate, then you can specify zero or one instance type in your launch template or you can specify 0-20 instance types for instanceTypes. If however, you specify an instance type in your launch template and specify any instanceTypes, the node group deployment will fail. If you don't specify an instance type in a launch template or for instanceTypes, then t3.medium is used, by default. If you specify Spot for capacityType, then we recommend specifying multiple values for instanceTypes. For more information, see Managed node group capacity types and Launch template support in the Amazon EKS User Guide.

NOTE: This method appends the values to the existing list (if any). Use setInstanceTypes(java.util.Collection) or withInstanceTypes(java.util.Collection) if you want to override the existing values.

Parameters:

instanceTypes - Specify the instance types for a node group. If you specify a GPU instance type, make sure to also specify an applicable GPU AMI type with the amiType parameter. If you specify launchTemplate, then you can specify zero or one instance type in your launch template or you can specify 0-20 instance types for instanceTypes. If however, you specify an instance type in your launch template and specify any instanceTypes, the node group deployment will fail. If you don't specify an instance type in a launch template or for instanceTypes, then t3.medium is used, by default. If you specify Spot for capacityType, then we recommend specifying multiple values for instanceTypes. For more information, see Managed node group capacity types and Launch template support in the Amazon EKS User Guide.

Returns:

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

withInstanceTypes

public CreateNodegroupRequest withInstanceTypes(Collection<String> instanceTypes)

Specify the instance types for a node group. If you specify a GPU instance type, make sure to also specify an applicable GPU AMI type with the amiType parameter. If you specify launchTemplate, then you can specify zero or one instance type in your launch template or you can specify 0-20 instance types for instanceTypes. If however, you specify an instance type in your launch template and specify any instanceTypes, the node group deployment will fail. If you don't specify an instance type in a launch template or for instanceTypes, then t3.medium is used, by default. If you specify Spot for capacityType, then we recommend specifying multiple values for instanceTypes. For more information, see Managed node group capacity types and Launch template support in the Amazon EKS User Guide.

Parameters:

instanceTypes - Specify the instance types for a node group. If you specify a GPU instance type, make sure to also specify an applicable GPU AMI type with the amiType parameter. If you specify launchTemplate, then you can specify zero or one instance type in your launch template or you can specify 0-20 instance types for instanceTypes. If however, you specify an instance type in your launch template and specify any instanceTypes, the node group deployment will fail. If you don't specify an instance type in a launch template or for instanceTypes, then t3.medium is used, by default. If you specify Spot for capacityType, then we recommend specifying multiple values for instanceTypes. For more information, see Managed node group capacity types and Launch template support in the Amazon EKS User Guide.

Returns:

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

setAmiType

public void setAmiType(String amiType)

The AMI type for your node group. If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify amiType, or the node group deployment will fail. If your launch template uses a Windows custom AMI, then add eks:kube-proxy-windows to your Windows nodes rolearn in the aws-auth ConfigMap. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

Parameters:

amiType - The AMI type for your node group. If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify amiType, or the node group deployment will fail. If your launch template uses a Windows custom AMI, then add eks:kube-proxy-windows to your Windows nodes rolearn in the aws-auth ConfigMap. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

See Also:

AMITypes

getAmiType

public String getAmiType()

The AMI type for your node group. If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify amiType, or the node group deployment will fail. If your launch template uses a Windows custom AMI, then add eks:kube-proxy-windows to your Windows nodes rolearn in the aws-auth ConfigMap. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

Returns:

The AMI type for your node group. If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify amiType, or the node group deployment will fail. If your launch template uses a Windows custom AMI, then add eks:kube-proxy-windows to your Windows nodes rolearn in the aws-auth ConfigMap. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

See Also:

AMITypes

withAmiType

public CreateNodegroupRequest withAmiType(String amiType)

The AMI type for your node group. If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify amiType, or the node group deployment will fail. If your launch template uses a Windows custom AMI, then add eks:kube-proxy-windows to your Windows nodes rolearn in the aws-auth ConfigMap. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

Parameters:

amiType - The AMI type for your node group. If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify amiType, or the node group deployment will fail. If your launch template uses a Windows custom AMI, then add eks:kube-proxy-windows to your Windows nodes rolearn in the aws-auth ConfigMap. 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.

See Also:

AMITypes

withAmiType

public CreateNodegroupRequest withAmiType(AMITypes amiType)

The AMI type for your node group. If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify amiType, or the node group deployment will fail. If your launch template uses a Windows custom AMI, then add eks:kube-proxy-windows to your Windows nodes rolearn in the aws-auth ConfigMap. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

Parameters:

amiType - The AMI type for your node group. If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify amiType, or the node group deployment will fail. If your launch template uses a Windows custom AMI, then add eks:kube-proxy-windows to your Windows nodes rolearn in the aws-auth ConfigMap. 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.

See Also:

AMITypes

setRemoteAccess

public void setRemoteAccess(RemoteAccessConfig remoteAccess)

The remote access configuration to use with your node group. For Linux, the protocol is SSH. For Windows, the protocol is RDP. If you specify launchTemplate, then don't specify remoteAccess, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

Parameters:

remoteAccess - The remote access configuration to use with your node group. For Linux, the protocol is SSH. For Windows, the protocol is RDP. If you specify launchTemplate, then don't specify remoteAccess, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

getRemoteAccess

public RemoteAccessConfig getRemoteAccess()

The remote access configuration to use with your node group. For Linux, the protocol is SSH. For Windows, the protocol is RDP. If you specify launchTemplate, then don't specify remoteAccess, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

Returns:

The remote access configuration to use with your node group. For Linux, the protocol is SSH. For Windows, the protocol is RDP. If you specify launchTemplate, then don't specify remoteAccess, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

withRemoteAccess

public CreateNodegroupRequest withRemoteAccess(RemoteAccessConfig remoteAccess)

The remote access configuration to use with your node group. For Linux, the protocol is SSH. For Windows, the protocol is RDP. If you specify launchTemplate, then don't specify remoteAccess, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

Parameters:

remoteAccess - The remote access configuration to use with your node group. For Linux, the protocol is SSH. For Windows, the protocol is RDP. If you specify launchTemplate, then don't specify remoteAccess, or the node group deployment 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.

setNodeRole

public void setNodeRole(String nodeRole)

The Amazon Resource Name (ARN) of the IAM role to associate with your node group. The Amazon EKS worker node kubelet daemon makes calls to Amazon Web Services APIs on your behalf. Nodes receive permissions for these API calls through an IAM instance profile and associated policies. Before you can launch nodes and register them into a cluster, you must create an IAM role for those nodes to use when they are launched. For more information, see Amazon EKS node IAM role in the Amazon EKS User Guide . If you specify launchTemplate, then don't specify IamInstanceProfile in your launch template, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

Parameters:

nodeRole - The Amazon Resource Name (ARN) of the IAM role to associate with your node group. The Amazon EKS worker node kubelet daemon makes calls to Amazon Web Services APIs on your behalf. Nodes receive permissions for these API calls through an IAM instance profile and associated policies. Before you can launch nodes and register them into a cluster, you must create an IAM role for those nodes to use when they are launched. For more information, see Amazon EKS node IAM role in the Amazon EKS User Guide . If you specify launchTemplate, then don't specify IamInstanceProfile in your launch template, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

getNodeRole

public String getNodeRole()

The Amazon Resource Name (ARN) of the IAM role to associate with your node group. The Amazon EKS worker node kubelet daemon makes calls to Amazon Web Services APIs on your behalf. Nodes receive permissions for these API calls through an IAM instance profile and associated policies. Before you can launch nodes and register them into a cluster, you must create an IAM role for those nodes to use when they are launched. For more information, see Amazon EKS node IAM role in the Amazon EKS User Guide . If you specify launchTemplate, then don't specify IamInstanceProfile in your launch template, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

Returns:

The Amazon Resource Name (ARN) of the IAM role to associate with your node group. The Amazon EKS worker node kubelet daemon makes calls to Amazon Web Services APIs on your behalf. Nodes receive permissions for these API calls through an IAM instance profile and associated policies. Before you can launch nodes and register them into a cluster, you must create an IAM role for those nodes to use when they are launched. For more information, see Amazon EKS node IAM role in the Amazon EKS User Guide . If you specify launchTemplate, then don't specify IamInstanceProfile in your launch template, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

withNodeRole

public CreateNodegroupRequest withNodeRole(String nodeRole)

The Amazon Resource Name (ARN) of the IAM role to associate with your node group. The Amazon EKS worker node kubelet daemon makes calls to Amazon Web Services APIs on your behalf. Nodes receive permissions for these API calls through an IAM instance profile and associated policies. Before you can launch nodes and register them into a cluster, you must create an IAM role for those nodes to use when they are launched. For more information, see Amazon EKS node IAM role in the Amazon EKS User Guide . If you specify launchTemplate, then don't specify IamInstanceProfile in your launch template, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

Parameters:

nodeRole - The Amazon Resource Name (ARN) of the IAM role to associate with your node group. The Amazon EKS worker node kubelet daemon makes calls to Amazon Web Services APIs on your behalf. Nodes receive permissions for these API calls through an IAM instance profile and associated policies. Before you can launch nodes and register them into a cluster, you must create an IAM role for those nodes to use when they are launched. For more information, see Amazon EKS node IAM role in the Amazon EKS User Guide . If you specify launchTemplate, then don't specify IamInstanceProfile in your launch template, or the node group deployment 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.

getLabels

public Map<String,String> getLabels()

The Kubernetes labels to be applied to the nodes in the node group when they are created.

Returns:

The Kubernetes labels to be applied to the nodes in the node group when they are created.

setLabels

public void setLabels(Map<String,String> labels)

The Kubernetes labels to be applied to the nodes in the node group when they are created.

Parameters:

labels - The Kubernetes labels to be applied to the nodes in the node group when they are created.

withLabels

public CreateNodegroupRequest withLabels(Map<String,String> labels)

The Kubernetes labels to be applied to the nodes in the node group when they are created.

Parameters:

labels - The Kubernetes labels to be applied to the nodes in the node group when they are created.

Returns:

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

addLabelsEntry

public CreateNodegroupRequest addLabelsEntry(String key,
                                             String value)

Add a single Labels entry

See Also:

withLabels(java.util.Map<java.lang.String, java.lang.String>)

clearLabelsEntries

public CreateNodegroupRequest clearLabelsEntries()

Removes all the entries added into Labels.

Returns:

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

getTaints

public List<Taint> getTaints()

The Kubernetes taints to be applied to the nodes in the node group. For more information, see Node taints on managed node groups.

Returns:

The Kubernetes taints to be applied to the nodes in the node group. For more information, see Node taints on managed node groups.

setTaints

public void setTaints(Collection<Taint> taints)

The Kubernetes taints to be applied to the nodes in the node group. For more information, see Node taints on managed node groups.

Parameters:

taints - The Kubernetes taints to be applied to the nodes in the node group. For more information, see Node taints on managed node groups.

withTaints

public CreateNodegroupRequest withTaints(Taint... taints)

The Kubernetes taints to be applied to the nodes in the node group. For more information, see Node taints on managed node groups.

NOTE: This method appends the values to the existing list (if any). Use setTaints(java.util.Collection) or withTaints(java.util.Collection) if you want to override the existing values.

Parameters:

taints - The Kubernetes taints to be applied to the nodes in the node group. For more information, see Node taints on managed node groups.

Returns:

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

withTaints

public CreateNodegroupRequest withTaints(Collection<Taint> taints)

The Kubernetes taints to be applied to the nodes in the node group. For more information, see Node taints on managed node groups.

Parameters:

taints - The Kubernetes taints to be applied to the nodes in the node group. For more information, see Node taints on managed node groups.

Returns:

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

getTags

public Map<String,String> getTags()

The metadata to apply to the node group to assist with categorization and organization. Each tag consists of a key and an optional value. You define both. Node group tags do not propagate to any other resources associated with the node group, such as the Amazon EC2 instances or subnets.

Returns:

The metadata to apply to the node group to assist with categorization and organization. Each tag consists of a key and an optional value. You define both. Node group tags do not propagate to any other resources associated with the node group, such as the Amazon EC2 instances or subnets.

setTags

public void setTags(Map<String,String> tags)

The metadata to apply to the node group to assist with categorization and organization. Each tag consists of a key and an optional value. You define both. Node group tags do not propagate to any other resources associated with the node group, such as the Amazon EC2 instances or subnets.

Parameters:

tags - The metadata to apply to the node group to assist with categorization and organization. Each tag consists of a key and an optional value. You define both. Node group tags do not propagate to any other resources associated with the node group, such as the Amazon EC2 instances or subnets.

withTags

public CreateNodegroupRequest withTags(Map<String,String> tags)

The metadata to apply to the node group to assist with categorization and organization. Each tag consists of a key and an optional value. You define both. Node group tags do not propagate to any other resources associated with the node group, such as the Amazon EC2 instances or subnets.

Parameters:

tags - The metadata to apply to the node group to assist with categorization and organization. Each tag consists of a key and an optional value. You define both. Node group tags do not propagate to any other resources associated with the node group, such as the Amazon EC2 instances or subnets.

Returns:

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

addTagsEntry

public CreateNodegroupRequest addTagsEntry(String key,
                                           String value)

Add a single Tags entry

See Also:

withTags(java.util.Map<java.lang.String, java.lang.String>)

clearTagsEntries

public CreateNodegroupRequest clearTagsEntries()

Removes all the entries added into Tags.

Returns:

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

setClientRequestToken

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

getClientRequestToken

public String getClientRequestToken()

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.

withClientRequestToken

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

setLaunchTemplate

public void setLaunchTemplate(LaunchTemplateSpecification launchTemplate)

An object representing a node group's launch template specification. If specified, then do not specify instanceTypes, diskSize, or remoteAccess and make sure that the launch template meets the requirements in launchTemplateSpecification.

Parameters:

launchTemplate - An object representing a node group's launch template specification. If specified, then do not specify instanceTypes, diskSize, or remoteAccess and make sure that the launch template meets the requirements in launchTemplateSpecification.

getLaunchTemplate

public LaunchTemplateSpecification getLaunchTemplate()

An object representing a node group's launch template specification. If specified, then do not specify instanceTypes, diskSize, or remoteAccess and make sure that the launch template meets the requirements in launchTemplateSpecification.

Returns:

An object representing a node group's launch template specification. If specified, then do not specify instanceTypes, diskSize, or remoteAccess and make sure that the launch template meets the requirements in launchTemplateSpecification.

withLaunchTemplate

public CreateNodegroupRequest withLaunchTemplate(LaunchTemplateSpecification launchTemplate)

An object representing a node group's launch template specification. If specified, then do not specify instanceTypes, diskSize, or remoteAccess and make sure that the launch template meets the requirements in launchTemplateSpecification.

Parameters:

launchTemplate - An object representing a node group's launch template specification. If specified, then do not specify instanceTypes, diskSize, or remoteAccess and make sure that the launch template meets the requirements in launchTemplateSpecification.

Returns:

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

setUpdateConfig

public void setUpdateConfig(NodegroupUpdateConfig updateConfig)

The node group update configuration.

Parameters:

updateConfig - The node group update configuration.

getUpdateConfig

public NodegroupUpdateConfig getUpdateConfig()

The node group update configuration.

Returns:

The node group update configuration.

withUpdateConfig

public CreateNodegroupRequest withUpdateConfig(NodegroupUpdateConfig updateConfig)

The node group update configuration.

Parameters:

updateConfig - The node group update configuration.

Returns:

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

setCapacityType

public void setCapacityType(String capacityType)

The capacity type for your node group.

Parameters:

capacityType - The capacity type for your node group.

See Also:

CapacityTypes

getCapacityType

public String getCapacityType()

The capacity type for your node group.

Returns:

The capacity type for your node group.

See Also:

CapacityTypes

withCapacityType

public CreateNodegroupRequest withCapacityType(String capacityType)

The capacity type for your node group.

Parameters:

capacityType - The capacity type for your node group.

Returns:

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

See Also:

CapacityTypes

withCapacityType

public CreateNodegroupRequest withCapacityType(CapacityTypes capacityType)

The capacity type for your node group.

Parameters:

capacityType - The capacity type for your node group.

Returns:

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

See Also:

CapacityTypes

setVersion

public void setVersion(String version)

The Kubernetes version to use for your managed nodes. By default, the Kubernetes version of the cluster is used, and this is the only accepted specified value. If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify version, or the node group deployment 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 use for your managed nodes. By default, the Kubernetes version of the cluster is used, and this is the only accepted specified value. If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify version, or the node group deployment 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 use for your managed nodes. By default, the Kubernetes version of the cluster is used, and this is the only accepted specified value. If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify version, or the node group deployment 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 use for your managed nodes. By default, the Kubernetes version of the cluster is used, and this is the only accepted specified value. If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify version, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

withVersion

public CreateNodegroupRequest withVersion(String version)

The Kubernetes version to use for your managed nodes. By default, the Kubernetes version of the cluster is used, and this is the only accepted specified value. If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify version, or the node group deployment 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 use for your managed nodes. By default, the Kubernetes version of the cluster is used, and this is the only accepted specified value. If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify version, or the node group deployment 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 with your node group. By default, the latest available AMI version for the node group's current 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 deployment 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 with your node group. By default, the latest available AMI version for the node group's current 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 deployment 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 with your node group. By default, the latest available AMI version for the node group's current 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 deployment 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 with your node group. By default, the latest available AMI version for the node group's current 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 deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

withReleaseVersion

public CreateNodegroupRequest withReleaseVersion(String releaseVersion)

The AMI version of the Amazon EKS optimized AMI to use with your node group. By default, the latest available AMI version for the node group's current 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 deployment 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 with your node group. By default, the latest available AMI version for the node group's current 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 deployment 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.

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 CreateNodegroupRequest 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()