NodegroupProps

class aws_cdk.aws_eks.NodegroupProps(*, ami_type=None, capacity_type=None, desired_size=None, disk_size=None, force_update=None, instance_types=None, labels=None, launch_template_spec=None, max_size=None, max_unavailable=None, max_unavailable_percentage=None, min_size=None, nodegroup_name=None, node_role=None, release_version=None, remote_access=None, subnets=None, tags=None, taints=None, cluster)

Bases: NodegroupOptions

NodeGroup properties interface.

Parameters:

ami_type (Optional[NodegroupAmiType]) – 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
capacity_type (Optional[CapacityType]) – The capacity type of the nodegroup. Default: - ON_DEMAND
desired_size (Union[int, float, None]) – 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
disk_size (Union[int, float, None]) – The root device disk size (in GiB) for your node group instances. Default: 20
force_update (Optional[bool]) – 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
instance_types (Optional[Sequence[InstanceType]]) – The instance types to use for your node group. Default: t3.medium will be used according to the cloudformation document.
labels (Optional[Mapping[str, str]]) – The Kubernetes labels to be applied to the nodes in the node group when they are created. Default: - None
launch_template_spec (Union[LaunchTemplateSpec, Dict[str, Any], None]) – Launch template specification used for the nodegroup. Default: - no launch template
max_size (Union[int, float, None]) – 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
max_unavailable (Union[int, float, None]) – 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
max_unavailable_percentage (Union[int, float, None]) – 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
min_size (Union[int, float, None]) – 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
nodegroup_name (Optional[str]) – Name of the Nodegroup. Default: - resource ID
node_role (Optional[IRole]) – 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.
release_version (Optional[str]) – 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.
remote_access (Union[NodegroupRemoteAccess, Dict[str, Any], None]) – 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
subnets (Union[SubnetSelection, Dict[str, Any], None]) – 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
tags (Optional[Mapping[str, str]]) – 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
taints (Optional[Sequence[Union[TaintSpec, Dict[str, Any]]]]) – The Kubernetes taints to be applied to the nodes in the node group when they are created. Default: - None
cluster (ICluster) – Cluster resource.

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ec2 as ec2
from aws_cdk import aws_eks as eks
from aws_cdk import aws_iam as iam

# cluster: eks.Cluster
# instance_type: ec2.InstanceType
# role: iam.Role
# security_group: ec2.SecurityGroup
# subnet: ec2.Subnet
# subnet_filter: ec2.SubnetFilter

nodegroup_props = eks.NodegroupProps(
    cluster=cluster,

    # the properties below are optional
    ami_type=eks.NodegroupAmiType.AL2_X86_64,
    capacity_type=eks.CapacityType.SPOT,
    desired_size=123,
    disk_size=123,
    force_update=False,
    instance_types=[instance_type],
    labels={
        "labels_key": "labels"
    },
    launch_template_spec=eks.LaunchTemplateSpec(
        id="id",

        # the properties below are optional
        version="version"
    ),
    max_size=123,
    max_unavailable=123,
    max_unavailable_percentage=123,
    min_size=123,
    nodegroup_name="nodegroupName",
    node_role=role,
    release_version="releaseVersion",
    remote_access=eks.NodegroupRemoteAccess(
        ssh_key_name="sshKeyName",

        # the properties below are optional
        source_security_groups=[security_group]
    ),
    subnets=ec2.SubnetSelection(
        availability_zones=["availabilityZones"],
        one_per_az=False,
        subnet_filters=[subnet_filter],
        subnet_group_name="subnetGroupName",
        subnets=[subnet],
        subnet_type=ec2.SubnetType.PRIVATE_ISOLATED
    ),
    tags={
        "tags_key": "tags"
    },
    taints=[eks.TaintSpec(
        effect=eks.TaintEffect.NO_SCHEDULE,
        key="key",
        value="value"
    )]
)

Attributes

ami_type

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

capacity_type

The capacity type of the nodegroup.

Default:

ON_DEMAND

cluster: Cluster resource.

desired_size

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

disk_size

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

Default:: 20

force_update

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

instance_types

The instance types to use for your node group.

Default:: t3.medium will be used according to the cloudformation document.
See:: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes

labels

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

Default:

None

launch_template_spec

Launch template specification used for the nodegroup.

Default:

no launch template

See:

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

max_size

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

max_unavailable

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
See:: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-updateconfig.html#cfn-eks-nodegroup-updateconfig-maxunavailable

max_unavailable_percentage

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
See:: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-updateconfig.html#cfn-eks-nodegroup-updateconfig-maxunavailablepercentage

min_size

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

node_role

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.

nodegroup_name

Name of the Nodegroup.

Default:

resource ID

release_version

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.

remote_access

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

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

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

taints

The Kubernetes taints to be applied to the nodes in the node group when they are created.

Default:

None