Package software.amazon.awscdk.services.eks

Class NodegroupOptions.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • amiType

      @Stability(Stable) public NodegroupOptions.Builder amiType(NodegroupAmiType amiType)
      Sets the value of NodegroupOptions.getAmiType()
      Parameters:
      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.
      Returns:
      this

    • capacityType

      @Stability(Stable) public NodegroupOptions.Builder capacityType(CapacityType capacityType)
      Sets the value of NodegroupOptions.getCapacityType()
      Parameters:
      capacityType - The capacity type of the nodegroup.
      Returns:
      this

    • desiredSize

      @Stability(Stable) public NodegroupOptions.Builder desiredSize(Number desiredSize)
      Sets the value of NodegroupOptions.getDesiredSize()
      Parameters:
      desiredSize - The current number of worker nodes that the managed node group should maintain. If not specified, the nodewgroup will initially create minSize instances.
      Returns:
      this

    • diskSize

      @Stability(Stable) public NodegroupOptions.Builder diskSize(Number diskSize)
      Sets the value of NodegroupOptions.getDiskSize()
      Parameters:
      diskSize - The root device disk size (in GiB) for your node group instances.
      Returns:
      this

    • forceUpdate

      @Stability(Stable) public NodegroupOptions.Builder forceUpdate(Boolean forceUpdate)
      Sets the value of NodegroupOptions.getForceUpdate()
      Parameters:
      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.
      Returns:
      this

    • instanceTypes

      @Stability(Stable) public NodegroupOptions.Builder instanceTypes(List<? extends InstanceType> instanceTypes)
      Sets the value of NodegroupOptions.getInstanceTypes()
      Parameters:
      instanceTypes - The instance types to use for your node group.
      Returns:
      this

    • labels

      @Stability(Stable) public NodegroupOptions.Builder labels(Map<String,String> labels)
      Sets the value of NodegroupOptions.getLabels()
      Parameters:
      labels - The Kubernetes labels to be applied to the nodes in the node group when they are created.
      Returns:
      this

    • launchTemplateSpec

      @Stability(Stable) public NodegroupOptions.Builder launchTemplateSpec(LaunchTemplateSpec launchTemplateSpec)
      Sets the value of NodegroupOptions.getLaunchTemplateSpec()
      Parameters:
      launchTemplateSpec - Launch template specification used for the nodegroup.
      Returns:
      this

    • maxSize

      @Stability(Stable) public NodegroupOptions.Builder maxSize(Number maxSize)
      Sets the value of NodegroupOptions.getMaxSize()
      Parameters:
      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.
      Returns:
      this

    • maxUnavailable

      @Stability(Stable) public NodegroupOptions.Builder maxUnavailable(Number maxUnavailable)
      Sets the value of NodegroupOptions.getMaxUnavailable()
      Parameters:
      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.

      Returns:
      this

    • maxUnavailablePercentage

      @Stability(Stable) public NodegroupOptions.Builder maxUnavailablePercentage(Number maxUnavailablePercentage)
      Sets the value of NodegroupOptions.getMaxUnavailablePercentage()
      Parameters:
      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.

      Returns:
      this

    • minSize

      @Stability(Stable) public NodegroupOptions.Builder minSize(Number minSize)
      Sets the value of NodegroupOptions.getMinSize()
      Parameters:
      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.
      Returns:
      this

    • nodegroupName

      @Stability(Stable) public NodegroupOptions.Builder nodegroupName(String nodegroupName)
      Sets the value of NodegroupOptions.getNodegroupName()
      Parameters:
      nodegroupName - Name of the Nodegroup.
      Returns:
      this

    • nodeRole

      @Stability(Stable) public NodegroupOptions.Builder nodeRole(IRole nodeRole)
      Sets the value of NodegroupOptions.getNodeRole()
      Parameters:
      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.
      Returns:
      this

    • releaseVersion

      @Stability(Stable) public NodegroupOptions.Builder releaseVersion(String releaseVersion)
      Sets the value of NodegroupOptions.getReleaseVersion()
      Parameters:
      releaseVersion - The AMI version of the Amazon EKS-optimized AMI to use with your node group (for example, 1.14.7-YYYYMMDD).
      Returns:
      this

    • remoteAccess

      @Stability(Stable) public NodegroupOptions.Builder remoteAccess(NodegroupRemoteAccess remoteAccess)
      Sets the value of NodegroupOptions.getRemoteAccess()
      Parameters:
      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)
      Returns:
      this

    • subnets

      @Stability(Stable) public NodegroupOptions.Builder subnets(SubnetSelection subnets)
      Sets the value of NodegroupOptions.getSubnets()
      Parameters:
      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.
      Returns:
      this

    • tags

      @Stability(Stable) public NodegroupOptions.Builder tags(Map<String,String> tags)
      Sets the value of NodegroupOptions.getTags()
      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:
      this

    • taints

      @Stability(Stable) public NodegroupOptions.Builder taints(List<? extends TaintSpec> taints)
      Sets the value of NodegroupOptions.getTaints()
      Parameters:
      taints - The Kubernetes taints to be applied to the nodes in the node group when they are created.
      Returns:
      this

    • build

      @Stability(Stable) public NodegroupOptions build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<NodegroupOptions>
      Returns:
      a new instance of NodegroupOptions
      Throws:
      NullPointerException - if any required attribute was not provided