blib/lib/Paws/ElastiCache/Snapshot.pm untested

filter: Statementstmt 0.0% 0 / 31 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 32 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::ElastiCache::Snapshot;
3 use Moose;
4 has ARN => (is => 'ro', isa => 'Str');
5 has AutomaticFailover => (is => 'ro', isa => 'Str');
6 has AutoMinorVersionUpgrade => (is => 'ro', isa => 'Bool');
7 has CacheClusterCreateTime => (is => 'ro', isa => 'Str');
8 has CacheClusterId => (is => 'ro', isa => 'Str');
9 has CacheNodeType => (is => 'ro', isa => 'Str');
10 has CacheParameterGroupName => (is => 'ro', isa => 'Str');
11 has CacheSubnetGroupName => (is => 'ro', isa => 'Str');
12 has Engine => (is => 'ro', isa => 'Str');
13 has EngineVersion => (is => 'ro', isa => 'Str');
14 has KmsKeyId => (is => 'ro', isa => 'Str');
15 has NodeSnapshots => (is => 'ro', isa => 'ArrayRef[Paws::ElastiCache::NodeSnapshot]', request_name => 'NodeSnapshot', traits => ['NameInRequest']);
16 has NumCacheNodes => (is => 'ro', isa => 'Int');
17 has NumNodeGroups => (is => 'ro', isa => 'Int');
18 has Port => (is => 'ro', isa => 'Int');
19 has PreferredAvailabilityZone => (is => 'ro', isa => 'Str');
20 has PreferredMaintenanceWindow => (is => 'ro', isa => 'Str');
21 has PreferredOutpostArn => (is => 'ro', isa => 'Str');
22 has ReplicationGroupDescription => (is => 'ro', isa => 'Str');
23 has ReplicationGroupId => (is => 'ro', isa => 'Str');
24 has SnapshotName => (is => 'ro', isa => 'Str');
25 has SnapshotRetentionLimit => (is => 'ro', isa => 'Int');
26 has SnapshotSource => (is => 'ro', isa => 'Str');
27 has SnapshotStatus => (is => 'ro', isa => 'Str');
28 has SnapshotWindow => (is => 'ro', isa => 'Str');
29 has TopicArn => (is => 'ro', isa => 'Str');
30 has VpcId => (is => 'ro', isa => 'Str');
31  
32 1;
33  
34 ### main pod documentation begin ###
35  
36 =head1 NAME
37  
38 Paws::ElastiCache::Snapshot
39  
40 =head1 USAGE
41  
42 This class represents one of two things:
43  
44 =head3 Arguments in a call to a service
45  
46 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
47 Each attribute should be used as a named argument in the calls that expect this type of object.
48  
49 As an example, if Att1 is expected to be a Paws::ElastiCache::Snapshot object:
50  
51 $service_obj->Method(Att1 => { ARN => $value, ..., VpcId => $value });
52  
53 =head3 Results returned from an API call
54  
55 Use accessors for each attribute. If Att1 is expected to be an Paws::ElastiCache::Snapshot object:
56  
57 $result = $service_obj->Method(...);
58 $result->Att1->ARN
59  
60 =head1 DESCRIPTION
61  
62 Represents a copy of an entire Redis cluster as of the time when the
63 snapshot was taken.
64  
65 =head1 ATTRIBUTES
66  
67  
68 =head2 ARN => Str
69  
70 The ARN (Amazon Resource Name) of the snapshot.
71  
72  
73 =head2 AutomaticFailover => Str
74  
75 Indicates the status of automatic failover for the source Redis
76 replication group.
77  
78  
79 =head2 AutoMinorVersionUpgrade => Bool
80  
81 This parameter is currently disabled.
82  
83  
84 =head2 CacheClusterCreateTime => Str
85  
86 The date and time when the source cluster was created.
87  
88  
89 =head2 CacheClusterId => Str
90  
91 The user-supplied identifier of the source cluster.
92  
93  
94 =head2 CacheNodeType => Str
95  
96 The name of the compute and memory capacity node type for the source
97 cluster.
98  
99 The following node types are supported by ElastiCache. Generally
100 speaking, the current generation types provide more memory and
101 computational power at lower cost when compared to their equivalent
102 previous generation counterparts.
103  
104 =over
105  
106 =item *
107  
108 General purpose:
109  
110 =over
111  
112 =item *
113  
114 Current generation:
115  
116 B<M6g node types> (available only for Redis engine version 5.0.6 onward
117 and for Memcached engine version 1.5.16 onward).
118  
119 C<cache.m6g.large>, C<cache.m6g.xlarge>, C<cache.m6g.2xlarge>,
120 C<cache.m6g.4xlarge>, C<cache.m6g.8xlarge>, C<cache.m6g.12xlarge>,
121 C<cache.m6g.16xlarge>
122  
123 For region availability, see Supported Node Types
124 (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)
125  
126 B<M5 node types:> C<cache.m5.large>, C<cache.m5.xlarge>,
127 C<cache.m5.2xlarge>, C<cache.m5.4xlarge>, C<cache.m5.12xlarge>,
128 C<cache.m5.24xlarge>
129  
130 B<M4 node types:> C<cache.m4.large>, C<cache.m4.xlarge>,
131 C<cache.m4.2xlarge>, C<cache.m4.4xlarge>, C<cache.m4.10xlarge>
132  
133 B<T3 node types:> C<cache.t3.micro>, C<cache.t3.small>,
134 C<cache.t3.medium>
135  
136 B<T2 node types:> C<cache.t2.micro>, C<cache.t2.small>,
137 C<cache.t2.medium>
138  
139 =item *
140  
141 Previous generation: (not recommended)
142  
143 B<T1 node types:> C<cache.t1.micro>
144  
145 B<M1 node types:> C<cache.m1.small>, C<cache.m1.medium>,
146 C<cache.m1.large>, C<cache.m1.xlarge>
147  
148 B<M3 node types:> C<cache.m3.medium>, C<cache.m3.large>,
149 C<cache.m3.xlarge>, C<cache.m3.2xlarge>
150  
151 =back
152  
153 =item *
154  
155 Compute optimized:
156  
157 =over
158  
159 =item *
160  
161 Previous generation: (not recommended)
162  
163 B<C1 node types:> C<cache.c1.xlarge>
164  
165 =back
166  
167 =item *
168  
169 Memory optimized:
170  
171 =over
172  
173 =item *
174  
175 Current generation:
176  
177 B<R6g node types> (available only for Redis engine version 5.0.6 onward
178 and for Memcached engine version 1.5.16 onward).
179  
180 C<cache.r6g.large>, C<cache.r6g.xlarge>, C<cache.r6g.2xlarge>,
181 C<cache.r6g.4xlarge>, C<cache.r6g.8xlarge>, C<cache.r6g.12xlarge>,
182 C<cache.r6g.16xlarge>
183  
184 For region availability, see Supported Node Types
185 (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)
186  
187 B<R5 node types:> C<cache.r5.large>, C<cache.r5.xlarge>,
188 C<cache.r5.2xlarge>, C<cache.r5.4xlarge>, C<cache.r5.12xlarge>,
189 C<cache.r5.24xlarge>
190  
191 B<R4 node types:> C<cache.r4.large>, C<cache.r4.xlarge>,
192 C<cache.r4.2xlarge>, C<cache.r4.4xlarge>, C<cache.r4.8xlarge>,
193 C<cache.r4.16xlarge>
194  
195 =item *
196  
197 Previous generation: (not recommended)
198  
199 B<M2 node types:> C<cache.m2.xlarge>, C<cache.m2.2xlarge>,
200 C<cache.m2.4xlarge>
201  
202 B<R3 node types:> C<cache.r3.large>, C<cache.r3.xlarge>,
203 C<cache.r3.2xlarge>, C<cache.r3.4xlarge>, C<cache.r3.8xlarge>
204  
205 =back
206  
207 =back
208  
209 B<Additional node type info>
210  
211 =over
212  
213 =item *
214  
215 All current generation instance types are created in Amazon VPC by
216 default.
217  
218 =item *
219  
220 Redis append-only files (AOF) are not supported for T1 or T2 instances.
221  
222 =item *
223  
224 Redis Multi-AZ with automatic failover is not supported on T1
225 instances.
226  
227 =item *
228  
229 Redis configuration variables C<appendonly> and C<appendfsync> are not
230 supported on Redis version 2.8.22 and later.
231  
232 =back
233  
234  
235  
236 =head2 CacheParameterGroupName => Str
237  
238 The cache parameter group that is associated with the source cluster.
239  
240  
241 =head2 CacheSubnetGroupName => Str
242  
243 The name of the cache subnet group associated with the source cluster.
244  
245  
246 =head2 Engine => Str
247  
248 The name of the cache engine (C<memcached> or C<redis>) used by the
249 source cluster.
250  
251  
252 =head2 EngineVersion => Str
253  
254 The version of the cache engine version that is used by the source
255 cluster.
256  
257  
258 =head2 KmsKeyId => Str
259  
260 The ID of the KMS key used to encrypt the snapshot.
261  
262  
263 =head2 NodeSnapshots => ArrayRef[L<Paws::ElastiCache::NodeSnapshot>]
264  
265 A list of the cache nodes in the source cluster.
266  
267  
268 =head2 NumCacheNodes => Int
269  
270 The number of cache nodes in the source cluster.
271  
272 For clusters running Redis, this value must be 1. For clusters running
273 Memcached, this value must be between 1 and 40.
274  
275  
276 =head2 NumNodeGroups => Int
277  
278 The number of node groups (shards) in this snapshot. When restoring
279 from a snapshot, the number of node groups (shards) in the snapshot and
280 in the restored replication group must be the same.
281  
282  
283 =head2 Port => Int
284  
285 The port number used by each cache nodes in the source cluster.
286  
287  
288 =head2 PreferredAvailabilityZone => Str
289  
290 The name of the Availability Zone in which the source cluster is
291 located.
292  
293  
294 =head2 PreferredMaintenanceWindow => Str
295  
296 Specifies the weekly time range during which maintenance on the cluster
297 is performed. It is specified as a range in the format
298 ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window
299 is a 60 minute period.
300  
301 Valid values for C<ddd> are:
302  
303 =over
304  
305 =item *
306  
307 C<sun>
308  
309 =item *
310  
311 C<mon>
312  
313 =item *
314  
315 C<tue>
316  
317 =item *
318  
319 C<wed>
320  
321 =item *
322  
323 C<thu>
324  
325 =item *
326  
327 C<fri>
328  
329 =item *
330  
331 C<sat>
332  
333 =back
334  
335 Example: C<sun:23:00-mon:01:30>
336  
337  
338 =head2 PreferredOutpostArn => Str
339  
340 The ARN (Amazon Resource Name) of the preferred outpost.
341  
342  
343 =head2 ReplicationGroupDescription => Str
344  
345 A description of the source replication group.
346  
347  
348 =head2 ReplicationGroupId => Str
349  
350 The unique identifier of the source replication group.
351  
352  
353 =head2 SnapshotName => Str
354  
355 The name of a snapshot. For an automatic snapshot, the name is
356 system-generated. For a manual snapshot, this is the user-provided
357 name.
358  
359  
360 =head2 SnapshotRetentionLimit => Int
361  
362 For an automatic snapshot, the number of days for which ElastiCache
363 retains the snapshot before deleting it.
364  
365 For manual snapshots, this field reflects the C<SnapshotRetentionLimit>
366 for the source cluster when the snapshot was created. This field is
367 otherwise ignored: Manual snapshots do not expire, and can only be
368 deleted using the C<DeleteSnapshot> operation.
369  
370 B<Important> If the value of SnapshotRetentionLimit is set to zero (0),
371 backups are turned off.
372  
373  
374 =head2 SnapshotSource => Str
375  
376 Indicates whether the snapshot is from an automatic backup
377 (C<automated>) or was created manually (C<manual>).
378  
379  
380 =head2 SnapshotStatus => Str
381  
382 The status of the snapshot. Valid values: C<creating> | C<available> |
383 C<restoring> | C<copying> | C<deleting>.
384  
385  
386 =head2 SnapshotWindow => Str
387  
388 The daily time range during which ElastiCache takes daily snapshots of
389 the source cluster.
390  
391  
392 =head2 TopicArn => Str
393  
394 The Amazon Resource Name (ARN) for the topic used by the source cluster
395 for publishing notifications.
396  
397  
398 =head2 VpcId => Str
399  
400 The Amazon Virtual Private Cloud identifier (VPC ID) of the cache
401 subnet group for the source cluster.
402  
403  
404  
405 =head1 SEE ALSO
406  
407 This class forms part of L<Paws>, describing an object used in L<Paws::ElastiCache>
408  
409 =head1 BUGS and CONTRIBUTIONS
410  
411 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
412  
413 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
414  
415 =cut
416