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

Class: Aws::ElastiCache::Types::DescribeCacheClustersMessage

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

Overview

Note:

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

{
  cache_cluster_id: "String",
  max_records: 1,
  marker: "String",
  show_cache_node_info: false,
  show_cache_clusters_not_in_replication_groups: false,
}

Represents the input of a DescribeCacheClusters operation.

Instance Attribute Summary collapse

Instance Attribute Details

#cache_cluster_idString

The user-supplied cluster identifier. If this parameter is specified, only information about that specific cache cluster is returned. This parameter isn't case sensitive.

Returns:

  • (String)


2205
2206
2207
2208
2209
2210
2211
2212
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2205

class DescribeCacheClustersMessage < Struct.new(
  :cache_cluster_id,
  :max_records,
  :marker,
  :show_cache_node_info,
  :show_cache_clusters_not_in_replication_groups)
  include Aws::Structure
end

#markerString

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

Returns:

  • (String)


2205
2206
2207
2208
2209
2210
2211
2212
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2205

class DescribeCacheClustersMessage < Struct.new(
  :cache_cluster_id,
  :max_records,
  :marker,
  :show_cache_node_info,
  :show_cache_clusters_not_in_replication_groups)
  include Aws::Structure
end

#max_recordsInteger

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

Default: 100

Constraints: minimum 20; maximum 100.

Returns:

  • (Integer)


2205
2206
2207
2208
2209
2210
2211
2212
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2205

class DescribeCacheClustersMessage < Struct.new(
  :cache_cluster_id,
  :max_records,
  :marker,
  :show_cache_node_info,
  :show_cache_clusters_not_in_replication_groups)
  include Aws::Structure
end

#show_cache_clusters_not_in_replication_groupsBoolean

An optional flag that can be included in the DescribeCacheCluster request to show only nodes (API/CLI: clusters) that are not members of a replication group. In practice, this mean Memcached and single node Redis clusters.

Returns:

  • (Boolean)


2205
2206
2207
2208
2209
2210
2211
2212
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2205

class DescribeCacheClustersMessage < Struct.new(
  :cache_cluster_id,
  :max_records,
  :marker,
  :show_cache_node_info,
  :show_cache_clusters_not_in_replication_groups)
  include Aws::Structure
end

#show_cache_node_infoBoolean

An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.

Returns:

  • (Boolean)


2205
2206
2207
2208
2209
2210
2211
2212
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2205

class DescribeCacheClustersMessage < Struct.new(
  :cache_cluster_id,
  :max_records,
  :marker,
  :show_cache_node_info,
  :show_cache_clusters_not_in_replication_groups)
  include Aws::Structure
end