Skip to content

Nodegroup

Source code in docs_src/capo_eks/types/nodegroup.py
class Nodegroup(TypedDict, closed=True):
    nodegroup_name: NotRequired["capo_eks.types.string.String"]
    """<p>The name associated with an Amazon EKS managed node group.</p>"""
    nodegroup_arn: NotRequired["capo_eks.types.string.String"]
    """<p>The Amazon Resource Name (ARN) associated with the managed node group.</p>"""
    cluster_name: NotRequired["capo_eks.types.string.String"]
    """<p>The name of your cluster.</p>"""
    version: NotRequired["capo_eks.types.string.String"]
    """<p>The Kubernetes version of the managed node group.</p>"""
    release_version: NotRequired["capo_eks.types.string.String"]
    """<p>If the node group was deployed using a launch template with a custom AMI, then this is the AMI ID that was specified in the launch template. For node groups that weren't deployed using a launch template, this is the version of the Amazon EKS optimized AMI that the node group was deployed with.</p>"""
    created_at: NotRequired["capo_eks.types.timestamp.Timestamp"]
    """<p>The Unix epoch timestamp at object creation.</p>"""
    modified_at: NotRequired["capo_eks.types.timestamp.Timestamp"]
    """<p>The Unix epoch timestamp for the last modification to the object.</p>"""
    status: NotRequired["capo_eks.types.nodegroup_status.NodegroupStatus"]
    """<p>The current status of the managed node group.</p>"""
    capacity_type: NotRequired["capo_eks.types.capacity_types.CapacityTypes"]
    """<p>The capacity type of your managed node group.</p>"""
    scaling_config: NotRequired[
        "capo_eks.types.nodegroup_scaling_config.NodegroupScalingConfig"
    ]
    """<p>The scaling configuration details for the Auto Scaling group that is associated with your node group.</p>"""
    instance_types: NotRequired["capo_eks.types.string_list.StringList"]
    """<p>If the node group wasn't deployed with a launch template, then this is the instance type that is associated with the node group. If the node group was deployed with a launch template, then this is <code>null</code>.</p>"""
    subnets: NotRequired["capo_eks.types.string_list.StringList"]
    """<p>The subnets that were specified for the Auto Scaling group that is associated with your node group.</p>"""
    remote_access: NotRequired["capo_eks.types.remote_access_config.RemoteAccessConfig"]
    """<p>If the node group wasn't deployed with a launch template, then this is the remote access configuration that is associated with the node group. If the node group was deployed with a launch template, then this is <code>null</code>.</p>"""
    ami_type: NotRequired["capo_eks.types.ami_types.AMITypes"]
    """<p>If the node group was deployed using a launch template with a custom AMI, then this is <code>CUSTOM</code>. For node groups that weren't deployed using a launch template, this is the AMI type that was specified in the node group configuration.</p>"""
    node_role: NotRequired["capo_eks.types.string.String"]
    """<p>The IAM role associated with your node group. The Amazon EKS node <code>kubelet</code> daemon makes calls to Amazon Web Services APIs on your behalf. Nodes receive permissions for these API calls through an IAM instance profile and associated policies.</p>"""
    labels: NotRequired["capo_eks.types.labels_map.labelsMap"]
    """<p>The Kubernetes <code>labels</code> applied to the nodes in the node group.</p> <note> <p>Only <code>labels</code> that are applied with the Amazon EKS API are shown here. There may be other Kubernetes <code>labels</code> applied to the nodes in this group.</p> </note>"""
    taints: NotRequired["capo_eks.types.taints_list.taintsList"]
    """<p>The Kubernetes taints to be applied to the nodes in the node group when they are created. Effect is one of <code>No_Schedule</code>, <code>Prefer_No_Schedule</code>, or <code>No_Execute</code>. Kubernetes taints can be used together with tolerations to control how workloads are scheduled to your nodes. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/node-taints-managed-node-groups.html">Node taints on managed node groups</a>.</p>"""
    resources: NotRequired["capo_eks.types.nodegroup_resources.NodegroupResources"]
    """<p>The resources associated with the node group, such as Auto Scaling groups and security groups for remote access.</p>"""
    disk_size: NotRequired["capo_eks.types.boxed_integer.BoxedInteger"]
    """<p>If the node group wasn't deployed with a launch template, then this is the disk size in the node group configuration. If the node group was deployed with a launch template, then this is <code>null</code>.</p>"""
    health: NotRequired["capo_eks.types.nodegroup_health.NodegroupHealth"]
    """<p>The health status of the node group. If there are issues with your node group's health, they are listed here.</p>"""
    update_config: NotRequired[
        "capo_eks.types.nodegroup_update_config.NodegroupUpdateConfig"
    ]
    """<p>The node group update configuration.</p>"""
    node_repair_config: NotRequired[
        "capo_eks.types.node_repair_config.NodeRepairConfig"
    ]
    """<p>The node auto repair configuration for the node group.</p>"""
    launch_template: NotRequired[
        "capo_eks.types.launch_template_specification.LaunchTemplateSpecification"
    ]
    """<p>If a launch template was used to create the node group, then this is the launch template that was used.</p>"""
    tags: NotRequired["capo_eks.types.tag_map.TagMap"]
    """<p>Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or Amazon Web Services resources.</p>"""
    warm_pool_config: NotRequired["capo_eks.types.warm_pool_config.WarmPoolConfig"]
    """<p>The warm pool configuration attached to the node group. Amazon EKS manages warm pools throughout the node group lifecycle using the <code>AWSServiceRoleForAmazonEKSNodegroup</code> service-linked role to create, update, and delete warm pool resources.</p>"""

ami_type instance-attribute

ami_type: NotRequired[AMITypes]

If the node group was deployed using a launch template with a custom AMI, then this is CUSTOM. For node groups that weren't deployed using a launch template, this is the AMI type that was specified in the node group configuration.

capacity_type instance-attribute

capacity_type: NotRequired[CapacityTypes]

The capacity type of your managed node group.

cluster_name instance-attribute

cluster_name: NotRequired[String]

The name of your cluster.

created_at instance-attribute

created_at: NotRequired[Timestamp]

The Unix epoch timestamp at object creation.

disk_size instance-attribute

disk_size: NotRequired[BoxedInteger]

If the node group wasn't deployed with a launch template, then this is the disk size in the node group configuration. If the node group was deployed with a launch template, then this is null.

health instance-attribute

health: NotRequired[NodegroupHealth]

The health status of the node group. If there are issues with your node group's health, they are listed here.

instance_types instance-attribute

instance_types: NotRequired[StringList]

If the node group wasn't deployed with a launch template, then this is the instance type that is associated with the node group. If the node group was deployed with a launch template, then this is null.

labels instance-attribute

labels: NotRequired[labelsMap]

The Kubernetes labels applied to the nodes in the node group.

Only labels that are applied with the Amazon EKS API are shown here. There may be other Kubernetes labels applied to the nodes in this group.

launch_template instance-attribute

launch_template: NotRequired[LaunchTemplateSpecification]

If a launch template was used to create the node group, then this is the launch template that was used.

modified_at instance-attribute

modified_at: NotRequired[Timestamp]

The Unix epoch timestamp for the last modification to the object.

node_repair_config instance-attribute

node_repair_config: NotRequired[NodeRepairConfig]

The node auto repair configuration for the node group.

node_role instance-attribute

node_role: NotRequired[String]

The IAM role associated with your node group. The Amazon EKS node kubelet daemon makes calls to Amazon Web Services APIs on your behalf. Nodes receive permissions for these API calls through an IAM instance profile and associated policies.

nodegroup_arn instance-attribute

nodegroup_arn: NotRequired[String]

The Amazon Resource Name (ARN) associated with the managed node group.

nodegroup_name instance-attribute

nodegroup_name: NotRequired[String]

The name associated with an Amazon EKS managed node group.

release_version instance-attribute

release_version: NotRequired[String]

If the node group was deployed using a launch template with a custom AMI, then this is the AMI ID that was specified in the launch template. For node groups that weren't deployed using a launch template, this is the version of the Amazon EKS optimized AMI that the node group was deployed with.

remote_access instance-attribute

remote_access: NotRequired[RemoteAccessConfig]

If the node group wasn't deployed with a launch template, then this is the remote access configuration that is associated with the node group. If the node group was deployed with a launch template, then this is null.

resources instance-attribute

resources: NotRequired[NodegroupResources]

The resources associated with the node group, such as Auto Scaling groups and security groups for remote access.

scaling_config instance-attribute

scaling_config: NotRequired[NodegroupScalingConfig]

The scaling configuration details for the Auto Scaling group that is associated with your node group.

status instance-attribute

status: NotRequired[NodegroupStatus]

The current status of the managed node group.

subnets instance-attribute

subnets: NotRequired[StringList]

The subnets that were specified for the Auto Scaling group that is associated with your node group.

tags instance-attribute

tags: NotRequired[TagMap]

Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or Amazon Web Services resources.

taints instance-attribute

taints: NotRequired[taintsList]

The Kubernetes taints to be applied to the nodes in the node group when they are created. Effect is one of No_Schedule, Prefer_No_Schedule, or No_Execute. Kubernetes taints can be used together with tolerations to control how workloads are scheduled to your nodes. For more information, see Node taints on managed node groups.

update_config instance-attribute

update_config: NotRequired[NodegroupUpdateConfig]

The node group update configuration.

version instance-attribute

version: NotRequired[String]

The Kubernetes version of the managed node group.

warm_pool_config instance-attribute

warm_pool_config: NotRequired[WarmPoolConfig]

The warm pool configuration attached to the node group. Amazon EKS manages warm pools throughout the node group lifecycle using the AWSServiceRoleForAmazonEKSNodegroup service-linked role to create, update, and delete warm pool resources.