Package software.amazon.awscdk.services.eks

Class Nodegroup.Builder

java.lang.Object
software.amazon.awscdk.services.eks.Nodegroup.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<Nodegroup>
Enclosing class:
Nodegroup
@Stability(Stable) public static final class Nodegroup.Builder extends Object implements software.amazon.jsii.Builder<Nodegroup>
A fluent builder for Nodegroup.

  • Method Details

    • create

      @Stability(Stable) public static Nodegroup.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      Returns:
      a new instance of Nodegroup.Builder.

    • amiType

      @Stability(Stable) public Nodegroup.Builder amiType(NodegroupAmiType amiType)
      The AMI type for your node group.

      If you explicitly specify the launchTemplate with custom AMI, do not specify this property, or the node group deployment will fail. In other cases, you will need to specify correct amiType for the nodegroup.

      Default: - auto-determined from the instanceTypes property when launchTemplateSpec property is not specified

      Parameters:
      amiType - The AMI type for your node group. This parameter is required.
      Returns:
      this

    • capacityType

      @Stability(Stable) public Nodegroup.Builder capacityType(CapacityType capacityType)
      The capacity type of the nodegroup.

      Default: - ON_DEMAND

      Parameters:
      capacityType - The capacity type of the nodegroup. This parameter is required.
      Returns:
      this

    • desiredSize

      @Stability(Stable) public Nodegroup.Builder desiredSize(Number desiredSize)
      The current number of worker nodes that the managed node group should maintain.

      If not specified, the nodewgroup will initially create minSize instances.

      Default: 2

      Parameters:
      desiredSize - The current number of worker nodes that the managed node group should maintain. This parameter is required.
      Returns:
      this

    • diskSize

      @Stability(Stable) public Nodegroup.Builder diskSize(Number diskSize)
      The root device disk size (in GiB) for your node group instances.

      Default: 20

      Parameters:
      diskSize - The root device disk size (in GiB) for your node group instances. This parameter is required.
      Returns:
      this

    • forceUpdate

      @Stability(Stable) public Nodegroup.Builder forceUpdate(Boolean forceUpdate)
      Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue.

      If an update fails because pods could not be drained, you can force the update after it fails to terminate the old node whether or not any pods are running on the node.

      Default: true

      Parameters:
      forceUpdate - Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. This parameter is required.
      Returns:
      this

    • instanceTypes

      @Stability(Stable) public Nodegroup.Builder instanceTypes(List<? extends InstanceType> instanceTypes)
      The instance types to use for your node group.

      Default: t3.medium will be used according to the cloudformation document.

      Parameters:
      instanceTypes - The instance types to use for your node group. This parameter is required.
      Returns:
      this
      See Also:

    • labels

      @Stability(Stable) public Nodegroup.Builder labels(Map<String,String> labels)
      The Kubernetes labels to be applied to the nodes in the node group when they are created.

      Default: - None

      Parameters:
      labels - The Kubernetes labels to be applied to the nodes in the node group when they are created. This parameter is required.
      Returns:
      this

    • launchTemplateSpec

      @Stability(Stable) public Nodegroup.Builder launchTemplateSpec(LaunchTemplateSpec launchTemplateSpec)
      Launch template specification used for the nodegroup.

      Default: - no launch template

      Parameters:
      launchTemplateSpec - Launch template specification used for the nodegroup. This parameter is required.
      Returns:
      this
      See Also:

    • maxSize

      @Stability(Stable) public Nodegroup.Builder maxSize(Number maxSize)
      The maximum number of worker nodes that the managed node group can scale out to.

      Managed node groups can support up to 100 nodes by default.

      Default: - desiredSize

      Parameters:
      maxSize - The maximum number of worker nodes that the managed node group can scale out to. This parameter is required.
      Returns:
      this

    • maxUnavailable

      @Stability(Stable) public Nodegroup.Builder maxUnavailable(Number maxUnavailable)
      The maximum number of nodes unavailable at once during a version update.

      Nodes will be updated in parallel. The maximum number is 100.

      This value or maxUnavailablePercentage is required to have a value for custom update configurations to be applied.

      Default: 1

      Parameters:
      maxUnavailable - The maximum number of nodes unavailable at once during a version update. This parameter is required.
      Returns:
      this
      See Also:

    • maxUnavailablePercentage

      @Stability(Stable) public Nodegroup.Builder maxUnavailablePercentage(Number maxUnavailablePercentage)
      The maximum percentage of nodes unavailable during a version update.

      This percentage of nodes will be updated in parallel, up to 100 nodes at once.

      This value or maxUnavailable is required to have a value for custom update configurations to be applied.

      Default: undefined - node groups will update instances one at a time

      Parameters:
      maxUnavailablePercentage - The maximum percentage of nodes unavailable during a version update. This parameter is required.
      Returns:
      this
      See Also:

    • minSize

      @Stability(Stable) public Nodegroup.Builder minSize(Number minSize)
      The minimum number of worker nodes that the managed node group can scale in to.

      This number must be greater than or equal to zero.

      Default: 1

      Parameters:
      minSize - The minimum number of worker nodes that the managed node group can scale in to. This parameter is required.
      Returns:
      this

    • nodegroupName

      @Stability(Stable) public Nodegroup.Builder nodegroupName(String nodegroupName)
      Name of the Nodegroup.

      Default: - resource ID

      Parameters:
      nodegroupName - Name of the Nodegroup. This parameter is required.
      Returns:
      this

    • nodeRole

      @Stability(Stable) public Nodegroup.Builder nodeRole(IRole nodeRole)
      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.

      Default: - None. Auto-generated if not specified.

      Parameters:
      nodeRole - The IAM role to associate with your node group. This parameter is required.
      Returns:
      this

    • releaseVersion

      @Stability(Stable) public Nodegroup.Builder releaseVersion(String releaseVersion)
      The AMI version of the Amazon EKS-optimized AMI to use with your node group (for example, 1.14.7-YYYYMMDD).

      Default: - The latest available AMI version for the node group's current Kubernetes version is used.

      Parameters:
      releaseVersion - The AMI version of the Amazon EKS-optimized AMI to use with your node group (for example, 1.14.7-YYYYMMDD). This parameter is required.
      Returns:
      this

    • remoteAccess

      @Stability(Stable) public Nodegroup.Builder remoteAccess(NodegroupRemoteAccess remoteAccess)
      The remote access (SSH) configuration to use with your node group.

      Disabled by default, however, if you specify an Amazon EC2 SSH key but do not specify a source security group when you create a managed node group, then port 22 on the worker nodes is opened to the internet (0.0.0.0/0)

      Default: - disabled

      Parameters:
      remoteAccess - The remote access (SSH) configuration to use with your node group. This parameter is required.
      Returns:
      this

    • subnets

      @Stability(Stable) public Nodegroup.Builder subnets(SubnetSelection subnets)
      The subnets to use for the Auto Scaling group that is created for your node group.

      By specifying the SubnetSelection, the selected subnets will automatically apply required tags i.e. kubernetes.io/cluster/CLUSTER_NAME with a value of shared, where CLUSTER_NAME is replaced with the name of your cluster.

      Default: - private subnets

      Parameters:
      subnets - The subnets to use for the Auto Scaling group that is created for your node group. This parameter is required.
      Returns:
      this

    • tags

      @Stability(Stable) public Nodegroup.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.

      Default: - None

      Parameters:
      tags - The metadata to apply to the node group to assist with categorization and organization. This parameter is required.
      Returns:
      this

    • taints

      @Stability(Stable) public Nodegroup.Builder taints(List<? extends TaintSpec> taints)
      The Kubernetes taints to be applied to the nodes in the node group when they are created.

      Default: - None

      Parameters:
      taints - The Kubernetes taints to be applied to the nodes in the node group when they are created. This parameter is required.
      Returns:
      this

    • cluster

      @Stability(Stable) public Nodegroup.Builder cluster(ICluster cluster)
      Cluster resource.

      Parameters:
      cluster - Cluster resource. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public Nodegroup build()
      Specified by:
      build in interface software.amazon.jsii.Builder<Nodegroup>
      Returns:
      a newly built instance of Nodegroup.