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