Package 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 Details

    • clusterName

      CreateNodegroupRequest.Builder clusterName(String clusterName)

      The name of your cluster.

      Parameters:
      clusterName - The name of your cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • 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 method 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:

    • 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 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 Customizing managed nodes with launch templates 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 Customizing managed nodes with launch templates 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. 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 Customizing managed nodes with launch templates 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 Customizing managed nodes with launch templates 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. 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 Customizing managed nodes with launch templates 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 Customizing managed nodes with launch templates 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, 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 Customizing managed nodes with launch templates 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 Customizing managed nodes with launch templates 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, 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 Customizing managed nodes with launch templates 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 Customizing managed nodes with launch templates 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. 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 Customizing managed nodes with launch templates 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 Customizing managed nodes with launch templates in the Amazon EKS User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • amiType

      CreateNodegroupRequest.Builder amiType(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 Customizing managed nodes with launch templates 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 Customizing managed nodes with launch templates in the Amazon EKS User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • remoteAccess

      CreateNodegroupRequest.Builder remoteAccess(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 Customizing managed nodes with launch templates 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 Customizing managed nodes with launch templates 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 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 Customizing managed nodes with launch templates in the Amazon EKS User Guide.

      This is a convenience method 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:

    • 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 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 Customizing managed nodes with launch templates 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 Customizing managed nodes with launch templates 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 apply to the nodes in the node group when they are created.

      Parameters:
      labels - The Kubernetes labels to apply 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.

    • taints

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

    • taints

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

    • taints

      CreateNodegroupRequest.Builder taints(Consumer<Taint.Builder>... taints)

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

      This is a convenience method that creates an instance of the Taint.Builder avoiding the need to create one manually via Taint.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to taints(List<Taint>).

      Parameters:
      taints - a consumer that will call methods on Taint.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

      CreateNodegroupRequest.Builder tags(Map<String,String> tags)

      Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or Amazon Web Services resources.

      Parameters:
      tags - Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or Amazon Web Services resources.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientRequestToken

      CreateNodegroupRequest.Builder clientRequestToken(String clientRequestToken)

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

      Parameters:
      clientRequestToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • launchTemplate

      CreateNodegroupRequest.Builder launchTemplate(LaunchTemplateSpecification launchTemplate)

      An object representing a node group's launch template specification. When using this object, don't directly specify instanceTypes, diskSize, or remoteAccess. Make sure that the launch template meets the requirements in launchTemplateSpecification. Also refer to Customizing managed nodes with launch templates in the Amazon EKS User Guide.

      Parameters:
      launchTemplate - An object representing a node group's launch template specification. When using this object, don't directly specify instanceTypes, diskSize, or remoteAccess. Make sure that the launch template meets the requirements in launchTemplateSpecification. Also refer to Customizing managed nodes with launch templates in the Amazon EKS User Guide.
      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. When using this object, don't directly specify instanceTypes, diskSize, or remoteAccess. Make sure that the launch template meets the requirements in launchTemplateSpecification. Also refer to Customizing managed nodes with launch templates in the Amazon EKS User Guide.

      This is a convenience method 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:

    • updateConfig

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

    • updateConfig

      default CreateNodegroupRequest.Builder updateConfig(Consumer<NodegroupUpdateConfig.Builder> updateConfig)

      The node group update configuration.

      This is a convenience method that creates an instance of the NodegroupUpdateConfig.Builder avoiding the need to create one manually via NodegroupUpdateConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to updateConfig(NodegroupUpdateConfig).

      Parameters:
      updateConfig - a consumer that will call methods on NodegroupUpdateConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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:

    • 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:

    • 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 Customizing managed nodes with launch templates 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 Customizing managed nodes with launch templates 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 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 Customizing managed nodes with launch templates 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 Customizing managed nodes with launch templates 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)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateNodegroupRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.