Class: Aws::MemoryDB::Types::DescribeClustersRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cluster_name ⇒ String

The name of the cluster

Returns:

  • (String) 


1146
1147
1148
1149
1150
1151
1152
1153
 
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 1146

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

#max_results ⇒ Integer

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

Returns:

  • (Integer) 


1146
1147
1148
1149
1150
1151
1152
1153
 
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 1146

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

#next_token ⇒ String

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

Returns:

  • (String) 


1146
1147
1148
1149
1150
1151
1152
1153
 
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 1146

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

#show_shard_details ⇒ Boolean

An optional flag that can be included in the request to retrieve information about the individual shard(s).

Returns:

  • (Boolean) 


1146
1147
1148
1149
1150
1151
1152
1153
 
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 1146

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