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

Class: Aws::DAX::Types::DescribeClustersRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb

Overview

Note:

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

{
  cluster_names: ["String"],
  max_results: 1,
  next_token: "String",
}

Instance Attribute Summary collapse

Instance Attribute Details

#cluster_namesArray<String>

The names of the DAX clusters being described.

Returns:

  • (Array<String>)


521
522
523
524
525
526
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 521

class DescribeClustersRequest < Struct.new(
  :cluster_names,
  :max_results,
  :next_token)
  include Aws::Structure
end

#max_resultsInteger

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

The value for MaxResults must be between 20 and 100.

Returns:

  • (Integer)


521
522
523
524
525
526
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 521

class DescribeClustersRequest < Struct.new(
  :cluster_names,
  :max_results,
  :next_token)
  include Aws::Structure
end

#next_tokenString

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

Returns:

  • (String)


521
522
523
524
525
526
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 521

class DescribeClustersRequest < Struct.new(
  :cluster_names,
  :max_results,
  :next_token)
  include Aws::Structure
end