software.amazon.awscdk.services.eks

Interface NodegroupOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

NodegroupProps

All Known Implementing Classes:

NodegroupOptions.Jsii$Proxy, NodegroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.30.0 (build adae23f)",
           date="2021-06-30T10:01:08.185Z")
 @Stability(value=Experimental)
public interface NodegroupOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) The Nodegroup Options for addNodeGroup() method.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	NodegroupOptions.Builder A builder for NodegroupOptions
static class	NodegroupOptions.Jsii$Proxy An implementation for NodegroupOptions

Method Summary

Modifier and Type	Method and Description
static NodegroupOptions.Builder	builder()
default NodegroupAmiType	getAmiType() (experimental) The AMI type for your node group.
default CapacityType	getCapacityType() (experimental) The capacity type of the nodegroup.
default Number	getDesiredSize() (experimental) The current number of worker nodes that the managed node group should maintain.
default Number	getDiskSize() (experimental) The root device disk size (in GiB) for your node group instances.
default Boolean	getForceUpdate() (experimental) Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue.
default List<InstanceType>	getInstanceTypes() (experimental) The instance types to use for your node group.
default Map<String,String>	getLabels() (experimental) The Kubernetes labels to be applied to the nodes in the node group when they are created.
default LaunchTemplateSpec	getLaunchTemplateSpec() (experimental) Launch template specification used for the nodegroup.
default Number	getMaxSize() (experimental) The maximum number of worker nodes that the managed node group can scale out to.
default Number	getMinSize() (experimental) The minimum number of worker nodes that the managed node group can scale in to.
default String	getNodegroupName() (experimental) Name of the Nodegroup.
default IRole	getNodeRole() (experimental) The IAM role to associate with your node group.
default String	getReleaseVersion() (experimental) The AMI version of the Amazon EKS-optimized AMI to use with your node group (for example, `1.14.7-YYYYMMDD`).
default NodegroupRemoteAccess	getRemoteAccess() (experimental) The remote access (SSH) configuration to use with your node group.
default SubnetSelection	getSubnets() (experimental) The subnets to use for the Auto Scaling group that is created for your node group.
default Map<String,String>	getTags() (experimental) The metadata to apply to the node group to assist with categorization and organization.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAmiType

@Stability(value=Experimental)
 @Nullable
default NodegroupAmiType getAmiType()

(experimental) The AMI type for your node group.

Default: - auto-determined from the instanceTypes property.

getCapacityType

@Stability(value=Experimental)
 @Nullable
default CapacityType getCapacityType()

(experimental) The capacity type of the nodegroup.

Default: - ON_DEMAND

getDesiredSize

@Stability(value=Experimental)
 @Nullable
default Number getDesiredSize()

(experimental) 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

getDiskSize

@Stability(value=Experimental)
 @Nullable
default Number getDiskSize()

(experimental) The root device disk size (in GiB) for your node group instances.

Default: 20

getForceUpdate

@Stability(value=Experimental)
 @Nullable
default Boolean getForceUpdate()

(experimental) 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

getInstanceTypes

@Stability(value=Experimental)
 @Nullable
default List<InstanceType> getInstanceTypes()

(experimental) The instance types to use for your node group.

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

See Also:

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

getLabels

@Stability(value=Experimental)
 @Nullable
default Map<String,String> getLabels()

(experimental) The Kubernetes labels to be applied to the nodes in the node group when they are created.

Default: - None

getLaunchTemplateSpec

@Stability(value=Experimental)
 @Nullable
default LaunchTemplateSpec getLaunchTemplateSpec()

(experimental) Launch template specification used for the nodegroup.

Default: - no launch template

See Also:

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

getMaxSize

@Stability(value=Experimental)
 @Nullable
default Number getMaxSize()

(experimental) 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

getMinSize

@Stability(value=Experimental)
 @Nullable
default Number getMinSize()

(experimental) The minimum number of worker nodes that the managed node group can scale in to.

This number must be greater than zero.

Default: 1

getNodegroupName

@Stability(value=Experimental)
 @Nullable
default String getNodegroupName()

(experimental) Name of the Nodegroup.

Default: - resource ID

getNodeRole

@Stability(value=Experimental)
 @Nullable
default IRole getNodeRole()

(experimental) 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.

getReleaseVersion

@Stability(value=Experimental)
 @Nullable
default String getReleaseVersion()

(experimental) 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.

getRemoteAccess

@Stability(value=Experimental)
 @Nullable
default NodegroupRemoteAccess getRemoteAccess()

(experimental) 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

getSubnets

@Stability(value=Experimental)
 @Nullable
default SubnetSelection getSubnets()

(experimental) 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

getTags

@Stability(value=Experimental)
 @Nullable
default Map<String,String> getTags()

(experimental) 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

builder

@Stability(value=Experimental)
static NodegroupOptions.Builder builder()

Returns:

a NodegroupOptions.Builder of NodegroupOptions