Class: Aws::EKS::Types::ListClustersRequest

Inherits:

Struct

• Object
• Struct
• Aws::EKS::Types::ListClustersRequest

Includes:

Structure

Defined in:

lib/aws-sdk-eks/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #include ⇒ Array<String>

  Indicates whether external clusters are included in the returned list.

• #max_results ⇒ Integer

  The maximum number of results, returned in paginated output.

• #next_token ⇒ String

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

Instance Attribute Details

#include ⇒ Array<String>

Indicates whether external clusters are included in the returned list. Use ‘`all`’ to return [docs.aws.amazon.com/eks/latest/userguide/eks-connector.html][1]connected clusters, or blank to return only Amazon EKS clusters. ‘`all`’ must be in lowercase otherwise an error occurs.

[1]: docs.aws.amazon.com/eks/latest/userguide/eks-connector.html

Returns:

• (Array<String>)

# File 'lib/aws-sdk-eks/types.rb', line 3822

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

#max_results ⇒ Integer

The maximum number of results, returned in paginated output. You receive ‘maxResults` in a single page, along with a `nextToken` response element. You can see the remaining results of the initial request by sending another request with the returned `nextToken` value. This value can be between 1 and 100. If you don’t use this parameter, 100 results and a ‘nextToken` value, if applicable, are returned.

Returns:

• (Integer)

# File 'lib/aws-sdk-eks/types.rb', line 3822

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

#next_token ⇒ String

The ‘nextToken` value returned from a previous paginated 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. This value is null when there are no more results to return.

<note markdown=“1”> This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

</note>

Returns:

• (String)

# File 'lib/aws-sdk-eks/types.rb', line 3822

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