blib/lib/Paws/RDS/DescribeDBSnapshots.pm

filter: Statementstmt 100% 19 / 19 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 2 / 2 Podpod n/a totaltotal 100% 21 / 21 CC 1 SCAR 0.0
CC
1
Cov
100%
BEGIN
1.0
BEGIN
1.0
CRAP 1.0
« blib/lib/Paws/RDS/DescribeDBSecurityGroups.pm ↑ Summary blib/lib/Paws/RDS/DescribeDBSubnetGroups.pm »
1  
2 package Paws::RDS::DescribeDBSnapshots;
3 1 ▶ use Moose;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 1 has DBInstanceIdentifier => (is => 'ro', isa => 'Str');
5 1 has DbiResourceId => (is => 'ro', isa => 'Str');
6 1 has DBSnapshotIdentifier => (is => 'ro', isa => 'Str');
7 1 has Filters => (is => 'ro', isa => 'ArrayRef[Paws::RDS::Filter]');
8 1 has IncludePublic => (is => 'ro', isa => 'Bool');
9 1 has IncludeShared => (is => 'ro', isa => 'Bool');
10 1 has Marker => (is => 'ro', isa => 'Str');
11 1 has MaxRecords => (is => 'ro', isa => 'Int');
12 1 has SnapshotType => (is => 'ro', isa => 'Str');
13  
14 1 ▶ use MooseX::ClassAttribute;
Subroutine BEGIN: called CC=1 SCAR=0.0
15  
16 1 class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeDBSnapshots');
17 1 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RDS::DBSnapshotMessage');
18 1 class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeDBSnapshotsResult');
19 1 1;
20  
21 ### main pod documentation begin ###
22  
23 =head1 NAME
24  
25 Paws::RDS::DescribeDBSnapshots - Arguments for method DescribeDBSnapshots on L<Paws::RDS>
26  
27 =head1 DESCRIPTION
28  
29 This class represents the parameters used for calling the method DescribeDBSnapshots on the
30 L<Amazon Relational Database Service|Paws::RDS> service. Use the attributes of this class
31 as arguments to method DescribeDBSnapshots.
32  
33 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeDBSnapshots.
34  
35 =head1 SYNOPSIS
36  
37 my $rds = Paws->service('RDS');
38 # To list DB snapshot attributes
39 # This example lists all manually-created, shared snapshots for the specified DB
40 # instance.
41 my $DBSnapshotMessage = $rds->DescribeDBSnapshots(
42 'DBInstanceIdentifier' => 'mymysqlinstance',
43 'IncludePublic' => 0,
44 'IncludeShared' => 1,
45 'SnapshotType' => 'manual'
46 );
47  
48  
49 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.
50 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/DescribeDBSnapshots>
51  
52 =head1 ATTRIBUTES
53  
54  
55 =head2 DBInstanceIdentifier => Str
56  
57 The ID of the DB instance to retrieve the list of DB snapshots for.
58 This parameter can't be used in conjunction with
59 C<DBSnapshotIdentifier>. This parameter isn't case-sensitive.
60  
61 Constraints:
62  
63 =over
64  
65 =item *
66  
67 If supplied, must match the identifier of an existing DBInstance.
68  
69 =back
70  
71  
72  
73  
74 =head2 DbiResourceId => Str
75  
76 A specific DB resource ID to describe.
77  
78  
79  
80 =head2 DBSnapshotIdentifier => Str
81  
82 A specific DB snapshot identifier to describe. This parameter can't be
83 used in conjunction with C<DBInstanceIdentifier>. This value is stored
84 as a lowercase string.
85  
86 Constraints:
87  
88 =over
89  
90 =item *
91  
92 If supplied, must match the identifier of an existing DBSnapshot.
93  
94 =item *
95  
96 If this identifier is for an automated snapshot, the C<SnapshotType>
97 parameter must also be specified.
98  
99 =back
100  
101  
102  
103  
104 =head2 Filters => ArrayRef[L<Paws::RDS::Filter>]
105  
106 A filter that specifies one or more DB snapshots to describe.
107  
108 Supported filters:
109  
110 =over
111  
112 =item *
113  
114 C<db-instance-id> - Accepts DB instance identifiers and DB instance
115 Amazon Resource Names (ARNs).
116  
117 =item *
118  
119 C<db-snapshot-id> - Accepts DB snapshot identifiers.
120  
121 =item *
122  
123 C<dbi-resource-id> - Accepts identifiers of source DB instances.
124  
125 =item *
126  
127 C<snapshot-type> - Accepts types of DB snapshots.
128  
129 =item *
130  
131 C<engine> - Accepts names of database engines.
132  
133 =back
134  
135  
136  
137  
138 =head2 IncludePublic => Bool
139  
140 A value that indicates whether to include manual DB cluster snapshots
141 that are public and can be copied or restored by any Amazon Web
142 Services account. By default, the public snapshots are not included.
143  
144 You can share a manual DB snapshot as public by using the
145 ModifyDBSnapshotAttribute API.
146  
147  
148  
149 =head2 IncludeShared => Bool
150  
151 A value that indicates whether to include shared manual DB cluster
152 snapshots from other Amazon Web Services accounts that this Amazon Web
153 Services account has been given permission to copy or restore. By
154 default, these snapshots are not included.
155  
156 You can give an Amazon Web Services account permission to restore a
157 manual DB snapshot from another Amazon Web Services account by using
158 the C<ModifyDBSnapshotAttribute> API action.
159  
160  
161  
162 =head2 Marker => Str
163  
164 An optional pagination token provided by a previous
165 C<DescribeDBSnapshots> request. If this parameter is specified, the
166 response includes only records beyond the marker, up to the value
167 specified by C<MaxRecords>.
168  
169  
170  
171 =head2 MaxRecords => Int
172  
173 The maximum number of records to include in the response. If more
174 records exist than the specified C<MaxRecords> value, a pagination
175 token called a marker is included in the response so that you can
176 retrieve the remaining results.
177  
178 Default: 100
179  
180 Constraints: Minimum 20, maximum 100.
181  
182  
183  
184 =head2 SnapshotType => Str
185  
186 The type of snapshots to be returned. You can specify one of the
187 following values:
188  
189 =over
190  
191 =item *
192  
193 C<automated> - Return all DB snapshots that have been automatically
194 taken by Amazon RDS for my Amazon Web Services account.
195  
196 =item *
197  
198 C<manual> - Return all DB snapshots that have been taken by my Amazon
199 Web Services account.
200  
201 =item *
202  
203 C<shared> - Return all manual DB snapshots that have been shared to my
204 Amazon Web Services account.
205  
206 =item *
207  
208 C<public> - Return all DB snapshots that have been marked as public.
209  
210 =item *
211  
212 C<awsbackup> - Return the DB snapshots managed by the Amazon Web
213 Services Backup service.
214  
215 For information about Amazon Web Services Backup, see the I<Amazon Web
216 Services Backup Developer Guide.>
217 (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html)
218  
219 The C<awsbackup> type does not apply to Aurora.
220  
221 =back
222  
223 If you don't specify a C<SnapshotType> value, then both automated and
224 manual snapshots are returned. Shared and public DB snapshots are not
225 included in the returned results by default. You can include shared
226 snapshots with these results by enabling the C<IncludeShared>
227 parameter. You can include public snapshots with these results by
228 enabling the C<IncludePublic> parameter.
229  
230 The C<IncludeShared> and C<IncludePublic> parameters don't apply for
231 C<SnapshotType> values of C<manual> or C<automated>. The
232 C<IncludePublic> parameter doesn't apply when C<SnapshotType> is set to
233 C<shared>. The C<IncludeShared> parameter doesn't apply when
234 C<SnapshotType> is set to C<public>.
235  
236  
237  
238  
239 =head1 SEE ALSO
240  
241 This class forms part of L<Paws>, documenting arguments for method DescribeDBSnapshots in L<Paws::RDS>
242  
243 =head1 BUGS and CONTRIBUTIONS
244  
245 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
246  
247 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
248  
249 =cut
250  
« blib/lib/Paws/RDS/DescribeDBSecurityGroups.pm ↑ Summary blib/lib/Paws/RDS/DescribeDBSubnetGroups.pm »