File Coverage

blib/lib/Paws/RedShift/Snapshot.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             package Paws::RedShift::Snapshot;
2 1     1   365 use Moose;
  1     1   3  
  1         7  
  1         433  
  1         2  
  1         6  
3             has AccountsWithRestoreAccess => (is => 'ro', isa => 'ArrayRef[Paws::RedShift::AccountWithRestoreAccess]', request_name => 'AccountWithRestoreAccess', traits => ['NameInRequest']);
4             has ActualIncrementalBackupSizeInMegaBytes => (is => 'ro', isa => 'Num');
5             has AvailabilityZone => (is => 'ro', isa => 'Str');
6             has BackupProgressInMegaBytes => (is => 'ro', isa => 'Num');
7             has ClusterCreateTime => (is => 'ro', isa => 'Str');
8             has ClusterIdentifier => (is => 'ro', isa => 'Str');
9             has ClusterVersion => (is => 'ro', isa => 'Str');
10             has CurrentBackupRateInMegaBytesPerSecond => (is => 'ro', isa => 'Num');
11             has DBName => (is => 'ro', isa => 'Str');
12             has ElapsedTimeInSeconds => (is => 'ro', isa => 'Int');
13             has Encrypted => (is => 'ro', isa => 'Bool');
14             has EncryptedWithHSM => (is => 'ro', isa => 'Bool');
15             has EnhancedVpcRouting => (is => 'ro', isa => 'Bool');
16             has EstimatedSecondsToCompletion => (is => 'ro', isa => 'Int');
17             has KmsKeyId => (is => 'ro', isa => 'Str');
18             has MasterUsername => (is => 'ro', isa => 'Str');
19             has NodeType => (is => 'ro', isa => 'Str');
20             has NumberOfNodes => (is => 'ro', isa => 'Int');
21             has OwnerAccount => (is => 'ro', isa => 'Str');
22             has Port => (is => 'ro', isa => 'Int');
23             has RestorableNodeTypes => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'NodeType', traits => ['NameInRequest']);
24             has SnapshotCreateTime => (is => 'ro', isa => 'Str');
25             has SnapshotIdentifier => (is => 'ro', isa => 'Str');
26             has SnapshotType => (is => 'ro', isa => 'Str');
27             has SourceRegion => (is => 'ro', isa => 'Str');
28             has Status => (is => 'ro', isa => 'Str');
29             has Tags => (is => 'ro', isa => 'ArrayRef[Paws::RedShift::Tag]', request_name => 'Tag', traits => ['NameInRequest']);
30             has TotalBackupSizeInMegaBytes => (is => 'ro', isa => 'Num');
31             has VpcId => (is => 'ro', isa => 'Str');
32             1;
33              
34             ### main pod documentation begin ###
35              
36             =head1 NAME
37              
38             Paws::RedShift::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::RedShift::Snapshot object:
50              
51             $service_obj->Method(Att1 => { AccountsWithRestoreAccess => $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::RedShift::Snapshot object:
56              
57             $result = $service_obj->Method(...);
58             $result->Att1->AccountsWithRestoreAccess
59              
60             =head1 DESCRIPTION
61              
62             Describes a snapshot.
63              
64             =head1 ATTRIBUTES
65              
66              
67             =head2 AccountsWithRestoreAccess => ArrayRef[L<Paws::RedShift::AccountWithRestoreAccess>]
68              
69             A list of the AWS customer accounts authorized to restore the snapshot.
70             Returns C<null> if no accounts are authorized. Visible only to the
71             snapshot owner.
72              
73              
74             =head2 ActualIncrementalBackupSizeInMegaBytes => Num
75              
76             The size of the incremental backup.
77              
78              
79             =head2 AvailabilityZone => Str
80              
81             The Availability Zone in which the cluster was created.
82              
83              
84             =head2 BackupProgressInMegaBytes => Num
85              
86             The number of megabytes that have been transferred to the snapshot
87             backup.
88              
89              
90             =head2 ClusterCreateTime => Str
91              
92             The time (UTC) when the cluster was originally created.
93              
94              
95             =head2 ClusterIdentifier => Str
96              
97             The identifier of the cluster for which the snapshot was taken.
98              
99              
100             =head2 ClusterVersion => Str
101              
102             The version ID of the Amazon Redshift engine that is running on the
103             cluster.
104              
105              
106             =head2 CurrentBackupRateInMegaBytesPerSecond => Num
107              
108             The number of megabytes per second being transferred to the snapshot
109             backup. Returns C<0> for a completed backup.
110              
111              
112             =head2 DBName => Str
113              
114             The name of the database that was created when the cluster was created.
115              
116              
117             =head2 ElapsedTimeInSeconds => Int
118              
119             The amount of time an in-progress snapshot backup has been running, or
120             the amount of time it took a completed backup to finish.
121              
122              
123             =head2 Encrypted => Bool
124              
125             If C<true>, the data in the snapshot is encrypted at rest.
126              
127              
128             =head2 EncryptedWithHSM => Bool
129              
130             A boolean that indicates whether the snapshot data is encrypted using
131             the HSM keys of the source cluster. C<true> indicates that the data is
132             encrypted using HSM keys.
133              
134              
135             =head2 EnhancedVpcRouting => Bool
136              
137             An option that specifies whether to create the cluster with enhanced
138             VPC routing enabled. To create a cluster that uses enhanced VPC
139             routing, the cluster must be in a VPC. For more information, see
140             Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
141              
142             If this option is C<true>, enhanced VPC routing is enabled.
143              
144             Default: false
145              
146              
147             =head2 EstimatedSecondsToCompletion => Int
148              
149             The estimate of the time remaining before the snapshot backup will
150             complete. Returns C<0> for a completed backup.
151              
152              
153             =head2 KmsKeyId => Str
154              
155             The AWS Key Management Service (KMS) key ID of the encryption key that
156             was used to encrypt data in the cluster from which the snapshot was
157             taken.
158              
159              
160             =head2 MasterUsername => Str
161              
162             The master user name for the cluster.
163              
164              
165             =head2 NodeType => Str
166              
167             The node type of the nodes in the cluster.
168              
169              
170             =head2 NumberOfNodes => Int
171              
172             The number of nodes in the cluster.
173              
174              
175             =head2 OwnerAccount => Str
176              
177             For manual snapshots, the AWS customer account used to create or copy
178             the snapshot. For automatic snapshots, the owner of the cluster. The
179             owner can perform all snapshot actions, such as sharing a manual
180             snapshot.
181              
182              
183             =head2 Port => Int
184              
185             The port that the cluster is listening on.
186              
187              
188             =head2 RestorableNodeTypes => ArrayRef[Str|Undef]
189              
190             The list of node types that this cluster snapshot is able to restore
191             into.
192              
193              
194             =head2 SnapshotCreateTime => Str
195              
196             The time (UTC) when Amazon Redshift began the snapshot. A snapshot
197             contains a copy of the cluster data as of this exact time.
198              
199              
200             =head2 SnapshotIdentifier => Str
201              
202             The snapshot identifier that is provided in the request.
203              
204              
205             =head2 SnapshotType => Str
206              
207             The snapshot type. Snapshots created using CreateClusterSnapshot and
208             CopyClusterSnapshot will be of type "manual".
209              
210              
211             =head2 SourceRegion => Str
212              
213             The source region from which the snapshot was copied.
214              
215              
216             =head2 Status => Str
217              
218             The snapshot status. The value of the status depends on the API
219             operation used.
220              
221             =over
222              
223             =item *
224              
225             CreateClusterSnapshot and CopyClusterSnapshot returns status as
226             "creating".
227              
228             =item *
229              
230             DescribeClusterSnapshots returns status as "creating", "available",
231             "final snapshot", or "failed".
232              
233             =item *
234              
235             DeleteClusterSnapshot returns status as "deleted".
236              
237             =back
238              
239              
240              
241             =head2 Tags => ArrayRef[L<Paws::RedShift::Tag>]
242              
243             The list of tags for the cluster snapshot.
244              
245              
246             =head2 TotalBackupSizeInMegaBytes => Num
247              
248             The size of the complete set of backup data that would be used to
249             restore the cluster.
250              
251              
252             =head2 VpcId => Str
253              
254             The VPC identifier of the cluster if the snapshot is from a cluster in
255             a VPC. Otherwise, this field is not in the output.
256              
257              
258              
259             =head1 SEE ALSO
260              
261             This class forms part of L<Paws>, describing an object used in L<Paws::RedShift>
262              
263             =head1 BUGS and CONTRIBUTIONS
264              
265             The source code is located here: https://github.com/pplu/aws-sdk-perl
266              
267             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
268              
269             =cut
270