blib/lib/Paws/ECS/Task.pm untested

filter: Statementstmt 0.0% 0 / 73 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 74 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::ECS::Task;
3 use Moose;
4 has Attachments => (is => 'ro', isa => 'ArrayRef[Paws::ECS::Attachment]', request_name => 'attachments', traits => ['NameInRequest']);
5 has Attributes => (is => 'ro', isa => 'ArrayRef[Paws::ECS::Attribute]', request_name => 'attributes', traits => ['NameInRequest']);
6 has AvailabilityZone => (is => 'ro', isa => 'Str', request_name => 'availabilityZone', traits => ['NameInRequest']);
7 has CapacityProviderName => (is => 'ro', isa => 'Str', request_name => 'capacityProviderName', traits => ['NameInRequest']);
8 has ClusterArn => (is => 'ro', isa => 'Str', request_name => 'clusterArn', traits => ['NameInRequest']);
9 has Connectivity => (is => 'ro', isa => 'Str', request_name => 'connectivity', traits => ['NameInRequest']);
10 has ConnectivityAt => (is => 'ro', isa => 'Str', request_name => 'connectivityAt', traits => ['NameInRequest']);
11 has ContainerInstanceArn => (is => 'ro', isa => 'Str', request_name => 'containerInstanceArn', traits => ['NameInRequest']);
12 has Containers => (is => 'ro', isa => 'ArrayRef[Paws::ECS::Container]', request_name => 'containers', traits => ['NameInRequest']);
13 has Cpu => (is => 'ro', isa => 'Str', request_name => 'cpu', traits => ['NameInRequest']);
14 has CreatedAt => (is => 'ro', isa => 'Str', request_name => 'createdAt', traits => ['NameInRequest']);
15 has DesiredStatus => (is => 'ro', isa => 'Str', request_name => 'desiredStatus', traits => ['NameInRequest']);
16 has EnableExecuteCommand => (is => 'ro', isa => 'Bool', request_name => 'enableExecuteCommand', traits => ['NameInRequest']);
17 has EphemeralStorage => (is => 'ro', isa => 'Paws::ECS::EphemeralStorage', request_name => 'ephemeralStorage', traits => ['NameInRequest']);
18 has ExecutionStoppedAt => (is => 'ro', isa => 'Str', request_name => 'executionStoppedAt', traits => ['NameInRequest']);
19 has Group => (is => 'ro', isa => 'Str', request_name => 'group', traits => ['NameInRequest']);
20 has HealthStatus => (is => 'ro', isa => 'Str', request_name => 'healthStatus', traits => ['NameInRequest']);
21 has InferenceAccelerators => (is => 'ro', isa => 'ArrayRef[Paws::ECS::InferenceAccelerator]', request_name => 'inferenceAccelerators', traits => ['NameInRequest']);
22 has LastStatus => (is => 'ro', isa => 'Str', request_name => 'lastStatus', traits => ['NameInRequest']);
23 has LaunchType => (is => 'ro', isa => 'Str', request_name => 'launchType', traits => ['NameInRequest']);
24 has Memory => (is => 'ro', isa => 'Str', request_name => 'memory', traits => ['NameInRequest']);
25 has Overrides => (is => 'ro', isa => 'Paws::ECS::TaskOverride', request_name => 'overrides', traits => ['NameInRequest']);
26 has PlatformVersion => (is => 'ro', isa => 'Str', request_name => 'platformVersion', traits => ['NameInRequest']);
27 has PullStartedAt => (is => 'ro', isa => 'Str', request_name => 'pullStartedAt', traits => ['NameInRequest']);
28 has PullStoppedAt => (is => 'ro', isa => 'Str', request_name => 'pullStoppedAt', traits => ['NameInRequest']);
29 has StartedAt => (is => 'ro', isa => 'Str', request_name => 'startedAt', traits => ['NameInRequest']);
30 has StartedBy => (is => 'ro', isa => 'Str', request_name => 'startedBy', traits => ['NameInRequest']);
31 has StopCode => (is => 'ro', isa => 'Str', request_name => 'stopCode', traits => ['NameInRequest']);
32 has StoppedAt => (is => 'ro', isa => 'Str', request_name => 'stoppedAt', traits => ['NameInRequest']);
33 has StoppedReason => (is => 'ro', isa => 'Str', request_name => 'stoppedReason', traits => ['NameInRequest']);
34 has StoppingAt => (is => 'ro', isa => 'Str', request_name => 'stoppingAt', traits => ['NameInRequest']);
35 has Tags => (is => 'ro', isa => 'ArrayRef[Paws::ECS::Tag]', request_name => 'tags', traits => ['NameInRequest']);
36 has TaskArn => (is => 'ro', isa => 'Str', request_name => 'taskArn', traits => ['NameInRequest']);
37 has TaskDefinitionArn => (is => 'ro', isa => 'Str', request_name => 'taskDefinitionArn', traits => ['NameInRequest']);
38 has Version => (is => 'ro', isa => 'Int', request_name => 'version', traits => ['NameInRequest']);
39  
40 1;
41  
42 ### main pod documentation begin ###
43  
44 =head1 NAME
45  
46 Paws::ECS::Task
47  
48 =head1 USAGE
49  
50 This class represents one of two things:
51  
52 =head3 Arguments in a call to a service
53  
54 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
55 Each attribute should be used as a named argument in the calls that expect this type of object.
56  
57 As an example, if Att1 is expected to be a Paws::ECS::Task object:
58  
59 $service_obj->Method(Att1 => { Attachments => $value, ..., Version => $value });
60  
61 =head3 Results returned from an API call
62  
63 Use accessors for each attribute. If Att1 is expected to be an Paws::ECS::Task object:
64  
65 $result = $service_obj->Method(...);
66 $result->Att1->Attachments
67  
68 =head1 DESCRIPTION
69  
70 Details on a task in a cluster.
71  
72 =head1 ATTRIBUTES
73  
74  
75 =head2 Attachments => ArrayRef[L<Paws::ECS::Attachment>]
76  
77 The Elastic Network Adapter associated with the task if the task uses
78 the C<awsvpc> network mode.
79  
80  
81 =head2 Attributes => ArrayRef[L<Paws::ECS::Attribute>]
82  
83 The attributes of the task
84  
85  
86 =head2 AvailabilityZone => Str
87  
88 The availability zone of the task.
89  
90  
91 =head2 CapacityProviderName => Str
92  
93 The capacity provider associated with the task.
94  
95  
96 =head2 ClusterArn => Str
97  
98 The ARN of the cluster that hosts the task.
99  
100  
101 =head2 Connectivity => Str
102  
103 The connectivity status of a task.
104  
105  
106 =head2 ConnectivityAt => Str
107  
108 The Unix timestamp for when the task last went into C<CONNECTED>
109 status.
110  
111  
112 =head2 ContainerInstanceArn => Str
113  
114 The ARN of the container instances that host the task.
115  
116  
117 =head2 Containers => ArrayRef[L<Paws::ECS::Container>]
118  
119 The containers associated with the task.
120  
121  
122 =head2 Cpu => Str
123  
124 The number of CPU units used by the task as expressed in a task
125 definition. It can be expressed as an integer using CPU units, for
126 example C<1024>. It can also be expressed as a string using vCPUs, for
127 example C<1 vCPU> or C<1 vcpu>. String values are converted to an
128 integer indicating the CPU units when the task definition is
129 registered.
130  
131 If you are using the EC2 launch type, this field is optional. Supported
132 values are between C<128> CPU units (C<0.125> vCPUs) and C<10240> CPU
133 units (C<10> vCPUs).
134  
135 If you are using the Fargate launch type, this field is required and
136 you must use one of the following values, which determines your range
137 of supported values for the C<memory> parameter:
138  
139 =over
140  
141 =item *
142  
143 256 (.25 vCPU) - Available C<memory> values: 512 (0.5 GB), 1024 (1 GB),
144 2048 (2 GB)
145  
146 =item *
147  
148 512 (.5 vCPU) - Available C<memory> values: 1024 (1 GB), 2048 (2 GB),
149 3072 (3 GB), 4096 (4 GB)
150  
151 =item *
152  
153 1024 (1 vCPU) - Available C<memory> values: 2048 (2 GB), 3072 (3 GB),
154 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
155  
156 =item *
157  
158 2048 (2 vCPU) - Available C<memory> values: Between 4096 (4 GB) and
159 16384 (16 GB) in increments of 1024 (1 GB)
160  
161 =item *
162  
163 4096 (4 vCPU) - Available C<memory> values: Between 8192 (8 GB) and
164 30720 (30 GB) in increments of 1024 (1 GB)
165  
166 =back
167  
168  
169  
170 =head2 CreatedAt => Str
171  
172 The Unix timestamp for when the task was created (the task entered the
173 C<PENDING> state).
174  
175  
176 =head2 DesiredStatus => Str
177  
178 The desired status of the task. For more information, see Task
179 Lifecycle
180 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-lifecycle.html).
181  
182  
183 =head2 EnableExecuteCommand => Bool
184  
185 Whether or not execute command functionality is enabled for this task.
186 If C<true>, this enables execute command functionality on all
187 containers in the task.
188  
189  
190 =head2 EphemeralStorage => L<Paws::ECS::EphemeralStorage>
191  
192 The ephemeral storage settings for the task.
193  
194  
195 =head2 ExecutionStoppedAt => Str
196  
197 The Unix timestamp for when the task execution stopped.
198  
199  
200 =head2 Group => Str
201  
202 The name of the task group associated with the task.
203  
204  
205 =head2 HealthStatus => Str
206  
207 The health status for the task, which is determined by the health of
208 the essential containers in the task. If all essential containers in
209 the task are reporting as C<HEALTHY>, then the task status also reports
210 as C<HEALTHY>. If any essential containers in the task are reporting as
211 C<UNHEALTHY> or C<UNKNOWN>, then the task status also reports as
212 C<UNHEALTHY> or C<UNKNOWN>, accordingly.
213  
214 The Amazon ECS container agent does not monitor or report on Docker
215 health checks that are embedded in a container image (such as those
216 specified in a parent image or from the image's Dockerfile) and not
217 specified in the container definition. Health check parameters that are
218 specified in a container definition override any Docker health checks
219 that exist in the container image.
220  
221  
222 =head2 InferenceAccelerators => ArrayRef[L<Paws::ECS::InferenceAccelerator>]
223  
224 The Elastic Inference accelerator associated with the task.
225  
226  
227 =head2 LastStatus => Str
228  
229 The last known status of the task. For more information, see Task
230 Lifecycle
231 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-lifecycle.html).
232  
233  
234 =head2 LaunchType => Str
235  
236 The infrastructure on which your task is running. For more information,
237 see Amazon ECS launch types
238 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html)
239 in the I<Amazon Elastic Container Service Developer Guide>.
240  
241  
242 =head2 Memory => Str
243  
244 The amount of memory (in MiB) used by the task as expressed in a task
245 definition. It can be expressed as an integer using MiB, for example
246 C<1024>. It can also be expressed as a string using GB, for example
247 C<1GB> or C<1 GB>. String values are converted to an integer indicating
248 the MiB when the task definition is registered.
249  
250 If you are using the EC2 launch type, this field is optional.
251  
252 If you are using the Fargate launch type, this field is required and
253 you must use one of the following values, which determines your range
254 of supported values for the C<cpu> parameter:
255  
256 =over
257  
258 =item *
259  
260 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available C<cpu> values: 256
261 (.25 vCPU)
262  
263 =item *
264  
265 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available C<cpu>
266 values: 512 (.5 vCPU)
267  
268 =item *
269  
270 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168
271 (7 GB), 8192 (8 GB) - Available C<cpu> values: 1024 (1 vCPU)
272  
273 =item *
274  
275 Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) -
276 Available C<cpu> values: 2048 (2 vCPU)
277  
278 =item *
279  
280 Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) -
281 Available C<cpu> values: 4096 (4 vCPU)
282  
283 =back
284  
285  
286  
287 =head2 Overrides => L<Paws::ECS::TaskOverride>
288  
289 One or more container overrides.
290  
291  
292 =head2 PlatformVersion => Str
293  
294 The platform version on which your task is running. A platform version
295 is only specified for tasks using the Fargate launch type. If one is
296 not specified, the C<LATEST> platform version is used by default. For
297 more information, see AWS Fargate Platform Versions
298 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html)
299 in the I<Amazon Elastic Container Service Developer Guide>.
300  
301  
302 =head2 PullStartedAt => Str
303  
304 The Unix timestamp for when the container image pull began.
305  
306  
307 =head2 PullStoppedAt => Str
308  
309 The Unix timestamp for when the container image pull completed.
310  
311  
312 =head2 StartedAt => Str
313  
314 The Unix timestamp for when the task started (the task transitioned
315 from the C<PENDING> state to the C<RUNNING> state).
316  
317  
318 =head2 StartedBy => Str
319  
320 The tag specified when a task is started. If the task is started by an
321 Amazon ECS service, then the C<startedBy> parameter contains the
322 deployment ID of the service that starts it.
323  
324  
325 =head2 StopCode => Str
326  
327 The stop code indicating why a task was stopped. The C<stoppedReason>
328 may contain additional details.
329  
330  
331 =head2 StoppedAt => Str
332  
333 The Unix timestamp for when the task was stopped (the task transitioned
334 from the C<RUNNING> state to the C<STOPPED> state).
335  
336  
337 =head2 StoppedReason => Str
338  
339 The reason that the task was stopped.
340  
341  
342 =head2 StoppingAt => Str
343  
344 The Unix timestamp for when the task stops (transitions from the
345 C<RUNNING> state to C<STOPPED>).
346  
347  
348 =head2 Tags => ArrayRef[L<Paws::ECS::Tag>]
349  
350 The metadata that you apply to the task to help you categorize and
351 organize them. Each tag consists of a key and an optional value, both
352 of which you define.
353  
354 The following basic restrictions apply to tags:
355  
356 =over
357  
358 =item *
359  
360 Maximum number of tags per resource - 50
361  
362 =item *
363  
364 For each resource, each tag key must be unique, and each tag key can
365 have only one value.
366  
367 =item *
368  
369 Maximum key length - 128 Unicode characters in UTF-8
370  
371 =item *
372  
373 Maximum value length - 256 Unicode characters in UTF-8
374  
375 =item *
376  
377 If your tagging schema is used across multiple services and resources,
378 remember that other services may have restrictions on allowed
379 characters. Generally allowed characters are: letters, numbers, and
380 spaces representable in UTF-8, and the following characters: + - = . _
381 : / @.
382  
383 =item *
384  
385 Tag keys and values are case-sensitive.
386  
387 =item *
388  
389 Do not use C<aws:>, C<AWS:>, or any upper or lowercase combination of
390 such as a prefix for either keys or values as it is reserved for AWS
391 use. You cannot edit or delete tag keys or values with this prefix.
392 Tags with this prefix do not count against your tags per resource
393 limit.
394  
395 =back
396  
397  
398  
399 =head2 TaskArn => Str
400  
401 The Amazon Resource Name (ARN) of the task.
402  
403  
404 =head2 TaskDefinitionArn => Str
405  
406 The ARN of the task definition that creates the task.
407  
408  
409 =head2 Version => Int
410  
411 The version counter for the task. Every time a task experiences a
412 change that triggers a CloudWatch event, the version counter is
413 incremented. If you are replicating your Amazon ECS task state with
414 CloudWatch Events, you can compare the version of a task reported by
415 the Amazon ECS API actions with the version reported in CloudWatch
416 Events for the task (inside the C<detail> object) to verify that the
417 version in your event stream is current.
418  
419  
420  
421 =head1 SEE ALSO
422  
423 This class forms part of L<Paws>, describing an object used in L<Paws::ECS>
424  
425 =head1 BUGS and CONTRIBUTIONS
426  
427 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
428  
429 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
430  
431 =cut
432