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

Class: Aws::EKS::Types::ListNodegroupsRequest

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

Overview

Note:

When passing ListNodegroupsRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  cluster_name: "String", # required
  max_results: 1,
  next_token: "String",
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#cluster_name ⇒ String

The name of the Amazon EKS cluster that you would like to list node groups in.

Returns:

  • (String) —

    The name of the Amazon EKS cluster that you would like to list node groups in.

#max_results ⇒ Integer

The maximum number of node group results returned by ListNodegroups in paginated output. When you use this parameter, ListNodegroups returns only maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListNodegroups request with the returned nextToken value. This value can be between 1 and 100. If you don\'t use this parameter, ListNodegroups returns up to 100 results and a nextToken value if applicable.

Returns:

  • (Integer) —

    The maximum number of node group results returned by ListNodegroups in paginated output.

#next_token ⇒ String

The nextToken value returned from a previous paginated ListNodegroups request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

Returns:

  • (String) —

    The nextToken value returned from a previous paginated ListNodegroups request where maxResults was used and the results exceeded the value of that parameter.