File Coverage

blib/lib/Paws/ElastiCache/DescribeSnapshots.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::DescribeSnapshots;
3 1     1   540 use Moose;
  1         2  
  1         8  
4             has CacheClusterId => (is => 'ro', isa => 'Str');
5             has Marker => (is => 'ro', isa => 'Str');
6             has MaxRecords => (is => 'ro', isa => 'Int');
7             has ReplicationGroupId => (is => 'ro', isa => 'Str');
8             has ShowNodeGroupConfig => (is => 'ro', isa => 'Bool');
9             has SnapshotName => (is => 'ro', isa => 'Str');
10             has SnapshotSource => (is => 'ro', isa => 'Str');
11              
12 1     1   6570 use MooseX::ClassAttribute;
  1         2  
  1         10  
13              
14             class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeSnapshots');
15             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ElastiCache::DescribeSnapshotsListMessage');
16             class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeSnapshotsResult');
17             1;
18              
19             ### main pod documentation begin ###
20              
21             =head1 NAME
22              
23             Paws::ElastiCache::DescribeSnapshots - Arguments for method DescribeSnapshots on Paws::ElastiCache
24              
25             =head1 DESCRIPTION
26              
27             This class represents the parameters used for calling the method DescribeSnapshots on the
28             Amazon ElastiCache service. Use the attributes of this class
29             as arguments to method DescribeSnapshots.
30              
31             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeSnapshots.
32              
33             As an example:
34              
35             $service_obj->DescribeSnapshots(Att1 => $value1, Att2 => $value2, ...);
36              
37             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.
38              
39             =head1 ATTRIBUTES
40              
41              
42             =head2 CacheClusterId => Str
43              
44             A user-supplied cluster identifier. If this parameter is specified,
45             only snapshots associated with that specific cache cluster are
46             described.
47              
48              
49              
50             =head2 Marker => Str
51              
52             An optional marker returned from a prior request. Use this marker for
53             pagination of results from this operation. If this parameter is
54             specified, the response includes only records beyond the marker, up to
55             the value specified by C<MaxRecords>.
56              
57              
58              
59             =head2 MaxRecords => Int
60              
61             The maximum number of records to include in the response. If more
62             records exist than the specified C<MaxRecords> value, a marker is
63             included in the response so that the remaining results can be
64             retrieved.
65              
66             Default: 50
67              
68             Constraints: minimum 20; maximum 50.
69              
70              
71              
72             =head2 ReplicationGroupId => Str
73              
74             A user-supplied replication group identifier. If this parameter is
75             specified, only snapshots associated with that specific replication
76             group are described.
77              
78              
79              
80             =head2 ShowNodeGroupConfig => Bool
81              
82             A Boolean value which if true, the node group (shard) configuration is
83             included in the snapshot description.
84              
85              
86              
87             =head2 SnapshotName => Str
88              
89             A user-supplied name of the snapshot. If this parameter is specified,
90             only this snapshot are described.
91              
92              
93              
94             =head2 SnapshotSource => Str
95              
96             If set to C<system>, the output shows snapshots that were automatically
97             created by ElastiCache. If set to C<user> the output shows snapshots
98             that were manually created. If omitted, the output shows both
99             automatically and manually created snapshots.
100              
101              
102              
103              
104             =head1 SEE ALSO
105              
106             This class forms part of L<Paws>, documenting arguments for method DescribeSnapshots in L<Paws::ElastiCache>
107              
108             =head1 BUGS and CONTRIBUTIONS
109              
110             The source code is located here: https://github.com/pplu/aws-sdk-perl
111              
112             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
113              
114             =cut
115