/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::ElastiCache::DescribeCacheClusters

NAME

Paws::ElastiCache::DescribeCacheClusters - Arguments for method DescribeCacheClusters on Paws::ElastiCache

DESCRIPTION

This class represents the parameters used for calling the method DescribeCacheClusters on the Amazon ElastiCache service. Use the attributes of this class as arguments to method DescribeCacheClusters.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeCacheClusters.

SYNOPSIS

my $elasticache = Paws->service('ElastiCache');
# DescribeCacheClusters
# Lists the details for up to 50 cache clusters.
my $CacheClusterMessage = $elasticache->DescribeCacheClusters(
  'CacheClusterId' => 'my-mem-cluster' );

# Results:
my $CacheClusters = $CacheClusterMessage->CacheClusters;

# Returns a L<Paws::ElastiCache::CacheClusterMessage> object.
# DescribeCacheClusters
# Lists the details for the cache cluster my-mem-cluster.
my $CacheClusterMessage = $elasticache->DescribeCacheClusters(
  'CacheClusterId'    => 'my-mem-cluster',
  'ShowCacheNodeInfo' => 1
);

# Results:
my $CacheClusters = $CacheClusterMessage->CacheClusters;

# Returns a L<Paws::ElastiCache::CacheClusterMessage> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/elasticache/DescribeCacheClusters

ATTRIBUTES

CacheClusterId => Str

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

Marker => Str

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.

MaxRecords => Int

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.

ShowCacheClustersNotInReplicationGroups => Bool

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.

ShowCacheNodeInfo => Bool

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

SEE ALSO

This class forms part of Paws, documenting arguments for method DescribeCacheClusters in Paws::ElastiCache

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues