File Coverage

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