You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::EKS::Types::Nodegroup

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

An object representing an Amazon EKS managed node group.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#ami_type ⇒ 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.

Possible values:

  • AL2_x86_64
  • AL2_x86_64_GPU
  • AL2_ARM_64

Returns:

  • (String) —

    If the node group was deployed using a launch template with a custom AMI, then this is CUSTOM.

#cluster_name ⇒ String

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

Returns:

  • (String) —

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

#created_at ⇒ Time

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

Returns:

  • (Time) —

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

#disk_size ⇒ 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.

Returns:

  • (Integer) —

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

#health ⇒ Types::NodegroupHealth

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

Returns:

#instance_types ⇒ Array<String>

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.

Returns:

  • (Array<String>) —

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

#labels ⇒ Hash<String,String>

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.

Returns:

  • (Hash<String,String>) —

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

#launch_template ⇒ Types::LaunchTemplateSpecification

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

Returns:

#modified_at ⇒ Time

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

Returns:

  • (Time) —

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

#node_role ⇒ String

The IAM role associated 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.

Returns:

  • (String) —

    The IAM role associated with your node group.

#nodegroup_arn ⇒ String

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

Returns:

  • (String) —

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

#nodegroup_name ⇒ String

The name associated with an Amazon EKS managed node group.

Returns:

  • (String) —

    The name associated with an Amazon EKS managed node group.

#release_version ⇒ 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.

Returns:

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

#remote_access ⇒ Types::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.

Returns:

  • (Types::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.

#resources ⇒ Types::NodegroupResources

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

Returns:

  • (Types::NodegroupResources) —

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

#scaling_config ⇒ Types::NodegroupScalingConfig

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

Returns:

#status ⇒ String

The current status of the managed node group.

Possible values:

  • CREATING
  • ACTIVE
  • UPDATING
  • DELETING
  • CREATE_FAILED
  • DELETE_FAILED
  • DEGRADED

Returns:

  • (String) —

    The current status of the managed node group.

#subnets ⇒ Array<String>

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

Returns:

  • (Array<String>) —

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

#tags ⇒ Hash<String,String>

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.

Returns:

  • (Hash<String,String>) —

    The metadata applied to the node group to assist with categorization and organization.

#version ⇒ String

The Kubernetes version of the managed node group.

Returns:

  • (String) —

    The Kubernetes version of the managed node group.