blib/lib/Paws/RDS/DescribeDBClusterSnapshots.pm untested

filter: Statementstmt 0.0% 0 / 17 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 19 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::RDS::DescribeDBClusterSnapshots;
3 use Moose;
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 use MooseX::ClassAttribute;
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 L<Paws::RDS>
25  
26 =head1 DESCRIPTION
27  
28 This class represents the parameters used for calling the method DescribeDBClusterSnapshots on the
29 L<Amazon Relational Database Service|Paws::RDS> 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 =head1 SYNOPSIS
35  
36 my $rds = Paws->service('RDS');
37 # To list DB cluster snapshots
38 # This example lists settings for the specified, manually-created cluster
39 # snapshot.
40 my $DBClusterSnapshotMessage = $rds->DescribeDBClusterSnapshots(
41 'DBClusterSnapshotIdentifier' => 'mydbclustersnapshot',
42 'SnapshotType' => 'manual'
43 );
44  
45  
46 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.
47 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/DescribeDBClusterSnapshots>
48  
49 =head1 ATTRIBUTES
50  
51  
52 =head2 DBClusterIdentifier => Str
53  
54 The ID of the DB cluster to retrieve the list of DB cluster snapshots
55 for. This parameter can't be used in conjunction with the
56 C<DBClusterSnapshotIdentifier> parameter. This parameter isn't
57 case-sensitive.
58  
59 Constraints:
60  
61 =over
62  
63 =item *
64  
65 If supplied, must match the identifier of an existing DBCluster.
66  
67 =back
68  
69  
70  
71  
72 =head2 DBClusterSnapshotIdentifier => Str
73  
74 A specific DB cluster snapshot identifier to describe. This parameter
75 can't be used in conjunction with the C<DBClusterIdentifier> parameter.
76 This value is stored as a lowercase string.
77  
78 Constraints:
79  
80 =over
81  
82 =item *
83  
84 If supplied, must match the identifier of an existing
85 DBClusterSnapshot.
86  
87 =item *
88  
89 If this identifier is for an automated snapshot, the C<SnapshotType>
90 parameter must also be specified.
91  
92 =back
93  
94  
95  
96  
97 =head2 Filters => ArrayRef[L<Paws::RDS::Filter>]
98  
99 A filter that specifies one or more DB cluster snapshots to describe.
100  
101 Supported filters:
102  
103 =over
104  
105 =item *
106  
107 C<db-cluster-id> - Accepts DB cluster identifiers and DB cluster Amazon
108 Resource Names (ARNs).
109  
110 =item *
111  
112 C<db-cluster-snapshot-id> - Accepts DB cluster snapshot identifiers.
113  
114 =item *
115  
116 C<snapshot-type> - Accepts types of DB cluster snapshots.
117  
118 =item *
119  
120 C<engine> - Accepts names of database engines.
121  
122 =back
123  
124  
125  
126  
127 =head2 IncludePublic => Bool
128  
129 A value that indicates whether to include manual DB cluster snapshots
130 that are public and can be copied or restored by any Amazon Web
131 Services account. By default, the public snapshots are not included.
132  
133 You can share a manual DB cluster snapshot as public by using the
134 ModifyDBClusterSnapshotAttribute API action.
135  
136  
137  
138 =head2 IncludeShared => Bool
139  
140 A value that indicates whether to include shared manual DB cluster
141 snapshots from other Amazon Web Services accounts that this Amazon Web
142 Services account has been given permission to copy or restore. By
143 default, these snapshots are not included.
144  
145 You can give an Amazon Web Services account permission to restore a
146 manual DB cluster snapshot from another Amazon Web Services account by
147 the C<ModifyDBClusterSnapshotAttribute> API action.
148  
149  
150  
151 =head2 Marker => Str
152  
153 An optional pagination token provided by a previous
154 C<DescribeDBClusterSnapshots> request. If this parameter is specified,
155 the response includes only records beyond the marker, up to the value
156 specified by C<MaxRecords>.
157  
158  
159  
160 =head2 MaxRecords => Int
161  
162 The maximum number of records to include in the response. If more
163 records exist than the specified C<MaxRecords> value, a pagination
164 token called a marker is included in the response so you can retrieve
165 the remaining results.
166  
167 Default: 100
168  
169 Constraints: Minimum 20, maximum 100.
170  
171  
172  
173 =head2 SnapshotType => Str
174  
175 The type of DB cluster snapshots to be returned. You can specify one of
176 the following values:
177  
178 =over
179  
180 =item *
181  
182 C<automated> - Return all DB cluster snapshots that have been
183 automatically taken by Amazon RDS for my Amazon Web Services account.
184  
185 =item *
186  
187 C<manual> - Return all DB cluster snapshots that have been taken by my
188 Amazon Web Services account.
189  
190 =item *
191  
192 C<shared> - Return all manual DB cluster snapshots that have been
193 shared to my Amazon Web Services account.
194  
195 =item *
196  
197 C<public> - Return all DB cluster snapshots that have been marked as
198 public.
199  
200 =back
201  
202 If you don't specify a C<SnapshotType> value, then both automated and
203 manual DB cluster snapshots are returned. You can include shared DB
204 cluster snapshots with these results by enabling the C<IncludeShared>
205 parameter. You can include public DB cluster snapshots with these
206 results by enabling the C<IncludePublic> parameter.
207  
208 The C<IncludeShared> and C<IncludePublic> parameters don't apply for
209 C<SnapshotType> values of C<manual> or C<automated>. The
210 C<IncludePublic> parameter doesn't apply when C<SnapshotType> is set to
211 C<shared>. The C<IncludeShared> parameter doesn't apply when
212 C<SnapshotType> is set to C<public>.
213  
214  
215  
216  
217 =head1 SEE ALSO
218  
219 This class forms part of L<Paws>, documenting arguments for method DescribeDBClusterSnapshots in L<Paws::RDS>
220  
221 =head1 BUGS and CONTRIBUTIONS
222  
223 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
224  
225 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
226  
227 =cut
228