File Coverage

blib/lib/Paws/ElastiCache/DescribeCacheClusters.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::ElastiCache::DescribeCacheClusters;
3 1     1   430 use Moose;
  1         4  
  1         6  
4             has CacheClusterId => (is => 'ro', isa => 'Str');
5             has Marker => (is => 'ro', isa => 'Str');
6             has MaxRecords => (is => 'ro', isa => 'Int');
7             has ShowCacheClustersNotInReplicationGroups => (is => 'ro', isa => 'Bool');
8             has ShowCacheNodeInfo => (is => 'ro', isa => 'Bool');
9              
10 1     1   5809 use MooseX::ClassAttribute;
  1         2  
  1         9  
11              
12             class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeCacheClusters');
13             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ElastiCache::CacheClusterMessage');
14             class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeCacheClustersResult');
15             1;
16              
17             ### main pod documentation begin ###
18              
19             =head1 NAME
20              
21             Paws::ElastiCache::DescribeCacheClusters - Arguments for method DescribeCacheClusters on Paws::ElastiCache
22              
23             =head1 DESCRIPTION
24              
25             This class represents the parameters used for calling the method DescribeCacheClusters on the
26             Amazon ElastiCache service. Use the attributes of this class
27             as arguments to method DescribeCacheClusters.
28              
29             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeCacheClusters.
30              
31             As an example:
32              
33             $service_obj->DescribeCacheClusters(Att1 => $value1, Att2 => $value2, ...);
34              
35             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.
36              
37             =head1 ATTRIBUTES
38              
39              
40             =head2 CacheClusterId => Str
41              
42             The user-supplied cluster identifier. If this parameter is specified,
43             only information about that specific cache cluster is returned. This
44             parameter isn't case sensitive.
45              
46              
47              
48             =head2 Marker => Str
49              
50             An optional marker returned from a prior request. Use this marker for
51             pagination of results from this operation. If this parameter is
52             specified, the response includes only records beyond the marker, up to
53             the value specified by C<MaxRecords>.
54              
55              
56              
57             =head2 MaxRecords => Int
58              
59             The maximum number of records to include in the response. If more
60             records exist than the specified C<MaxRecords> value, a marker is
61             included in the response so that the remaining results can be
62             retrieved.
63              
64             Default: 100
65              
66             Constraints: minimum 20; maximum 100.
67              
68              
69              
70             =head2 ShowCacheClustersNotInReplicationGroups => Bool
71              
72             An optional flag that can be included in the C<DescribeCacheCluster>
73             request to show only nodes (API/CLI: clusters) that are not members of
74             a replication group. In practice, this mean Memcached and single node
75             Redis clusters.
76              
77              
78              
79             =head2 ShowCacheNodeInfo => Bool
80              
81             An optional flag that can be included in the C<DescribeCacheCluster>
82             request to retrieve information about the individual cache nodes.
83              
84              
85              
86              
87             =head1 SEE ALSO
88              
89             This class forms part of L<Paws>, documenting arguments for method DescribeCacheClusters in L<Paws::ElastiCache>
90              
91             =head1 BUGS and CONTRIBUTIONS
92              
93             The source code is located here: https://github.com/pplu/aws-sdk-perl
94              
95             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
96              
97             =cut
98