File Coverage

blib/lib/Paws/RDS/DBSnapshot.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::RDS::DBSnapshot;
2 1     1   310 use Moose;
  1     1   2  
  1         6  
  1         519  
  1         2  
  1         7  
3             has AllocatedStorage => (is => 'ro', isa => 'Int');
4             has AvailabilityZone => (is => 'ro', isa => 'Str');
5             has DBInstanceIdentifier => (is => 'ro', isa => 'Str');
6             has DBSnapshotArn => (is => 'ro', isa => 'Str');
7             has DBSnapshotIdentifier => (is => 'ro', isa => 'Str');
8             has Encrypted => (is => 'ro', isa => 'Bool');
9             has Engine => (is => 'ro', isa => 'Str');
10             has EngineVersion => (is => 'ro', isa => 'Str');
11             has IAMDatabaseAuthenticationEnabled => (is => 'ro', isa => 'Bool');
12             has InstanceCreateTime => (is => 'ro', isa => 'Str');
13             has Iops => (is => 'ro', isa => 'Int');
14             has KmsKeyId => (is => 'ro', isa => 'Str');
15             has LicenseModel => (is => 'ro', isa => 'Str');
16             has MasterUsername => (is => 'ro', isa => 'Str');
17             has OptionGroupName => (is => 'ro', isa => 'Str');
18             has PercentProgress => (is => 'ro', isa => 'Int');
19             has Port => (is => 'ro', isa => 'Int');
20             has SnapshotCreateTime => (is => 'ro', isa => 'Str');
21             has SnapshotType => (is => 'ro', isa => 'Str');
22             has SourceDBSnapshotIdentifier => (is => 'ro', isa => 'Str');
23             has SourceRegion => (is => 'ro', isa => 'Str');
24             has Status => (is => 'ro', isa => 'Str');
25             has StorageType => (is => 'ro', isa => 'Str');
26             has TdeCredentialArn => (is => 'ro', isa => 'Str');
27             has Timezone => (is => 'ro', isa => 'Str');
28             has VpcId => (is => 'ro', isa => 'Str');
29             1;
30              
31             ### main pod documentation begin ###
32              
33             =head1 NAME
34              
35             Paws::RDS::DBSnapshot
36              
37             =head1 USAGE
38              
39             This class represents one of two things:
40              
41             =head3 Arguments in a call to a service
42              
43             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
44             Each attribute should be used as a named argument in the calls that expect this type of object.
45              
46             As an example, if Att1 is expected to be a Paws::RDS::DBSnapshot object:
47              
48             $service_obj->Method(Att1 => { AllocatedStorage => $value, ..., VpcId => $value });
49              
50             =head3 Results returned from an API call
51              
52             Use accessors for each attribute. If Att1 is expected to be an Paws::RDS::DBSnapshot object:
53              
54             $result = $service_obj->Method(...);
55             $result->Att1->AllocatedStorage
56              
57             =head1 DESCRIPTION
58              
59             Contains the result of a successful invocation of the following
60             actions:
61              
62             =over
63              
64             =item *
65              
66             CreateDBSnapshot
67              
68             =item *
69              
70             DeleteDBSnapshot
71              
72             =back
73              
74             This data type is used as a response element in the DescribeDBSnapshots
75             action.
76              
77             =head1 ATTRIBUTES
78              
79              
80             =head2 AllocatedStorage => Int
81              
82             Specifies the allocated storage size in gigabytes (GB).
83              
84              
85             =head2 AvailabilityZone => Str
86              
87             Specifies the name of the Availability Zone the DB instance was located
88             in at the time of the DB snapshot.
89              
90              
91             =head2 DBInstanceIdentifier => Str
92              
93             Specifies the DB instance identifier of the DB instance this DB
94             snapshot was created from.
95              
96              
97             =head2 DBSnapshotArn => Str
98              
99             The Amazon Resource Name (ARN) for the DB snapshot.
100              
101              
102             =head2 DBSnapshotIdentifier => Str
103              
104             Specifies the identifier for the DB snapshot.
105              
106              
107             =head2 Encrypted => Bool
108              
109             Specifies whether the DB snapshot is encrypted.
110              
111              
112             =head2 Engine => Str
113              
114             Specifies the name of the database engine.
115              
116              
117             =head2 EngineVersion => Str
118              
119             Specifies the version of the database engine.
120              
121              
122             =head2 IAMDatabaseAuthenticationEnabled => Bool
123              
124             True if mapping of AWS Identity and Access Management (IAM) accounts to
125             database accounts is enabled; otherwise false.
126              
127              
128             =head2 InstanceCreateTime => Str
129              
130             Specifies the time when the snapshot was taken, in Universal
131             Coordinated Time (UTC).
132              
133              
134             =head2 Iops => Int
135              
136             Specifies the Provisioned IOPS (I/O operations per second) value of the
137             DB instance at the time of the snapshot.
138              
139              
140             =head2 KmsKeyId => Str
141              
142             If C<Encrypted> is true, the KMS key identifier for the encrypted DB
143             snapshot.
144              
145              
146             =head2 LicenseModel => Str
147              
148             License model information for the restored DB instance.
149              
150              
151             =head2 MasterUsername => Str
152              
153             Provides the master username for the DB snapshot.
154              
155              
156             =head2 OptionGroupName => Str
157              
158             Provides the option group name for the DB snapshot.
159              
160              
161             =head2 PercentProgress => Int
162              
163             The percentage of the estimated data that has been transferred.
164              
165              
166             =head2 Port => Int
167              
168             Specifies the port that the database engine was listening on at the
169             time of the snapshot.
170              
171              
172             =head2 SnapshotCreateTime => Str
173              
174             Provides the time when the snapshot was taken, in Universal Coordinated
175             Time (UTC).
176              
177              
178             =head2 SnapshotType => Str
179              
180             Provides the type of the DB snapshot.
181              
182              
183             =head2 SourceDBSnapshotIdentifier => Str
184              
185             The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was
186             copied from. It only has value in case of cross-customer or
187             cross-region copy.
188              
189              
190             =head2 SourceRegion => Str
191              
192             The AWS Region that the DB snapshot was created in or copied from.
193              
194              
195             =head2 Status => Str
196              
197             Specifies the status of this DB snapshot.
198              
199              
200             =head2 StorageType => Str
201              
202             Specifies the storage type associated with DB snapshot.
203              
204              
205             =head2 TdeCredentialArn => Str
206              
207             The ARN from the key store with which to associate the instance for TDE
208             encryption.
209              
210              
211             =head2 Timezone => Str
212              
213             The time zone of the DB snapshot. In most cases, the C<Timezone>
214             element is empty. C<Timezone> content appears only for snapshots taken
215             from Microsoft SQL Server DB instances that were created with a time
216             zone specified.
217              
218              
219             =head2 VpcId => Str
220              
221             Provides the VPC ID associated with the DB snapshot.
222              
223              
224              
225             =head1 SEE ALSO
226              
227             This class forms part of L<Paws>, describing an object used in L<Paws::RDS>
228              
229             =head1 BUGS and CONTRIBUTIONS
230              
231             The source code is located here: https://github.com/pplu/aws-sdk-perl
232              
233             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
234              
235             =cut
236