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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-eks/types.rb

Overview

Note:

When making an API call, you may pass ListNodegroupsRequest data as a hash:

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cluster_nameString

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

Returns:

  • (String)

2424
2425
2426
2427
2428
2429
2430
# File 'lib/aws-sdk-eks/types.rb', line 2424

class ListNodegroupsRequest < Struct.new(
  :cluster_name,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

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)

2424
2425
2426
2427
2428
2429
2430
# File 'lib/aws-sdk-eks/types.rb', line 2424

class ListNodegroupsRequest < Struct.new(
  :cluster_name,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

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)

2424
2425
2426
2427
2428
2429
2430
# File 'lib/aws-sdk-eks/types.rb', line 2424

class ListNodegroupsRequest < Struct.new(
  :cluster_name,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end