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_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)
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. 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 = 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_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" )] )
- 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 specifiedcapacity_type (
Optional
[CapacityType
]) – The capacity type of the nodegroup. Default: - ON_DEMANDdesired_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 createminSize
instances. Default: 2disk_size (
Union
[int
,float
,None
]) – The root device disk size (in GiB) for your node group instances. Default: 20force_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: trueinstance_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: - Nonelaunch_template_spec (
Union
[LaunchTemplateSpec
,Dict
[str
,Any
],None
]) – Launch template specification used for the nodegroup. Default: - no launch templatemax_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: - desiredSizemax_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 ormaxUnavailablePercentage
is required to have a value for custom update configurations to be applied. Default: 1max_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 ormaxUnavailable
is required to have a value for custom update configurations to be applied. Default: undefined - node groups will update instances one at a timemin_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: 1nodegroup_name (
Optional
[str
]) – Name of the Nodegroup. Default: - resource IDnode_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: - disabledsubnets (
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 ofshared
, whereCLUSTER_NAME
is replaced with the name of your cluster. Default: - private subnetstags (
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: - Nonetaints (
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 tree node.
- 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:
- classmethod is_construct(x)
Checks if
x
is a construct.Use this method instead of
instanceof
to properly detectConstruct
instances, even when the construct library is symlinked.Explanation: in JavaScript, multiple copies of the
constructs
library on disk are seen as independent, completely different libraries. As a consequence, the classConstruct
in each copy of theconstructs
library is seen as a different class, and an instance of one class will not test asinstanceof
the other class.npm install
will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of theconstructs
library can be accidentally installed, andinstanceof
will behave unpredictably. It is safest to avoid usinginstanceof
, and using this type-testing method instead.- Parameters:
x (
Any
) – Any object.- Return type:
bool
- Returns:
true if
x
is an object created from a class which extendsConstruct
.
- classmethod is_owned_resource(construct)
Returns true if the construct was created by CDK, and false otherwise.
- Parameters:
construct (
IConstruct
) –- Return type:
bool
- classmethod is_resource(construct)
Check whether the given construct is a Resource.
- Parameters:
construct (
IConstruct
) –- Return type:
bool