software.amazon.awssdk.services.eks.model

Class CreateNodegroupRequest

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.CreateNodegroupRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateNodegroupRequest.Builder,CreateNodegroupRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateNodegroupRequest.Builder

Method Summary

Modifier and Type	Method and Description
AMITypes	amiType() The AMI type for your node group.
String	amiTypeAsString() The AMI type for your node group.
static CreateNodegroupRequest.Builder	builder()
String	clientRequestToken() Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
String	clusterName() The name of the cluster to create the node group in.
Integer	diskSize() The root device disk size (in GiB) for your node group instances.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasInstanceTypes() Returns true if the InstanceTypes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasLabels() Returns true if the Labels property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasSubnets() Returns true if the Subnets property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
List<String>	instanceTypes() The instance type to use for your node group.
Map<String,String>	labels() The Kubernetes labels to be applied to the nodes in the node group when they are created.
LaunchTemplateSpecification	launchTemplate() An object representing a node group's launch template specification.
String	nodegroupName() The unique name to give your node group.
String	nodeRole() The Amazon Resource Name (ARN) of the IAM role to associate with your node group.
String	releaseVersion() The AMI version of the Amazon EKS-optimized AMI to use with your node group.
RemoteAccessConfig	remoteAccess() The remote access (SSH) configuration to use with your node group.
NodegroupScalingConfig	scalingConfig() The scaling configuration details for the Auto Scaling group that is created for your node group.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateNodegroupRequest.Builder>	serializableBuilderClass()
List<String>	subnets() The subnets to use for the Auto Scaling group that is created for your node group.
Map<String,String>	tags() The metadata to apply to the node group to assist with categorization and organization.
CreateNodegroupRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	version() The Kubernetes version to use for your managed nodes.

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 String clusterName()

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

Returns:

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

nodegroupName

public String nodegroupName()

The unique name to give your node group.

Returns:

The unique name to give your node group.

scalingConfig

public NodegroupScalingConfig scalingConfig()

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.

diskSize

public Integer diskSize()

The root device disk size (in GiB) for your node group instances. The default disk size is 20 GiB. 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. 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.

hasSubnets

public boolean hasSubnets()

Returns true if the Subnets property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

subnets

public List<String> subnets()

The subnets to use for the Auto Scaling group that is created for your node group. These subnets must have the tag key kubernetes.io/cluster/CLUSTER_NAME with a value of shared, where CLUSTER_NAME is replaced with the name of your cluster. 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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasSubnets() to see if a value was sent in this field.

Returns:

The subnets to use for the Auto Scaling group that is created for your node group. These subnets must have the tag key kubernetes.io/cluster/CLUSTER_NAME with a value of shared, where CLUSTER_NAME is replaced with the name of your cluster. 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.

hasInstanceTypes

public boolean hasInstanceTypes()

Returns true if the InstanceTypes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

instanceTypes

public List<String> instanceTypes()

The instance type to use for your node group. You can specify a single instance type for a node group. The default value for instanceTypes is t3.medium. If you choose a GPU instance type, be sure to specify AL2_x86_64_GPU with the amiType parameter. If you specify launchTemplate, then don't specify instanceTypes, 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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasInstanceTypes() to see if a value was sent in this field.

Returns:

The instance type to use for your node group. You can specify a single instance type for a node group. The default value for instanceTypes is t3.medium. If you choose a GPU instance type, be sure to specify AL2_x86_64_GPU with the amiType parameter. If you specify launchTemplate, then don't specify instanceTypes, 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.

amiType

public AMITypes amiType()

The AMI type for your node group. GPU instance types should use the AL2_x86_64_GPU AMI type, which uses the Amazon EKS-optimized Linux AMI with GPU support. Non-GPU instances should use the AL2_x86_64 AMI type, which uses the Amazon EKS-optimized Linux AMI. If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify amiType, 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.

If the service returns an enum value that is not available in the current SDK version, amiType will return AMITypes.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from amiTypeAsString().

Returns:

The AMI type for your node group. GPU instance types should use the AL2_x86_64_GPU AMI type, which uses the Amazon EKS-optimized Linux AMI with GPU support. Non-GPU instances should use the AL2_x86_64 AMI type, which uses the Amazon EKS-optimized Linux AMI. If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify amiType, 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.

See Also:

AMITypes

amiTypeAsString

public String amiTypeAsString()

The AMI type for your node group. GPU instance types should use the AL2_x86_64_GPU AMI type, which uses the Amazon EKS-optimized Linux AMI with GPU support. Non-GPU instances should use the AL2_x86_64 AMI type, which uses the Amazon EKS-optimized Linux AMI. If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify amiType, 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.

If the service returns an enum value that is not available in the current SDK version, amiType will return AMITypes.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from amiTypeAsString().

Returns:

The AMI type for your node group. GPU instance types should use the AL2_x86_64_GPU AMI type, which uses the Amazon EKS-optimized Linux AMI with GPU support. Non-GPU instances should use the AL2_x86_64 AMI type, which uses the Amazon EKS-optimized Linux AMI. If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify amiType, 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.

See Also:

AMITypes

remoteAccess

public RemoteAccessConfig remoteAccess()

The remote access (SSH) configuration to use with your node group. 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 (SSH) configuration to use with your node group. 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.

nodeRole

public 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 AWS APIs on your behalf. Worker nodes receive permissions for these API calls through an IAM instance profile and associated policies. Before you can launch worker nodes and register them into a cluster, you must create an IAM role for those worker nodes to use when they are launched. For more information, see Amazon EKS Worker 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 AWS APIs on your behalf. Worker nodes receive permissions for these API calls through an IAM instance profile and associated policies. Before you can launch worker nodes and register them into a cluster, you must create an IAM role for those worker nodes to use when they are launched. For more information, see Amazon EKS Worker 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.

hasLabels

public boolean hasLabels()

Returns true if the Labels property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

labels

public Map<String,String> labels()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasLabels() to see if a value was sent in this field.

Returns:

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

hasTags

public boolean hasTags()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tags

public 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, both of which you define. Node group tags do not propagate to any other resources associated with the node group, such as the Amazon EC2 instances or subnets.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasTags() to see if a value was sent in this field.

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, both of which you define. Node group tags do not propagate to any other resources associated with the node group, such as the Amazon EC2 instances or subnets.

clientRequestToken

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

launchTemplate

public LaunchTemplateSpecification launchTemplate()

An object representing a node group's launch template specification. If specified, then do not specify instanceTypes, diskSize, or remoteAccess. If specified, 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. If specified, make sure that the launch template meets the requirements in launchTemplateSpecification.

version

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

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.

releaseVersion

public 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 more information, see Amazon EKS-Optimized Linux 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 more information, see Amazon EKS-Optimized Linux 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.

toBuilder

public CreateNodegroupRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateNodegroupRequest.Builder,CreateNodegroupRequest>

Specified by:

toBuilder in class EksRequest

builder

public static CreateNodegroupRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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

getValueForField

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

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo