blib/lib/Paws/DMS/ReplicationTask.pm untested

filter: Statementstmt 0.0% 0 / 22 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 23 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::DMS::ReplicationTask;
3 use Moose;
4 has CdcStartPosition => (is => 'ro', isa => 'Str');
5 has CdcStopPosition => (is => 'ro', isa => 'Str');
6 has LastFailureMessage => (is => 'ro', isa => 'Str');
7 has MigrationType => (is => 'ro', isa => 'Str');
8 has RecoveryCheckpoint => (is => 'ro', isa => 'Str');
9 has ReplicationInstanceArn => (is => 'ro', isa => 'Str');
10 has ReplicationTaskArn => (is => 'ro', isa => 'Str');
11 has ReplicationTaskCreationDate => (is => 'ro', isa => 'Str');
12 has ReplicationTaskIdentifier => (is => 'ro', isa => 'Str');
13 has ReplicationTaskSettings => (is => 'ro', isa => 'Str');
14 has ReplicationTaskStartDate => (is => 'ro', isa => 'Str');
15 has ReplicationTaskStats => (is => 'ro', isa => 'Paws::DMS::ReplicationTaskStats');
16 has SourceEndpointArn => (is => 'ro', isa => 'Str');
17 has Status => (is => 'ro', isa => 'Str');
18 has StopReason => (is => 'ro', isa => 'Str');
19 has TableMappings => (is => 'ro', isa => 'Str');
20 has TargetEndpointArn => (is => 'ro', isa => 'Str');
21 has TargetReplicationInstanceArn => (is => 'ro', isa => 'Str');
22 has TaskData => (is => 'ro', isa => 'Str');
23  
24 1;
25  
26 ### main pod documentation begin ###
27  
28 =head1 NAME
29  
30 Paws::DMS::ReplicationTask
31  
32 =head1 USAGE
33  
34 This class represents one of two things:
35  
36 =head3 Arguments in a call to a service
37  
38 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
39 Each attribute should be used as a named argument in the calls that expect this type of object.
40  
41 As an example, if Att1 is expected to be a Paws::DMS::ReplicationTask object:
42  
43 $service_obj->Method(Att1 => { CdcStartPosition => $value, ..., TaskData => $value });
44  
45 =head3 Results returned from an API call
46  
47 Use accessors for each attribute. If Att1 is expected to be an Paws::DMS::ReplicationTask object:
48  
49 $result = $service_obj->Method(...);
50 $result->Att1->CdcStartPosition
51  
52 =head1 DESCRIPTION
53  
54 Provides information that describes a replication task created by the
55 C<CreateReplicationTask> operation.
56  
57 =head1 ATTRIBUTES
58  
59  
60 =head2 CdcStartPosition => Str
61  
62 Indicates when you want a change data capture (CDC) operation to start.
63 Use either C<CdcStartPosition> or C<CdcStartTime> to specify when you
64 want the CDC operation to start. Specifying both values results in an
65 error.
66  
67 The value can be in date, checkpoint, or LSN/SCN format.
68  
69 Date Example: --cdc-start-position E<ldquo>2018-03-08T12:12:12E<rdquo>
70  
71 Checkpoint Example: --cdc-start-position
72 "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"
73  
74 LSN Example: --cdc-start-position
75 E<ldquo>mysql-bin-changelog.000024:373E<rdquo>
76  
77  
78 =head2 CdcStopPosition => Str
79  
80 Indicates when you want a change data capture (CDC) operation to stop.
81 The value can be either server time or commit time.
82  
83 Server time example: --cdc-stop-position
84 E<ldquo>server_time:2018-02-09T12:12:12E<rdquo>
85  
86 Commit time example: --cdc-stop-position E<ldquo>commit_time:
87 2018-02-09T12:12:12 E<ldquo>
88  
89  
90 =head2 LastFailureMessage => Str
91  
92 The last error (failure) message generated for the replication task.
93  
94  
95 =head2 MigrationType => Str
96  
97 The type of migration.
98  
99  
100 =head2 RecoveryCheckpoint => Str
101  
102 Indicates the last checkpoint that occurred during a change data
103 capture (CDC) operation. You can provide this value to the
104 C<CdcStartPosition> parameter to start a CDC operation that begins at
105 that checkpoint.
106  
107  
108 =head2 ReplicationInstanceArn => Str
109  
110 The ARN of the replication instance.
111  
112  
113 =head2 ReplicationTaskArn => Str
114  
115 The Amazon Resource Name (ARN) of the replication task.
116  
117  
118 =head2 ReplicationTaskCreationDate => Str
119  
120 The date the replication task was created.
121  
122  
123 =head2 ReplicationTaskIdentifier => Str
124  
125 The user-assigned replication task identifier or name.
126  
127 Constraints:
128  
129 =over
130  
131 =item *
132  
133 Must contain 1-255 alphanumeric characters or hyphens.
134  
135 =item *
136  
137 First character must be a letter.
138  
139 =item *
140  
141 Cannot end with a hyphen or contain two consecutive hyphens.
142  
143 =back
144  
145  
146  
147 =head2 ReplicationTaskSettings => Str
148  
149 The settings for the replication task.
150  
151  
152 =head2 ReplicationTaskStartDate => Str
153  
154 The date the replication task is scheduled to start.
155  
156  
157 =head2 ReplicationTaskStats => L<Paws::DMS::ReplicationTaskStats>
158  
159 The statistics for the task, including elapsed time, tables loaded, and
160 table errors.
161  
162  
163 =head2 SourceEndpointArn => Str
164  
165 The Amazon Resource Name (ARN) that uniquely identifies the endpoint.
166  
167  
168 =head2 Status => Str
169  
170 The status of the replication task. This response parameter can return
171 one of the following values:
172  
173 =over
174  
175 =item *
176  
177 C<"moving"> E<ndash> The task is being moved in response to running the
178 C<MoveReplicationTask>
179 (https://docs.aws.amazon.com/dms/latest/APIReference/API_MoveReplicationTask.html)
180 operation.
181  
182 =item *
183  
184 C<"creating"> E<ndash> The task is being created in response to running
185 the C<CreateReplicationTask>
186 (https://docs.aws.amazon.com/dms/latest/APIReference/API_CreateReplicationTask.html)
187 operation.
188  
189 =item *
190  
191 C<"deleting"> E<ndash> The task is being deleted in response to running
192 the C<DeleteReplicationTask>
193 (https://docs.aws.amazon.com/dms/latest/APIReference/API_DeleteReplicationTask.html)
194 operation.
195  
196 =item *
197  
198 C<"failed"> E<ndash> The task failed to successfully complete the
199 database migration in response to running the C<StartReplicationTask>
200 (https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html)
201 operation.
202  
203 =item *
204  
205 C<"failed-move"> E<ndash> The task failed to move in response to
206 running the C<MoveReplicationTask>
207 (https://docs.aws.amazon.com/dms/latest/APIReference/API_MoveReplicationTask.html)
208 operation.
209  
210 =item *
211  
212 C<"modifying"> E<ndash> The task definition is being modified in
213 response to running the C<ModifyReplicationTask>
214 (https://docs.aws.amazon.com/dms/latest/APIReference/API_ModifyReplicationTask.html)
215 operation.
216  
217 =item *
218  
219 C<"ready"> E<ndash> The task is in a C<ready> state where it can
220 respond to other task operations, such as C<StartReplicationTask>
221 (https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html)
222 or C<DeleteReplicationTask>
223 (https://docs.aws.amazon.com/dms/latest/APIReference/API_DeleteReplicationTask.html).
224  
225 =item *
226  
227 C<"running"> E<ndash> The task is performing a database migration in
228 response to running the C<StartReplicationTask>
229 (https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html)
230 operation.
231  
232 =item *
233  
234 C<"starting"> E<ndash> The task is preparing to perform a database
235 migration in response to running the C<StartReplicationTask>
236 (https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html)
237 operation.
238  
239 =item *
240  
241 C<"stopped"> E<ndash> The task has stopped in response to running the
242 C<StopReplicationTask>
243 (https://docs.aws.amazon.com/dms/latest/APIReference/API_StopReplicationTask.html)
244 operation.
245  
246 =item *
247  
248 C<"stopping"> E<ndash> The task is preparing to stop in response to
249 running the C<StopReplicationTask>
250 (https://docs.aws.amazon.com/dms/latest/APIReference/API_StopReplicationTask.html)
251 operation.
252  
253 =item *
254  
255 C<"testing"> E<ndash> The database migration specified for this task is
256 being tested in response to running either the
257 C<StartReplicationTaskAssessmentRun>
258 (https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessmentRun.html)
259 or the C<StartReplicationTaskAssessment>
260 (https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessment.html)
261 operation.
262  
263 C<StartReplicationTaskAssessmentRun>
264 (https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessmentRun.html)
265 is an improved premigration task assessment operation. The
266 C<StartReplicationTaskAssessment>
267 (https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessment.html)
268 operation assesses data type compatibility only between the source and
269 target database of a given migration task. In contrast,
270 C<StartReplicationTaskAssessmentRun>
271 (https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessmentRun.html)
272 enables you to specify a variety of premigration task assessments in
273 addition to data type compatibility. These assessments include ones for
274 the validity of primary key definitions and likely issues with database
275 migration performance, among others.
276  
277 =back
278  
279  
280  
281 =head2 StopReason => Str
282  
283 The reason the replication task was stopped. This response parameter
284 can return one of the following values:
285  
286 =over
287  
288 =item *
289  
290 C<"STOP_REASON_FULL_LOAD_COMPLETED"> E<ndash> Full-load migration
291 completed.
292  
293 =item *
294  
295 C<"STOP_REASON_CACHED_CHANGES_APPLIED"> E<ndash> Change data capture
296 (CDC) load completed.
297  
298 =item *
299  
300 C<"STOP_REASON_CACHED_CHANGES_NOT_APPLIED"> E<ndash> In a full-load and
301 CDC migration, the full load stopped as specified before starting the
302 CDC migration.
303  
304 =item *
305  
306 C<"STOP_REASON_SERVER_TIME"> E<ndash> The migration stopped at the
307 specified server time.
308  
309 =back
310  
311  
312  
313 =head2 TableMappings => Str
314  
315 Table mappings specified in the task.
316  
317  
318 =head2 TargetEndpointArn => Str
319  
320 The ARN that uniquely identifies the endpoint.
321  
322  
323 =head2 TargetReplicationInstanceArn => Str
324  
325 The ARN of the replication instance to which this task is moved in
326 response to running the C<MoveReplicationTask>
327 (https://docs.aws.amazon.com/dms/latest/APIReference/API_MoveReplicationTask.html)
328 operation. Otherwise, this response parameter isn't a member of the
329 C<ReplicationTask> object.
330  
331  
332 =head2 TaskData => Str
333  
334 Supplemental information that the task requires to migrate the data for
335 certain source and target endpoints. For more information, see
336 Specifying Supplemental Data for Task Settings
337 (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.TaskData.html)
338 in the I<AWS Database Migration Service User Guide.>
339  
340  
341  
342 =head1 SEE ALSO
343  
344 This class forms part of L<Paws>, describing an object used in L<Paws::DMS>
345  
346 =head1 BUGS and CONTRIBUTIONS
347  
348 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
349  
350 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
351  
352 =cut
353