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

Inherits:

Struct

• Object
• Struct
• Aws::ElastiCache::Types::DescribeCacheClustersMessage

Includes:

Structure

Defined in:

lib/aws-sdk-elasticache/types.rb

Overview

Represents the input of a ‘DescribeCacheClusters` operation.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #cache_cluster_id ⇒ String

  The user-supplied cluster identifier.

• #marker ⇒ String

  An optional marker returned from a prior request.

• #max_records ⇒ Integer

  The maximum number of records to include in the response.

• #show_cache_clusters_not_in_replication_groups ⇒ Boolean

  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.

• #show_cache_node_info ⇒ Boolean

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

Instance Attribute Details

#cache_cluster_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-elasticache/types.rb', line 3670

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

#marker ⇒ String

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)

# File 'lib/aws-sdk-elasticache/types.rb', line 3670

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

#max_records ⇒ Integer

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)

# File 'lib/aws-sdk-elasticache/types.rb', line 3670

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

#show_cache_clusters_not_in_replication_groups ⇒ Boolean

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 means Memcached and single node Valkey or Redis OSS clusters.

Returns:

• (Boolean)

# File 'lib/aws-sdk-elasticache/types.rb', line 3670

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

#show_cache_node_info ⇒ Boolean

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

Returns:

• (Boolean)

# File 'lib/aws-sdk-elasticache/types.rb', line 3670

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