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(value=Stable)
public static final class Nodegroup.Builder
extends Object
implements software.amazon.jsii.Builder<Nodegroup>

A fluent builder for Nodegroup.

Method Summary

Modifier and Type	Method and Description
Nodegroup.Builder	amiType(NodegroupAmiType amiType) The AMI type for your node group.
Nodegroup	build()
Nodegroup.Builder	capacityType(CapacityType capacityType) The capacity type of the nodegroup.
Nodegroup.Builder	cluster(ICluster cluster) Cluster resource.
static Nodegroup.Builder	create(software.constructs.Construct scope, String id)
Nodegroup.Builder	desiredSize(Number desiredSize) The current number of worker nodes that the managed node group should maintain.
Nodegroup.Builder	diskSize(Number diskSize) The root device disk size (in GiB) for your node group instances.
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.
Nodegroup.Builder	instanceType(InstanceType instanceType) Deprecated. Use `instanceTypes` instead.
Nodegroup.Builder	instanceTypes(List<? extends InstanceType> instanceTypes) The instance types to use for your node group.
Nodegroup.Builder	labels(Map<String,String> labels) The Kubernetes labels to be applied to the nodes in the node group when they are created.
Nodegroup.Builder	launchTemplateSpec(LaunchTemplateSpec launchTemplateSpec) Launch template specification used for the nodegroup.
Nodegroup.Builder	maxSize(Number maxSize) The maximum number of worker nodes that the managed node group can scale out to.
Nodegroup.Builder	minSize(Number minSize) The minimum number of worker nodes that the managed node group can scale in to.
Nodegroup.Builder	nodegroupName(String nodegroupName) Name of the Nodegroup.
Nodegroup.Builder	nodeRole(IRole nodeRole) The IAM role to associate with your node group.
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`).
Nodegroup.Builder	remoteAccess(NodegroupRemoteAccess remoteAccess) The remote access (SSH) configuration to use with your node group.
Nodegroup.Builder	subnets(SubnetSelection subnets) The subnets to use for the Auto Scaling group that is created for your node group.
Nodegroup.Builder	tags(Map<String,String> tags) The metadata to apply to the node group to assist with categorization and organization.
Nodegroup.Builder	taints(List<? extends TaintSpec> taints) The Kubernetes taints to be applied to the nodes in the node group when they are created.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=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(value=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(value=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(value=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(value=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(value=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

instanceType

@Stability(value=Deprecated)
 @Deprecated
public Nodegroup.Builder instanceType(InstanceType instanceType)

Deprecated. Use `instanceTypes` instead.

(deprecated) The instance type to use for your node group.

Currently, you can specify a single instance type for a node group. The default value for this parameter is t3.medium. If you choose a GPU instance type, be sure to specify the AL2_x86_64_GPU with the amiType parameter.

Default: t3.medium

Parameters:

instanceType - The instance type to use for your node group. This parameter is required.

Returns:

this

instanceTypes

@Stability(value=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:

- https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes

labels

@Stability(value=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(value=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:

- https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html

maxSize

@Stability(value=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

minSize

@Stability(value=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(value=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(value=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(value=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(value=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(value=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(value=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(value=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(value=Stable)
public Nodegroup.Builder cluster(ICluster cluster)

Cluster resource.

Parameters:

cluster - Cluster resource. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public Nodegroup build()

Specified by:

build in interface software.amazon.jsii.Builder<Nodegroup>