software.amazon.awssdk.services.eks.model

Interface CreateNodegroupRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateNodegroupRequest.Builder,CreateNodegroupRequest>, EksRequest.Builder, SdkBuilder<CreateNodegroupRequest.Builder,CreateNodegroupRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateNodegroupRequest

public static interface CreateNodegroupRequest.Builder
extends EksRequest.Builder, SdkPojo, CopyableBuilder<CreateNodegroupRequest.Builder,CreateNodegroupRequest>

Method Summary

Modifier and Type	Method and Description
CreateNodegroupRequest.Builder	amiType(AMITypes amiType) The AMI type for your node group.
CreateNodegroupRequest.Builder	amiType(String amiType) The AMI type for your node group.
CreateNodegroupRequest.Builder	capacityType(CapacityTypes capacityType) The capacity type for your node group.
CreateNodegroupRequest.Builder	capacityType(String capacityType) The capacity type for your node group.
CreateNodegroupRequest.Builder	clientRequestToken(String clientRequestToken) Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
CreateNodegroupRequest.Builder	clusterName(String clusterName) The name of the cluster to create the node group in.
CreateNodegroupRequest.Builder	diskSize(Integer diskSize) The root device disk size (in GiB) for your node group instances.
CreateNodegroupRequest.Builder	instanceTypes(Collection<String> instanceTypes) Specify the instance types for a node group.
CreateNodegroupRequest.Builder	instanceTypes(String... instanceTypes) Specify the instance types for a node group.
CreateNodegroupRequest.Builder	labels(Map<String,String> labels) The Kubernetes labels to be applied to the nodes in the node group when they are created.
default CreateNodegroupRequest.Builder	launchTemplate(Consumer<LaunchTemplateSpecification.Builder> launchTemplate) An object representing a node group's launch template specification.
CreateNodegroupRequest.Builder	launchTemplate(LaunchTemplateSpecification launchTemplate) An object representing a node group's launch template specification.
CreateNodegroupRequest.Builder	nodegroupName(String nodegroupName) The unique name to give your node group.
CreateNodegroupRequest.Builder	nodeRole(String nodeRole) The Amazon Resource Name (ARN) of the IAM role to associate with your node group.
CreateNodegroupRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateNodegroupRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateNodegroupRequest.Builder	releaseVersion(String releaseVersion) The AMI version of the Amazon EKS optimized AMI to use with your node group.
default CreateNodegroupRequest.Builder	remoteAccess(Consumer<RemoteAccessConfig.Builder> remoteAccess) The remote access (SSH) configuration to use with your node group.
CreateNodegroupRequest.Builder	remoteAccess(RemoteAccessConfig remoteAccess) The remote access (SSH) configuration to use with your node group.
default CreateNodegroupRequest.Builder	scalingConfig(Consumer<NodegroupScalingConfig.Builder> scalingConfig) The scaling configuration details for the Auto Scaling group that is created for your node group.
CreateNodegroupRequest.Builder	scalingConfig(NodegroupScalingConfig scalingConfig) The scaling configuration details for the Auto Scaling group that is created for your node group.
CreateNodegroupRequest.Builder	subnets(Collection<String> subnets) The subnets to use for the Auto Scaling group that is created for your node group.
CreateNodegroupRequest.Builder	subnets(String... subnets) The subnets to use for the Auto Scaling group that is created for your node group.
CreateNodegroupRequest.Builder	tags(Map<String,String> tags) The metadata to apply to the node group to assist with categorization and organization.
CreateNodegroupRequest.Builder	version(String version) The Kubernetes version to use for your managed nodes.

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

build

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

overrideConfiguration

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

clusterName

CreateNodegroupRequest.Builder clusterName(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.

nodegroupName

CreateNodegroupRequest.Builder nodegroupName(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.

scalingConfig

CreateNodegroupRequest.Builder scalingConfig(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.

scalingConfig

default CreateNodegroupRequest.Builder scalingConfig(Consumer<NodegroupScalingConfig.Builder> scalingConfig)

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

This is a convenience that creates an instance of the NodegroupScalingConfig.Builder avoiding the need to create one manually via NodegroupScalingConfig.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to scalingConfig(NodegroupScalingConfig).

Parameters:

scalingConfig - a consumer that will call methods on NodegroupScalingConfig.Builder

Returns:

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

See Also:

scalingConfig(NodegroupScalingConfig)

diskSize

CreateNodegroupRequest.Builder diskSize(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.

Parameters:

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:

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

subnets

CreateNodegroupRequest.Builder subnets(Collection<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.

Parameters:

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.

Returns:

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

subnets

CreateNodegroupRequest.Builder subnets(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.

Parameters:

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.

Returns:

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

instanceTypes

CreateNodegroupRequest.Builder instanceTypes(Collection<String> instanceTypes)

Specify the instance types for a node group. If you specify a GPU instance type, be sure to specify AL2_x86_64_GPU 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, be sure to specify AL2_x86_64_GPU 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.

instanceTypes

CreateNodegroupRequest.Builder instanceTypes(String... instanceTypes)

Specify the instance types for a node group. If you specify a GPU instance type, be sure to specify AL2_x86_64_GPU 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, be sure to specify AL2_x86_64_GPU 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.

amiType

CreateNodegroupRequest.Builder amiType(String amiType)

The AMI type for your node group. GPU instance types should use the AL2_x86_64_GPU AMI type. Non-GPU instances should use the AL2_x86_64 AMI type. Arm instances should use the AL2_ARM_64 AMI type. All types use the Amazon EKS optimized Amazon Linux 2 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.

Parameters:

amiType - The AMI type for your node group. GPU instance types should use the AL2_x86_64_GPU AMI type. Non-GPU instances should use the AL2_x86_64 AMI type. Arm instances should use the AL2_ARM_64 AMI type. All types use the Amazon EKS optimized Amazon Linux 2 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.

Returns:

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

See Also:

AMITypes, AMITypes

amiType

CreateNodegroupRequest.Builder amiType(AMITypes amiType)

The AMI type for your node group. GPU instance types should use the AL2_x86_64_GPU AMI type. Non-GPU instances should use the AL2_x86_64 AMI type. Arm instances should use the AL2_ARM_64 AMI type. All types use the Amazon EKS optimized Amazon Linux 2 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.

Parameters:

amiType - The AMI type for your node group. GPU instance types should use the AL2_x86_64_GPU AMI type. Non-GPU instances should use the AL2_x86_64 AMI type. Arm instances should use the AL2_ARM_64 AMI type. All types use the Amazon EKS optimized Amazon Linux 2 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.

Returns:

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

See Also:

AMITypes, AMITypes

remoteAccess

CreateNodegroupRequest.Builder remoteAccess(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.

Parameters:

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:

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

remoteAccess

default CreateNodegroupRequest.Builder remoteAccess(Consumer<RemoteAccessConfig.Builder> 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.

This is a convenience that creates an instance of the RemoteAccessConfig.Builder avoiding the need to create one manually via RemoteAccessConfig.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to remoteAccess(RemoteAccessConfig).

Parameters:

remoteAccess - a consumer that will call methods on RemoteAccessConfig.Builder

Returns:

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

See Also:

remoteAccess(RemoteAccessConfig)

nodeRole

CreateNodegroupRequest.Builder nodeRole(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. 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 AWS 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.

labels

CreateNodegroupRequest.Builder labels(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.

tags

CreateNodegroupRequest.Builder tags(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.

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

Returns:

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

clientRequestToken

CreateNodegroupRequest.Builder clientRequestToken(String clientRequestToken)

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

Parameters:

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

Returns:

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

launchTemplate

CreateNodegroupRequest.Builder launchTemplate(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.

launchTemplate

default CreateNodegroupRequest.Builder launchTemplate(Consumer<LaunchTemplateSpecification.Builder> 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.

This is a convenience that creates an instance of the LaunchTemplateSpecification.Builder avoiding the need to create one manually via LaunchTemplateSpecification.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to launchTemplate(LaunchTemplateSpecification).

Parameters:

launchTemplate - a consumer that will call methods on LaunchTemplateSpecification.Builder

Returns:

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

See Also:

launchTemplate(LaunchTemplateSpecification)

capacityType

CreateNodegroupRequest.Builder capacityType(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, CapacityTypes

capacityType

CreateNodegroupRequest.Builder capacityType(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, CapacityTypes

version

CreateNodegroupRequest.Builder version(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.

releaseVersion

CreateNodegroupRequest.Builder releaseVersion(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 Amazon Linux 2 AMI versions in the Amazon EKS User Guide. If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify releaseVersion, or the node group 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 more information, see Amazon EKS optimized Amazon Linux 2 AMI versions in the Amazon EKS User Guide. If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify releaseVersion, or the node group 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.

overrideConfiguration

CreateNodegroupRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder