File Coverage

blib/lib/Paws/RDS/DescribeDBSnapshots.pm
Criterion Covered Total %
statement 12 12 100.0
branch n/a
condition n/a
subroutine 4 4 100.0
pod n/a
total 16 16 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::RDS::DescribeDBSnapshots;
3 1     1   433 use Moose;
  1     1   4  
  1         7  
  1         476  
  1         4  
  1         8  
4             has DBInstanceIdentifier => (is => 'ro', isa => 'Str');
5             has DBSnapshotIdentifier => (is => 'ro', isa => 'Str');
6             has Filters => (is => 'ro', isa => 'ArrayRef[Paws::RDS::Filter]');
7             has IncludePublic => (is => 'ro', isa => 'Bool');
8             has IncludeShared => (is => 'ro', isa => 'Bool');
9             has Marker => (is => 'ro', isa => 'Str');
10             has MaxRecords => (is => 'ro', isa => 'Int');
11             has SnapshotType => (is => 'ro', isa => 'Str');
12              
13 1     1   5758 use MooseX::ClassAttribute;
  1     1   1  
  1         9  
  1         6276  
  1         3  
  1         7  
14              
15             class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeDBSnapshots');
16             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RDS::DBSnapshotMessage');
17             class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeDBSnapshotsResult');
18             1;
19              
20             ### main pod documentation begin ###
21              
22             =head1 NAME
23              
24             Paws::RDS::DescribeDBSnapshots - Arguments for method DescribeDBSnapshots on Paws::RDS
25              
26             =head1 DESCRIPTION
27              
28             This class represents the parameters used for calling the method DescribeDBSnapshots on the
29             Amazon Relational Database Service service. Use the attributes of this class
30             as arguments to method DescribeDBSnapshots.
31              
32             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeDBSnapshots.
33              
34             As an example:
35              
36             $service_obj->DescribeDBSnapshots(Att1 => $value1, Att2 => $value2, ...);
37              
38             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.
39              
40             =head1 ATTRIBUTES
41              
42              
43             =head2 DBInstanceIdentifier => Str
44              
45             The ID of the DB instance to retrieve the list of DB snapshots for.
46             This parameter cannot be used in conjunction with
47             C<DBSnapshotIdentifier>. This parameter is not case-sensitive.
48              
49             Constraints:
50              
51             =over
52              
53             =item *
54              
55             Must contain from 1 to 63 alphanumeric characters or hyphens
56              
57             =item *
58              
59             First character must be a letter
60              
61             =item *
62              
63             Cannot end with a hyphen or contain two consecutive hyphens
64              
65             =back
66              
67              
68              
69              
70             =head2 DBSnapshotIdentifier => Str
71              
72             A specific DB snapshot identifier to describe. This parameter cannot be
73             used in conjunction with C<DBInstanceIdentifier>. This value is stored
74             as a lowercase string.
75              
76             Constraints:
77              
78             =over
79              
80             =item *
81              
82             Must be 1 to 255 alphanumeric characters.
83              
84             =item *
85              
86             First character must be a letter.
87              
88             =item *
89              
90             Cannot end with a hyphen or contain two consecutive hyphens.
91              
92             =item *
93              
94             If this identifier is for an automated snapshot, the C<SnapshotType>
95             parameter must also be specified.
96              
97             =back
98              
99              
100              
101              
102             =head2 Filters => ArrayRef[L<Paws::RDS::Filter>]
103              
104             This parameter is not currently supported.
105              
106              
107              
108             =head2 IncludePublic => Bool
109              
110             Set this value to C<true> to include manual DB snapshots that are
111             public and can be copied or restored by any AWS account, otherwise set
112             this value to C<false>. The default is C<false>.
113              
114             You can share a manual DB snapshot as public by using the
115             ModifyDBSnapshotAttribute API.
116              
117              
118              
119             =head2 IncludeShared => Bool
120              
121             Set this value to C<true> to include shared manual DB snapshots from
122             other AWS accounts that this AWS account has been given permission to
123             copy or restore, otherwise set this value to C<false>. The default is
124             C<false>.
125              
126             You can give an AWS account permission to restore a manual DB snapshot
127             from another AWS account by using the ModifyDBSnapshotAttribute API
128             action.
129              
130              
131              
132             =head2 Marker => Str
133              
134             An optional pagination token provided by a previous
135             C<DescribeDBSnapshots> request. If this parameter is specified, the
136             response includes only records beyond the marker, up to the value
137             specified by C<MaxRecords>.
138              
139              
140              
141             =head2 MaxRecords => Int
142              
143             The maximum number of records to include in the response. If more
144             records exist than the specified C<MaxRecords> value, a pagination
145             token called a marker is included in the response so that the remaining
146             results can be retrieved.
147              
148             Default: 100
149              
150             Constraints: Minimum 20, maximum 100.
151              
152              
153              
154             =head2 SnapshotType => Str
155              
156             The type of snapshots to be returned. You can specify one of the
157             following values:
158              
159             =over
160              
161             =item *
162              
163             C<automated> - Return all DB snapshots that have been automatically
164             taken by Amazon RDS for my AWS account.
165              
166             =item *
167              
168             C<manual> - Return all DB snapshots that have been taken by my AWS
169             account.
170              
171             =item *
172              
173             C<shared> - Return all manual DB snapshots that have been shared to my
174             AWS account.
175              
176             =item *
177              
178             C<public> - Return all DB snapshots that have been marked as public.
179              
180             =back
181              
182             If you don't specify a C<SnapshotType> value, then both automated and
183             manual snapshots are returned. Shared and public DB snapshots are not
184             included in the returned results by default. You can include shared
185             snapshots with these results by setting the C<IncludeShared> parameter
186             to C<true>. You can include public snapshots with these results by
187             setting the C<IncludePublic> parameter to C<true>.
188              
189             The C<IncludeShared> and C<IncludePublic> parameters don't apply for
190             C<SnapshotType> values of C<manual> or C<automated>. The
191             C<IncludePublic> parameter doesn't apply when C<SnapshotType> is set to
192             C<shared>. The C<IncludeShared> parameter doesn't apply when
193             C<SnapshotType> is set to C<public>.
194              
195              
196              
197              
198             =head1 SEE ALSO
199              
200             This class forms part of L<Paws>, documenting arguments for method DescribeDBSnapshots in L<Paws::RDS>
201              
202             =head1 BUGS and CONTRIBUTIONS
203              
204             The source code is located here: https://github.com/pplu/aws-sdk-perl
205              
206             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
207              
208             =cut
209