Skip to content
AWS for Query.Farm

aws.eks.describe_nodegroup

Example SQL Queries

SELECT * FROM
aws.eks.describe_nodegroup
WHERE
"cluster_name" = 'VALUE'
AND "nodegroup_name" = 'VALUE';

Description

Describes a managed node group.

Table Definition

Column NameColumn Data Type
cluster_name Required Input Column

The name of your cluster.

VARCHAR
nodegroup_name Required Input Column

The name of the node group to describe.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
nodegroup

The full description of your node group.

STRUCT(
    "nodegroup_name" VARCHAR,
    "nodegroup_arn" VARCHAR,
    "cluster_name" VARCHAR,
    "version" VARCHAR,
    "release_version" VARCHAR,
    "created_at" TIMESTAMP_S,
    "modified_at" TIMESTAMP_S,
    "status" VARCHAR,
    "capacity_type" VARCHAR,
    "scaling_config" STRUCT(
        "min_size" BIGINT,
        "max_size" BIGINT,
        "desired_size" BIGINT
    ),
    "instance_types" VARCHAR[],
    "subnets" VARCHAR[],
    "remote_access" STRUCT(
        "ec2_ssh_key" VARCHAR,
        "source_security_groups" VARCHAR[]
    ),
    "ami_type" VARCHAR,
    "node_role" VARCHAR,
    "labels" MAP(VARCHAR, VARCHAR),
    "taints" STRUCT(
        "key" VARCHAR,
        "value" VARCHAR,
        "effect" VARCHAR
    )[],
    "resources" STRUCT(
        "auto_scaling_groups" STRUCT(
            "name" VARCHAR
        )[],
        "remote_access_security_group" VARCHAR
    ),
    "disk_size" BIGINT,
    "health" STRUCT(
        "issues" STRUCT(
            "code" VARCHAR,
            "message" VARCHAR,
            "resource_ids" VARCHAR[]
        )[]
    ),
    "update_config" STRUCT(
        "max_unavailable" BIGINT,
        "max_unavailable_percentage" BIGINT
    ),
    "launch_template" STRUCT(
        "name" VARCHAR,
        "version" VARCHAR,
        "id" VARCHAR
    ),
    "tags" MAP(VARCHAR, VARCHAR)
)
Show child fields
nodegroup.ami_type

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.

nodegroup.capacity_type

The capacity type of your managed node group.

nodegroup.cluster_name

The name of your cluster.

nodegroup.created_at

The Unix epoch timestamp at object creation.

nodegroup.disk_size

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.

nodegroup.health

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

Show child fields
nodegroup.health.issues[]
Show child fields
nodegroup.health.issues[].code

A brief description of the error.

  • AccessDenied: Amazon EKS or one or more of your managed nodes is failing to authenticate or authorize with your Kubernetes cluster API server.

  • AsgInstanceLaunchFailures: Your Auto Scaling group is experiencing failures while attempting to launch instances.

  • AutoScalingGroupNotFound: We couldn't find the Auto Scaling group associated with the managed node group. You may be able to recreate an Auto Scaling group with the same settings to recover.

  • ClusterUnreachable: Amazon EKS or one or more of your managed nodes is unable to to communicate with your Kubernetes cluster API server. This can happen if there are network disruptions or if API servers are timing out processing requests.

  • Ec2LaunchTemplateNotFound: We couldn't find the Amazon EC2 launch template for your managed node group. You may be able to recreate a launch template with the same settings to recover.

  • Ec2LaunchTemplateVersionMismatch: The Amazon EC2 launch template version for your managed node group does not match the version that Amazon EKS created. You may be able to revert to the version that Amazon EKS created to recover.

  • Ec2SecurityGroupDeletionFailure: We could not delete the remote access security group for your managed node group. Remove any dependencies from the security group.

  • Ec2SecurityGroupNotFound: We couldn't find the cluster security group for the cluster. You must recreate your cluster.

  • Ec2SubnetInvalidConfiguration: One or more Amazon EC2 subnets specified for a node group do not automatically assign public IP addresses to instances launched into it. If you want your instances to be assigned a public IP address, then you need to enable the auto-assign public IP address setting for the subnet. See Modifying the public IPv4 addressing attribute for your subnet in the Amazon VPC User Guide.

  • IamInstanceProfileNotFound: We couldn't find the IAM instance profile for your managed node group. You may be able to recreate an instance profile with the same settings to recover.

  • IamNodeRoleNotFound: We couldn't find the IAM role for your managed node group. You may be able to recreate an IAM role with the same settings to recover.

  • InstanceLimitExceeded: Your Amazon Web Services account is unable to launch any more instances of the specified instance type. You may be able to request an Amazon EC2 instance limit increase to recover.

  • InsufficientFreeAddresses: One or more of the subnets associated with your managed node group does not have enough available IP addresses for new nodes.

  • InternalFailure: These errors are usually caused by an Amazon EKS server-side issue.

  • NodeCreationFailure: Your launched instances are unable to register with your Amazon EKS cluster. Common causes of this failure are insufficient node IAM role permissions or lack of outbound internet access for the nodes.

nodegroup.health.issues[].message

The error message associated with the issue.

nodegroup.health.issues[].resource_ids[]
nodegroup.instance_types[]
nodegroup.labels

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.

nodegroup.launch_template

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

Show child fields
nodegroup.launch_template.id

The ID of the launch template.

You must specify either the launch template ID or the launch template name in the request, but not both.

nodegroup.launch_template.name

The name of the launch template.

You must specify either the launch template name or the launch template ID in the request, but not both.

nodegroup.launch_template.version

The version number of the launch template to use. If no version is specified, then the template's default version is used.

nodegroup.modified_at

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

nodegroup.node_role

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.nodegroup_arn

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

nodegroup.nodegroup_name

The name associated with an Amazon EKS managed node group.

nodegroup.release_version

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.

nodegroup.remote_access

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.

Show child fields
nodegroup.remote_access.ec2_ssh_key

The Amazon EC2 SSH key name that provides access for SSH communication with the nodes in the managed node group. For more information, see Amazon EC2 key pairs and Linux instances in the Amazon Elastic Compute Cloud User Guide for Linux Instances. For Windows, an Amazon EC2 SSH key is used to obtain the RDP password. For more information, see Amazon EC2 key pairs and Windows instances in the Amazon Elastic Compute Cloud User Guide for Windows Instances.

nodegroup.remote_access.source_security_groups[]
nodegroup.resources

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

Show child fields
nodegroup.resources.auto_scaling_groups[]
Show child fields
nodegroup.resources.auto_scaling_groups[].name

The name of the Auto Scaling group associated with an Amazon EKS managed node group.

nodegroup.resources.remote_access_security_group

The remote access security group associated with the node group. This security group controls SSH access to the nodes.

nodegroup.scaling_config

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

Show child fields
nodegroup.scaling_config.desired_size

The current number of nodes that the managed node group should maintain.

If you use the Kubernetes Cluster Autoscaler, you shouldn't change the desiredSize value directly, as this can cause the Cluster Autoscaler to suddenly scale up or scale down.

Whenever this parameter changes, the number of worker nodes in the node group is updated to the specified size. If this parameter is given a value that is smaller than the current number of running worker nodes, the necessary number of worker nodes are terminated to match the given value. When using CloudFormation, no action occurs if you remove this parameter from your CFN template.

This parameter can be different from minSize in some cases, such as when starting with extra hosts for testing. This parameter can also be different when you want to start with an estimated number of needed hosts, but let the Cluster Autoscaler reduce the number if there are too many. When the Cluster Autoscaler is used, the desiredSize parameter is altered by the Cluster Autoscaler (but can be out-of-date for short periods of time). the Cluster Autoscaler doesn't scale a managed node group lower than minSize or higher than maxSize.

nodegroup.scaling_config.max_size

The maximum number of nodes that the managed node group can scale out to. For information about the maximum number that you can specify, see Amazon EKS service quotas in the Amazon EKS User Guide.

nodegroup.scaling_config.min_size

The minimum number of nodes that the managed node group can scale in to.

nodegroup.status

The current status of the managed node group.

nodegroup.subnets[]
nodegroup.tags

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.

nodegroup.taints[]
Show child fields
nodegroup.taints[].effect

The effect of the taint.

nodegroup.taints[].key

The key of the taint.

nodegroup.taints[].value

The value of the taint.

nodegroup.update_config

The node group update configuration.

Show child fields
nodegroup.update_config.max_unavailable

The maximum number of nodes unavailable at once during a version update. Nodes are updated in parallel. This value or maxUnavailablePercentage is required to have a value.The maximum number is 100.

nodegroup.update_config.max_unavailable_percentage

The maximum percentage of nodes unavailable during a version update. This percentage of nodes are updated in parallel, up to 100 nodes at once. This value or maxUnavailable is required to have a value.

nodegroup.version

The Kubernetes version of the managed node group.