Nodegroup

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

Bases: Resource

The Nodegroup resource class.

ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_ec2 as ec2
import aws_cdk.aws_eks as eks
import aws_cdk.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 = eks.Nodegroup(self, "MyNodegroup",
    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_type=instance_type,
    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,
    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",
        subnet_name="subnetName",
        subnets=[subnet],
        subnet_type=ec2.SubnetType.ISOLATED
    ),
    tags={
        "tags_key": "tags"
    },
    taints=[eks.TaintSpec(
        effect=eks.TaintEffect.NO_SCHEDULE,
        key="key",
        value="value"
    )]
)

Parameters:

scope (Construct)
id (str)
cluster (ICluster) – Cluster resource.
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_type (Optional[InstanceType]) – (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
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
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

Methods

apply_removal_policy(policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:: policy (RemovalPolicy)
Return type:: None

to_string()

Returns a string representation of this construct.

Return type:: str

Attributes

cluster

the Amazon EKS cluster resource.

Attribute:: ClusterName

env

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

node: The construct tree node associated with this construct.

nodegroup_arn

ARN of the nodegroup.

Attribute:: true

nodegroup_name

Nodegroup name.

Attribute:: true

role: IAM role of the instance profile for the nodegroup.

stack: The stack in which this resource is defined.

Static Methods

classmethod from_nodegroup_name(scope, id, nodegroup_name)

Import the Nodegroup from attributes.

Parameters:

scope (Construct)
id (str)
nodegroup_name (str)

Return type:

INodegroup

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters:: x (Any)
Return type:: bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:: construct (IConstruct)
Return type:: bool