Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . eks ]

describe-nodegroup

Description

Returns descriptive information about an Amazon EKS node group.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-nodegroup
--cluster-name <value>
--nodegroup-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--cluster-name (string)

The name of the Amazon EKS cluster associated with the node group.

--nodegroup-name (string)

The name of the node group to describe.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

nodegroup -> (structure)

The full description of your node group.

nodegroupName -> (string)

The name associated with an Amazon EKS managed node group.

nodegroupArn -> (string)

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

clusterName -> (string)

The name of the cluster that the managed node group resides in.

version -> (string)

The Kubernetes version of the managed node group.

releaseVersion -> (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.

createdAt -> (timestamp)

The Unix epoch timestamp in seconds for when the managed node group was created.

modifiedAt -> (timestamp)

The Unix epoch timestamp in seconds for when the managed node group was last modified.

status -> (string)

The current status of the managed node group.

capacityType -> (string)

The capacity type of your managed node group.

scalingConfig -> (structure)

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

minSize -> (integer)

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

maxSize -> (integer)

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 .

desiredSize -> (integer)

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

instanceTypes -> (list)

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 .

(string)

subnets -> (list)

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

(string)

remoteAccess -> (structure)

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 .

ec2SshKey -> (string)

The Amazon EC2 SSH key 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 .

sourceSecurityGroups -> (list)

The security groups that are allowed SSH access (port 22) to the nodes. 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 nodes is opened to the internet (0.0.0.0/0). For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide .

(string)

amiType -> (string)

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.

nodeRole -> (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.

labels -> (map)

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

Note

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.

key -> (string)

value -> (string)

taints -> (list)

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.

(structure)

A property that allows a node to repel a set of pods.

key -> (string)

The key of the taint.

value -> (string)

The value of the taint.

effect -> (string)

The effect of the taint.

resources -> (structure)

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

autoScalingGroups -> (list)

The Auto Scaling groups associated with the node group.

(structure)

An Auto Scaling group that is associated with an Amazon EKS managed node group.

name -> (string)

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

remoteAccessSecurityGroup -> (string)

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

diskSize -> (integer)

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 -> (structure)

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

issues -> (list)

Any issues that are associated with the node group.

(structure)

An object representing an issue with an Amazon EKS resource.

code -> (string)

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.

message -> (string)

The error message associated with the issue.

resourceIds -> (list)

The Amazon Web Services resources that are afflicted by this issue.

(string)

updateConfig -> (structure)

The node group update configuration.

maxUnavailable -> (integer)

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

maxUnavailablePercentage -> (integer)

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.

launchTemplate -> (structure)

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

name -> (string)

The name of the launch template.

version -> (string)

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

id -> (string)

The ID of the launch template.

tags -> (map)

The metadata applied 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.

key -> (string)

value -> (string)