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

filter: Statementstmt 0.0% 0 / 81 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 82 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::ContainerDefinition;
3 use Moose;
4 has Command => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'command', traits => ['NameInRequest']);
5 has Cpu => (is => 'ro', isa => 'Int', request_name => 'cpu', traits => ['NameInRequest']);
6 has DependsOn => (is => 'ro', isa => 'ArrayRef[Paws::ECS::ContainerDependency]', request_name => 'dependsOn', traits => ['NameInRequest']);
7 has DisableNetworking => (is => 'ro', isa => 'Bool', request_name => 'disableNetworking', traits => ['NameInRequest']);
8 has DnsSearchDomains => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'dnsSearchDomains', traits => ['NameInRequest']);
9 has DnsServers => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'dnsServers', traits => ['NameInRequest']);
10 has DockerLabels => (is => 'ro', isa => 'Paws::ECS::DockerLabelsMap', request_name => 'dockerLabels', traits => ['NameInRequest']);
11 has DockerSecurityOptions => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'dockerSecurityOptions', traits => ['NameInRequest']);
12 has EntryPoint => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'entryPoint', traits => ['NameInRequest']);
13 has Environment => (is => 'ro', isa => 'ArrayRef[Paws::ECS::KeyValuePair]', request_name => 'environment', traits => ['NameInRequest']);
14 has EnvironmentFiles => (is => 'ro', isa => 'ArrayRef[Paws::ECS::EnvironmentFile]', request_name => 'environmentFiles', traits => ['NameInRequest']);
15 has Essential => (is => 'ro', isa => 'Bool', request_name => 'essential', traits => ['NameInRequest']);
16 has ExtraHosts => (is => 'ro', isa => 'ArrayRef[Paws::ECS::HostEntry]', request_name => 'extraHosts', traits => ['NameInRequest']);
17 has FirelensConfiguration => (is => 'ro', isa => 'Paws::ECS::FirelensConfiguration', request_name => 'firelensConfiguration', traits => ['NameInRequest']);
18 has HealthCheck => (is => 'ro', isa => 'Paws::ECS::HealthCheck', request_name => 'healthCheck', traits => ['NameInRequest']);
19 has Hostname => (is => 'ro', isa => 'Str', request_name => 'hostname', traits => ['NameInRequest']);
20 has Image => (is => 'ro', isa => 'Str', request_name => 'image', traits => ['NameInRequest']);
21 has Interactive => (is => 'ro', isa => 'Bool', request_name => 'interactive', traits => ['NameInRequest']);
22 has Links => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'links', traits => ['NameInRequest']);
23 has LinuxParameters => (is => 'ro', isa => 'Paws::ECS::LinuxParameters', request_name => 'linuxParameters', traits => ['NameInRequest']);
24 has LogConfiguration => (is => 'ro', isa => 'Paws::ECS::LogConfiguration', request_name => 'logConfiguration', traits => ['NameInRequest']);
25 has Memory => (is => 'ro', isa => 'Int', request_name => 'memory', traits => ['NameInRequest']);
26 has MemoryReservation => (is => 'ro', isa => 'Int', request_name => 'memoryReservation', traits => ['NameInRequest']);
27 has MountPoints => (is => 'ro', isa => 'ArrayRef[Paws::ECS::MountPoint]', request_name => 'mountPoints', traits => ['NameInRequest']);
28 has Name => (is => 'ro', isa => 'Str', request_name => 'name', traits => ['NameInRequest']);
29 has PortMappings => (is => 'ro', isa => 'ArrayRef[Paws::ECS::PortMapping]', request_name => 'portMappings', traits => ['NameInRequest']);
30 has Privileged => (is => 'ro', isa => 'Bool', request_name => 'privileged', traits => ['NameInRequest']);
31 has PseudoTerminal => (is => 'ro', isa => 'Bool', request_name => 'pseudoTerminal', traits => ['NameInRequest']);
32 has ReadonlyRootFilesystem => (is => 'ro', isa => 'Bool', request_name => 'readonlyRootFilesystem', traits => ['NameInRequest']);
33 has RepositoryCredentials => (is => 'ro', isa => 'Paws::ECS::RepositoryCredentials', request_name => 'repositoryCredentials', traits => ['NameInRequest']);
34 has ResourceRequirements => (is => 'ro', isa => 'ArrayRef[Paws::ECS::ResourceRequirement]', request_name => 'resourceRequirements', traits => ['NameInRequest']);
35 has Secrets => (is => 'ro', isa => 'ArrayRef[Paws::ECS::Secret]', request_name => 'secrets', traits => ['NameInRequest']);
36 has StartTimeout => (is => 'ro', isa => 'Int', request_name => 'startTimeout', traits => ['NameInRequest']);
37 has StopTimeout => (is => 'ro', isa => 'Int', request_name => 'stopTimeout', traits => ['NameInRequest']);
38 has SystemControls => (is => 'ro', isa => 'ArrayRef[Paws::ECS::SystemControl]', request_name => 'systemControls', traits => ['NameInRequest']);
39 has Ulimits => (is => 'ro', isa => 'ArrayRef[Paws::ECS::Ulimit]', request_name => 'ulimits', traits => ['NameInRequest']);
40 has User => (is => 'ro', isa => 'Str', request_name => 'user', traits => ['NameInRequest']);
41 has VolumesFrom => (is => 'ro', isa => 'ArrayRef[Paws::ECS::VolumeFrom]', request_name => 'volumesFrom', traits => ['NameInRequest']);
42 has WorkingDirectory => (is => 'ro', isa => 'Str', request_name => 'workingDirectory', traits => ['NameInRequest']);
43  
44 1;
45  
46 ### main pod documentation begin ###
47  
48 =head1 NAME
49  
50 Paws::ECS::ContainerDefinition
51  
52 =head1 USAGE
53  
54 This class represents one of two things:
55  
56 =head3 Arguments in a call to a service
57  
58 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
59 Each attribute should be used as a named argument in the calls that expect this type of object.
60  
61 As an example, if Att1 is expected to be a Paws::ECS::ContainerDefinition object:
62  
63 $service_obj->Method(Att1 => { Command => $value, ..., WorkingDirectory => $value });
64  
65 =head3 Results returned from an API call
66  
67 Use accessors for each attribute. If Att1 is expected to be an Paws::ECS::ContainerDefinition object:
68  
69 $result = $service_obj->Method(...);
70 $result->Att1->Command
71  
72 =head1 DESCRIPTION
73  
74 Container definitions are used in task definitions to describe the
75 different containers that are launched as part of a task.
76  
77 =head1 ATTRIBUTES
78  
79  
80 =head2 Command => ArrayRef[Str|Undef]
81  
82 The command that is passed to the container. This parameter maps to
83 C<Cmd> in the Create a container
84 (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
85 section of the Docker Remote API
86 (https://docs.docker.com/engine/api/v1.35/) and the C<COMMAND>
87 parameter to docker run
88 (https://docs.docker.com/engine/reference/run/#security-configuration).
89 For more information, see
90 https://docs.docker.com/engine/reference/builder/#cmd
91 (https://docs.docker.com/engine/reference/builder/#cmd). If there are
92 multiple arguments, each argument should be a separated string in the
93 array.
94  
95  
96 =head2 Cpu => Int
97  
98 The number of C<cpu> units reserved for the container. This parameter
99 maps to C<CpuShares> in the Create a container
100 (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
101 section of the Docker Remote API
102 (https://docs.docker.com/engine/api/v1.35/) and the C<--cpu-shares>
103 option to docker run
104 (https://docs.docker.com/engine/reference/run/#security-configuration).
105  
106 This field is optional for tasks using the Fargate launch type, and the
107 only requirement is that the total amount of CPU reserved for all
108 containers within a task be lower than the task-level C<cpu> value.
109  
110 You can determine the number of CPU units that are available per EC2
111 instance type by multiplying the vCPUs listed for that instance type on
112 the Amazon EC2 Instances (http://aws.amazon.com/ec2/instance-types/)
113 detail page by 1,024.
114  
115 Linux containers share unallocated CPU units with other containers on
116 the container instance with the same ratio as their allocated amount.
117 For example, if you run a single-container task on a single-core
118 instance type with 512 CPU units specified for that container, and that
119 is the only task running on the container instance, that container
120 could use the full 1,024 CPU unit share at any given time. However, if
121 you launched another copy of the same task on that container instance,
122 each task would be guaranteed a minimum of 512 CPU units when needed,
123 and each container could float to higher CPU usage if the other
124 container was not using it, but if both tasks were 100% active all of
125 the time, they would be limited to 512 CPU units.
126  
127 On Linux container instances, the Docker daemon on the container
128 instance uses the CPU value to calculate the relative CPU share ratios
129 for running containers. For more information, see CPU share constraint
130 (https://docs.docker.com/engine/reference/run/#cpu-share-constraint) in
131 the Docker documentation. The minimum valid CPU share value that the
132 Linux kernel allows is 2. However, the CPU parameter is not required,
133 and you can use CPU values below 2 in your container definitions. For
134 CPU values below 2 (including null), the behavior varies based on your
135 Amazon ECS container agent version:
136  
137 =over
138  
139 =item *
140  
141 B<Agent versions less than or equal to 1.1.0:> Null and zero CPU values
142 are passed to Docker as 0, which Docker then converts to 1,024 CPU
143 shares. CPU values of 1 are passed to Docker as 1, which the Linux
144 kernel converts to two CPU shares.
145  
146 =item *
147  
148 B<Agent versions greater than or equal to 1.2.0:> Null, zero, and CPU
149 values of 1 are passed to Docker as 2.
150  
151 =back
152  
153 On Windows container instances, the CPU limit is enforced as an
154 absolute limit, or a quota. Windows containers only have access to the
155 specified amount of CPU that is described in the task definition. A
156 null or zero CPU value is passed to Docker as C<0>, which Windows
157 interprets as 1% of one CPU.
158  
159  
160 =head2 DependsOn => ArrayRef[L<Paws::ECS::ContainerDependency>]
161  
162 The dependencies defined for container startup and shutdown. A
163 container can contain multiple dependencies. When a dependency is
164 defined for container startup, for container shutdown it is reversed.
165  
166 For tasks using the EC2 launch type, the container instances require at
167 least version 1.26.0 of the container agent to enable container
168 dependencies. However, we recommend using the latest container agent
169 version. For information about checking your agent version and updating
170 to the latest version, see Updating the Amazon ECS Container Agent
171 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html)
172 in the I<Amazon Elastic Container Service Developer Guide>. If you are
173 using an Amazon ECS-optimized Linux AMI, your instance needs at least
174 version 1.26.0-1 of the C<ecs-init> package. If your container
175 instances are launched from version C<20190301> or later, then they
176 contain the required versions of the container agent and C<ecs-init>.
177 For more information, see Amazon ECS-optimized Linux AMI
178 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html)
179 in the I<Amazon Elastic Container Service Developer Guide>.
180  
181 For tasks using the Fargate launch type, the task or service requires
182 platform version C<1.3.0> or later.
183  
184  
185 =head2 DisableNetworking => Bool
186  
187 When this parameter is true, networking is disabled within the
188 container. This parameter maps to C<NetworkDisabled> in the Create a
189 container
190 (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
191 section of the Docker Remote API
192 (https://docs.docker.com/engine/api/v1.35/).
193  
194 This parameter is not supported for Windows containers.
195  
196  
197 =head2 DnsSearchDomains => ArrayRef[Str|Undef]
198  
199 A list of DNS search domains that are presented to the container. This
200 parameter maps to C<DnsSearch> in the Create a container
201 (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
202 section of the Docker Remote API
203 (https://docs.docker.com/engine/api/v1.35/) and the C<--dns-search>
204 option to docker run
205 (https://docs.docker.com/engine/reference/run/#security-configuration).
206  
207 This parameter is not supported for Windows containers.
208  
209  
210 =head2 DnsServers => ArrayRef[Str|Undef]
211  
212 A list of DNS servers that are presented to the container. This
213 parameter maps to C<Dns> in the Create a container
214 (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
215 section of the Docker Remote API
216 (https://docs.docker.com/engine/api/v1.35/) and the C<--dns> option to
217 docker run
218 (https://docs.docker.com/engine/reference/run/#security-configuration).
219  
220 This parameter is not supported for Windows containers.
221  
222  
223 =head2 DockerLabels => L<Paws::ECS::DockerLabelsMap>
224  
225 A key/value map of labels to add to the container. This parameter maps
226 to C<Labels> in the Create a container
227 (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
228 section of the Docker Remote API
229 (https://docs.docker.com/engine/api/v1.35/) and the C<--label> option
230 to docker run
231 (https://docs.docker.com/engine/reference/run/#security-configuration).
232 This parameter requires version 1.18 of the Docker Remote API or
233 greater on your container instance. To check the Docker Remote API
234 version on your container instance, log in to your container instance
235 and run the following command: C<sudo docker version --format
236 '{{.Server.APIVersion}}'>
237  
238  
239 =head2 DockerSecurityOptions => ArrayRef[Str|Undef]
240  
241 A list of strings to provide custom labels for SELinux and AppArmor
242 multi-level security systems. This field is not valid for containers in
243 tasks using the Fargate launch type.
244  
245 With Windows containers, this parameter can be used to reference a
246 credential spec file when configuring a container for Active Directory
247 authentication. For more information, see Using gMSAs for Windows
248 Containers
249 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows-gmsa.html)
250 in the I<Amazon Elastic Container Service Developer Guide>.
251  
252 This parameter maps to C<SecurityOpt> in the Create a container
253 (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
254 section of the Docker Remote API
255 (https://docs.docker.com/engine/api/v1.35/) and the C<--security-opt>
256 option to docker run
257 (https://docs.docker.com/engine/reference/run/#security-configuration).
258  
259 The Amazon ECS container agent running on a container instance must
260 register with the C<ECS_SELINUX_CAPABLE=true> or
261 C<ECS_APPARMOR_CAPABLE=true> environment variables before containers
262 placed on that instance can use these security options. For more
263 information, see Amazon ECS Container Agent Configuration
264 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html)
265 in the I<Amazon Elastic Container Service Developer Guide>.
266  
267 For more information about valid values, see Docker Run Security
268 Configuration
269 (https://docs.docker.com/engine/reference/run/#security-configuration).
270  
271 Valid values: "no-new-privileges" | "apparmor:PROFILE" | "label:value"
272 | "credentialspec:CredentialSpecFilePath"
273  
274  
275 =head2 EntryPoint => ArrayRef[Str|Undef]
276  
277 Early versions of the Amazon ECS container agent do not properly handle
278 C<entryPoint> parameters. If you have problems using C<entryPoint>,
279 update your container agent or enter your commands and arguments as
280 C<command> array items instead.
281  
282 The entry point that is passed to the container. This parameter maps to
283 C<Entrypoint> in the Create a container
284 (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
285 section of the Docker Remote API
286 (https://docs.docker.com/engine/api/v1.35/) and the C<--entrypoint>
287 option to docker run
288 (https://docs.docker.com/engine/reference/run/#security-configuration).
289 For more information, see
290 https://docs.docker.com/engine/reference/builder/#entrypoint
291 (https://docs.docker.com/engine/reference/builder/#entrypoint).
292  
293  
294 =head2 Environment => ArrayRef[L<Paws::ECS::KeyValuePair>]
295  
296 The environment variables to pass to a container. This parameter maps
297 to C<Env> in the Create a container
298 (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
299 section of the Docker Remote API
300 (https://docs.docker.com/engine/api/v1.35/) and the C<--env> option to
301 docker run
302 (https://docs.docker.com/engine/reference/run/#security-configuration).
303  
304 We do not recommend using plaintext environment variables for sensitive
305 information, such as credential data.
306  
307  
308 =head2 EnvironmentFiles => ArrayRef[L<Paws::ECS::EnvironmentFile>]
309  
310 A list of files containing the environment variables to pass to a
311 container. This parameter maps to the C<--env-file> option to docker
312 run
313 (https://docs.docker.com/engine/reference/run/#security-configuration).
314  
315 You can specify up to ten environment files. The file must have a
316 C<.env> file extension. Each line in an environment file should contain
317 an environment variable in C<VARIABLE=VALUE> format. Lines beginning
318 with C<#> are treated as comments and are ignored. For more information
319 on the environment variable file syntax, see Declare default
320 environment variables in file
321 (https://docs.docker.com/compose/env-file/).
322  
323 If there are environment variables specified using the C<environment>
324 parameter in a container definition, they take precedence over the
325 variables contained within an environment file. If multiple environment
326 files are specified that contain the same variable, they are processed
327 from the top down. It is recommended to use unique variable names. For
328 more information, see Specifying Environment Variables
329 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html)
330 in the I<Amazon Elastic Container Service Developer Guide>.
331  
332  
333 =head2 Essential => Bool
334  
335 If the C<essential> parameter of a container is marked as C<true>, and
336 that container fails or stops for any reason, all other containers that
337 are part of the task are stopped. If the C<essential> parameter of a
338 container is marked as C<false>, then its failure does not affect the
339 rest of the containers in a task. If this parameter is omitted, a
340 container is assumed to be essential.
341  
342 All tasks must have at least one essential container. If you have an
343 application that is composed of multiple containers, you should group
344 containers that are used for a common purpose into components, and
345 separate the different components into multiple task definitions. For
346 more information, see Application Architecture
347 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/application_architecture.html)
348 in the I<Amazon Elastic Container Service Developer Guide>.
349  
350  
351 =head2 ExtraHosts => ArrayRef[L<Paws::ECS::HostEntry>]
352  
353 A list of hostnames and IP address mappings to append to the
354 C</etc/hosts> file on the container. This parameter maps to
355 C<ExtraHosts> in the Create a container
356 (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
357 section of the Docker Remote API
358 (https://docs.docker.com/engine/api/v1.35/) and the C<--add-host>
359 option to docker run
360 (https://docs.docker.com/engine/reference/run/#security-configuration).
361  
362 This parameter is not supported for Windows containers or tasks that
363 use the C<awsvpc> network mode.
364  
365  
366 =head2 FirelensConfiguration => L<Paws::ECS::FirelensConfiguration>
367  
368 The FireLens configuration for the container. This is used to specify
369 and configure a log router for container logs. For more information,
370 see Custom Log Routing
371 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html)
372 in the I<Amazon Elastic Container Service Developer Guide>.
373  
374  
375 =head2 HealthCheck => L<Paws::ECS::HealthCheck>
376  
377 The container health check command and associated configuration
378 parameters for the container. This parameter maps to C<HealthCheck> in
379 the Create a container
380 (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
381 section of the Docker Remote API
382 (https://docs.docker.com/engine/api/v1.35/) and the C<HEALTHCHECK>
383 parameter of docker run
384 (https://docs.docker.com/engine/reference/run/#security-configuration).
385  
386  
387 =head2 Hostname => Str
388  
389 The hostname to use for your container. This parameter maps to
390 C<Hostname> in the Create a container
391 (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
392 section of the Docker Remote API
393 (https://docs.docker.com/engine/api/v1.35/) and the C<--hostname>
394 option to docker run
395 (https://docs.docker.com/engine/reference/run/#security-configuration).
396  
397 The C<hostname> parameter is not supported if you are using the
398 C<awsvpc> network mode.
399  
400  
401 =head2 Image => Str
402  
403 The image used to start a container. This string is passed directly to
404 the Docker daemon. Images in the Docker Hub registry are available by
405 default. Other repositories are specified with either C<
406 I<repository-url>/I<image>:I<tag> > or C<
407 I<repository-url>/I<image>@I<digest> >. Up to 255 letters (uppercase
408 and lowercase), numbers, hyphens, underscores, colons, periods, forward
409 slashes, and number signs are allowed. This parameter maps to C<Image>
410 in the Create a container
411 (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
412 section of the Docker Remote API
413 (https://docs.docker.com/engine/api/v1.35/) and the C<IMAGE> parameter
414 of docker run
415 (https://docs.docker.com/engine/reference/run/#security-configuration).
416  
417 =over
418  
419 =item *
420  
421 When a new task starts, the Amazon ECS container agent pulls the latest
422 version of the specified image and tag for the container to use.
423 However, subsequent updates to a repository image are not propagated to
424 already running tasks.
425  
426 =item *
427  
428 Images in Amazon ECR repositories can be specified by either using the
429 full C<registry/repository:tag> or C<registry/repository@digest>. For
430 example,
431 C<012345678910.dkr.ecr.E<lt>region-nameE<gt>.amazonaws.com/E<lt>repository-nameE<gt>:latest>
432 or
433 C<012345678910.dkr.ecr.E<lt>region-nameE<gt>.amazonaws.com/E<lt>repository-nameE<gt>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE>.
434  
435 =item *
436  
437 Images in official repositories on Docker Hub use a single name (for
438 example, C<ubuntu> or C<mongo>).
439  
440 =item *
441  
442 Images in other repositories on Docker Hub are qualified with an
443 organization name (for example, C<amazon/amazon-ecs-agent>).
444  
445 =item *
446  
447 Images in other online repositories are qualified further by a domain
448 name (for example, C<quay.io/assemblyline/ubuntu>).
449  
450 =back
451  
452  
453  
454 =head2 Interactive => Bool
455  
456 When this parameter is C<true>, this allows you to deploy containerized
457 applications that require C<stdin> or a C<tty> to be allocated. This
458 parameter maps to C<OpenStdin> in the Create a container
459 (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
460 section of the Docker Remote API
461 (https://docs.docker.com/engine/api/v1.35/) and the C<--interactive>
462 option to docker run
463 (https://docs.docker.com/engine/reference/run/#security-configuration).
464  
465  
466 =head2 Links => ArrayRef[Str|Undef]
467  
468 The C<links> parameter allows containers to communicate with each other
469 without the need for port mappings. This parameter is only supported if
470 the network mode of a task definition is C<bridge>. The
471 C<name:internalName> construct is analogous to C<name:alias> in Docker
472 links. Up to 255 letters (uppercase and lowercase), numbers,
473 underscores, and hyphens are allowed. For more information about
474 linking Docker containers, go to Legacy container links
475 (https://docs.docker.com/network/links/) in the Docker documentation.
476 This parameter maps to C<Links> in the Create a container
477 (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
478 section of the Docker Remote API
479 (https://docs.docker.com/engine/api/v1.35/) and the C<--link> option to
480 docker run
481 (https://docs.docker.com/engine/reference/run/#security-configuration).
482  
483 This parameter is not supported for Windows containers.
484  
485 Containers that are collocated on a single container instance may be
486 able to communicate with each other without requiring links or host
487 port mappings. Network isolation is achieved on the container instance
488 using security groups and VPC settings.
489  
490  
491 =head2 LinuxParameters => L<Paws::ECS::LinuxParameters>
492  
493 Linux-specific modifications that are applied to the container, such as
494 Linux kernel capabilities. For more information see KernelCapabilities.
495  
496 This parameter is not supported for Windows containers.
497  
498  
499 =head2 LogConfiguration => L<Paws::ECS::LogConfiguration>
500  
501 The log configuration specification for the container.
502  
503 This parameter maps to C<LogConfig> in the Create a container
504 (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
505 section of the Docker Remote API
506 (https://docs.docker.com/engine/api/v1.35/) and the C<--log-driver>
507 option to docker run
508 (https://docs.docker.com/engine/reference/run/#security-configuration).
509 By default, containers use the same logging driver that the Docker
510 daemon uses. However the container may use a different logging driver
511 than the Docker daemon by specifying a log driver with this parameter
512 in the container definition. To use a different logging driver for a
513 container, the log system must be configured properly on the container
514 instance (or on a different log server for remote logging options). For
515 more information on the options for different supported log drivers,
516 see Configure logging drivers
517 (https://docs.docker.com/engine/admin/logging/overview/) in the Docker
518 documentation.
519  
520 Amazon ECS currently supports a subset of the logging drivers available
521 to the Docker daemon (shown in the LogConfiguration data type).
522 Additional log drivers may be available in future releases of the
523 Amazon ECS container agent.
524  
525 This parameter requires version 1.18 of the Docker Remote API or
526 greater on your container instance. To check the Docker Remote API
527 version on your container instance, log in to your container instance
528 and run the following command: C<sudo docker version --format
529 '{{.Server.APIVersion}}'>
530  
531 The Amazon ECS container agent running on a container instance must
532 register the logging drivers available on that instance with the
533 C<ECS_AVAILABLE_LOGGING_DRIVERS> environment variable before containers
534 placed on that instance can use these log configuration options. For
535 more information, see Amazon ECS Container Agent Configuration
536 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html)
537 in the I<Amazon Elastic Container Service Developer Guide>.
538  
539  
540 =head2 Memory => Int
541  
542 The amount (in MiB) of memory to present to the container. If your
543 container attempts to exceed the memory specified here, the container
544 is killed. The total amount of memory reserved for all containers
545 within a task must be lower than the task C<memory> value, if one is
546 specified. This parameter maps to C<Memory> in the Create a container
547 (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
548 section of the Docker Remote API
549 (https://docs.docker.com/engine/api/v1.35/) and the C<--memory> option
550 to docker run
551 (https://docs.docker.com/engine/reference/run/#security-configuration).
552  
553 If using the Fargate launch type, this parameter is optional.
554  
555 If using the EC2 launch type, you must specify either a task-level
556 memory value or a container-level memory value. If you specify both a
557 container-level C<memory> and C<memoryReservation> value, C<memory>
558 must be greater than C<memoryReservation>. If you specify
559 C<memoryReservation>, then that value is subtracted from the available
560 memory resources for the container instance on which the container is
561 placed. Otherwise, the value of C<memory> is used.
562  
563 The Docker daemon reserves a minimum of 4 MiB of memory for a
564 container, so you should not specify fewer than 4 MiB of memory for
565 your containers.
566  
567  
568 =head2 MemoryReservation => Int
569  
570 The soft limit (in MiB) of memory to reserve for the container. When
571 system memory is under heavy contention, Docker attempts to keep the
572 container memory to this soft limit. However, your container can
573 consume more memory when it needs to, up to either the hard limit
574 specified with the C<memory> parameter (if applicable), or all of the
575 available memory on the container instance, whichever comes first. This
576 parameter maps to C<MemoryReservation> in the Create a container
577 (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
578 section of the Docker Remote API
579 (https://docs.docker.com/engine/api/v1.35/) and the
580 C<--memory-reservation> option to docker run
581 (https://docs.docker.com/engine/reference/run/#security-configuration).
582  
583 If a task-level memory value is not specified, you must specify a
584 non-zero integer for one or both of C<memory> or C<memoryReservation>
585 in a container definition. If you specify both, C<memory> must be
586 greater than C<memoryReservation>. If you specify C<memoryReservation>,
587 then that value is subtracted from the available memory resources for
588 the container instance on which the container is placed. Otherwise, the
589 value of C<memory> is used.
590  
591 For example, if your container normally uses 128 MiB of memory, but
592 occasionally bursts to 256 MiB of memory for short periods of time, you
593 can set a C<memoryReservation> of 128 MiB, and a C<memory> hard limit
594 of 300 MiB. This configuration would allow the container to only
595 reserve 128 MiB of memory from the remaining resources on the container
596 instance, but also allow the container to consume more memory resources
597 when needed.
598  
599 The Docker daemon reserves a minimum of 4 MiB of memory for a
600 container, so you should not specify fewer than 4 MiB of memory for
601 your containers.
602  
603  
604 =head2 MountPoints => ArrayRef[L<Paws::ECS::MountPoint>]
605  
606 The mount points for data volumes in your container.
607  
608 This parameter maps to C<Volumes> in the Create a container
609 (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
610 section of the Docker Remote API
611 (https://docs.docker.com/engine/api/v1.35/) and the C<--volume> option
612 to docker run
613 (https://docs.docker.com/engine/reference/run/#security-configuration).
614  
615 Windows containers can mount whole directories on the same drive as
616 C<$env:ProgramData>. Windows containers cannot mount directories on a
617 different drive, and mount point cannot be across drives.
618  
619  
620 =head2 Name => Str
621  
622 The name of a container. If you are linking multiple containers
623 together in a task definition, the C<name> of one container can be
624 entered in the C<links> of another container to connect the containers.
625 Up to 255 letters (uppercase and lowercase), numbers, underscores, and
626 hyphens are allowed. This parameter maps to C<name> in the Create a
627 container
628 (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
629 section of the Docker Remote API
630 (https://docs.docker.com/engine/api/v1.35/) and the C<--name> option to
631 docker run
632 (https://docs.docker.com/engine/reference/run/#security-configuration).
633  
634  
635 =head2 PortMappings => ArrayRef[L<Paws::ECS::PortMapping>]
636  
637 The list of port mappings for the container. Port mappings allow
638 containers to access ports on the host container instance to send or
639 receive traffic.
640  
641 For task definitions that use the C<awsvpc> network mode, you should
642 only specify the C<containerPort>. The C<hostPort> can be left blank or
643 it must be the same value as the C<containerPort>.
644  
645 Port mappings on Windows use the C<NetNAT> gateway address rather than
646 C<localhost>. There is no loopback for port mappings on Windows, so you
647 cannot access a container's mapped port from the host itself.
648  
649 This parameter maps to C<PortBindings> in the Create a container
650 (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
651 section of the Docker Remote API
652 (https://docs.docker.com/engine/api/v1.35/) and the C<--publish> option
653 to docker run
654 (https://docs.docker.com/engine/reference/run/#security-configuration).
655 If the network mode of a task definition is set to C<none>, then you
656 can't specify port mappings. If the network mode of a task definition
657 is set to C<host>, then host ports must either be undefined or they
658 must match the container port in the port mapping.
659  
660 After a task reaches the C<RUNNING> status, manual and automatic host
661 and container port assignments are visible in the B<Network Bindings>
662 section of a container description for a selected task in the Amazon
663 ECS console. The assignments are also visible in the C<networkBindings>
664 section DescribeTasks responses.
665  
666  
667 =head2 Privileged => Bool
668  
669 When this parameter is true, the container is given elevated privileges
670 on the host container instance (similar to the C<root> user). This
671 parameter maps to C<Privileged> in the Create a container
672 (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
673 section of the Docker Remote API
674 (https://docs.docker.com/engine/api/v1.35/) and the C<--privileged>
675 option to docker run
676 (https://docs.docker.com/engine/reference/run/#security-configuration).
677  
678 This parameter is not supported for Windows containers or tasks run on
679 AWS Fargate.
680  
681  
682 =head2 PseudoTerminal => Bool
683  
684 When this parameter is C<true>, a TTY is allocated. This parameter maps
685 to C<Tty> in the Create a container
686 (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
687 section of the Docker Remote API
688 (https://docs.docker.com/engine/api/v1.35/) and the C<--tty> option to
689 docker run
690 (https://docs.docker.com/engine/reference/run/#security-configuration).
691  
692  
693 =head2 ReadonlyRootFilesystem => Bool
694  
695 When this parameter is true, the container is given read-only access to
696 its root file system. This parameter maps to C<ReadonlyRootfs> in the
697 Create a container
698 (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
699 section of the Docker Remote API
700 (https://docs.docker.com/engine/api/v1.35/) and the C<--read-only>
701 option to docker run
702 (https://docs.docker.com/engine/reference/run/#security-configuration).
703  
704 This parameter is not supported for Windows containers.
705  
706  
707 =head2 RepositoryCredentials => L<Paws::ECS::RepositoryCredentials>
708  
709 The private repository authentication credentials to use.
710  
711  
712 =head2 ResourceRequirements => ArrayRef[L<Paws::ECS::ResourceRequirement>]
713  
714 The type and amount of a resource to assign to a container. The only
715 supported resource is a GPU.
716  
717  
718 =head2 Secrets => ArrayRef[L<Paws::ECS::Secret>]
719  
720 The secrets to pass to the container. For more information, see
721 Specifying Sensitive Data
722 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html)
723 in the I<Amazon Elastic Container Service Developer Guide>.
724  
725  
726 =head2 StartTimeout => Int
727  
728 Time duration (in seconds) to wait before giving up on resolving
729 dependencies for a container. For example, you specify two containers
730 in a task definition with containerA having a dependency on containerB
731 reaching a C<COMPLETE>, C<SUCCESS>, or C<HEALTHY> status. If a
732 C<startTimeout> value is specified for containerB and it does not reach
733 the desired status within that time then containerA will give up and
734 not start. This results in the task transitioning to a C<STOPPED>
735 state.
736  
737 When the C<ECS_CONTAINER_START_TIMEOUT> container agent configuration
738 variable is used, it is enforced indendently from this start timeout
739 value.
740  
741 For tasks using the Fargate launch type, this parameter requires that
742 the task or service uses platform version 1.3.0 or later.
743  
744 For tasks using the EC2 launch type, your container instances require
745 at least version C<1.26.0> of the container agent to enable a container
746 start timeout value. However, we recommend using the latest container
747 agent version. For information about checking your agent version and
748 updating to the latest version, see Updating the Amazon ECS Container
749 Agent
750 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html)
751 in the I<Amazon Elastic Container Service Developer Guide>. If you are
752 using an Amazon ECS-optimized Linux AMI, your instance needs at least
753 version C<1.26.0-1> of the C<ecs-init> package. If your container
754 instances are launched from version C<20190301> or later, then they
755 contain the required versions of the container agent and C<ecs-init>.
756 For more information, see Amazon ECS-optimized Linux AMI
757 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html)
758 in the I<Amazon Elastic Container Service Developer Guide>.
759  
760  
761 =head2 StopTimeout => Int
762  
763 Time duration (in seconds) to wait before the container is forcefully
764 killed if it doesn't exit normally on its own.
765  
766 For tasks using the Fargate launch type, the task or service requires
767 platform version 1.3.0 or later. The max stop timeout value is 120
768 seconds and if the parameter is not specified, the default value of 30
769 seconds is used.
770  
771 For tasks using the EC2 launch type, if the C<stopTimeout> parameter is
772 not specified, the value set for the Amazon ECS container agent
773 configuration variable C<ECS_CONTAINER_STOP_TIMEOUT> is used by
774 default. If neither the C<stopTimeout> parameter or the
775 C<ECS_CONTAINER_STOP_TIMEOUT> agent configuration variable are set,
776 then the default values of 30 seconds for Linux containers and 30
777 seconds on Windows containers are used. Your container instances
778 require at least version 1.26.0 of the container agent to enable a
779 container stop timeout value. However, we recommend using the latest
780 container agent version. For information about checking your agent
781 version and updating to the latest version, see Updating the Amazon ECS
782 Container Agent
783 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html)
784 in the I<Amazon Elastic Container Service Developer Guide>. If you are
785 using an Amazon ECS-optimized Linux AMI, your instance needs at least
786 version 1.26.0-1 of the C<ecs-init> package. If your container
787 instances are launched from version C<20190301> or later, then they
788 contain the required versions of the container agent and C<ecs-init>.
789 For more information, see Amazon ECS-optimized Linux AMI
790 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html)
791 in the I<Amazon Elastic Container Service Developer Guide>.
792  
793  
794 =head2 SystemControls => ArrayRef[L<Paws::ECS::SystemControl>]
795  
796 A list of namespaced kernel parameters to set in the container. This
797 parameter maps to C<Sysctls> in the Create a container
798 (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
799 section of the Docker Remote API
800 (https://docs.docker.com/engine/api/v1.35/) and the C<--sysctl> option
801 to docker run
802 (https://docs.docker.com/engine/reference/run/#security-configuration).
803  
804 It is not recommended that you specify network-related
805 C<systemControls> parameters for multiple containers in a single task
806 that also uses either the C<awsvpc> or C<host> network modes. For tasks
807 that use the C<awsvpc> network mode, the container that is started last
808 determines which C<systemControls> parameters take effect. For tasks
809 that use the C<host> network mode, it changes the container instance's
810 namespaced kernel parameters as well as the containers.
811  
812  
813 =head2 Ulimits => ArrayRef[L<Paws::ECS::Ulimit>]
814  
815 A list of C<ulimits> to set in the container. If a ulimit value is
816 specified in a task definition, it will override the default values set
817 by Docker. This parameter maps to C<Ulimits> in the Create a container
818 (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
819 section of the Docker Remote API
820 (https://docs.docker.com/engine/api/v1.35/) and the C<--ulimit> option
821 to docker run
822 (https://docs.docker.com/engine/reference/run/#security-configuration).
823 Valid naming values are displayed in the Ulimit data type.
824  
825 Amazon ECS tasks hosted on Fargate use the default resource limit
826 values set by the operating system with the exception of the C<nofile>
827 resource limit parameter which Fargate overrides. The C<nofile>
828 resource limit sets a restriction on the number of open files that a
829 container can use. The default C<nofile> soft limit is C<1024> and hard
830 limit is C<4096>.
831  
832 This parameter requires version 1.18 of the Docker Remote API or
833 greater on your container instance. To check the Docker Remote API
834 version on your container instance, log in to your container instance
835 and run the following command: C<sudo docker version --format
836 '{{.Server.APIVersion}}'>
837  
838 This parameter is not supported for Windows containers.
839  
840  
841 =head2 User => Str
842  
843 The user to use inside the container. This parameter maps to C<User> in
844 the Create a container
845 (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
846 section of the Docker Remote API
847 (https://docs.docker.com/engine/api/v1.35/) and the C<--user> option to
848 docker run
849 (https://docs.docker.com/engine/reference/run/#security-configuration).
850  
851 When running tasks using the C<host> network mode, you should not run
852 containers using the root user (UID 0). It is considered best practice
853 to use a non-root user.
854  
855 You can specify the C<user> using the following formats. If specifying
856 a UID or GID, you must specify it as a positive integer.
857  
858 =over
859  
860 =item *
861  
862 C<user>
863  
864 =item *
865  
866 C<user:group>
867  
868 =item *
869  
870 C<uid>
871  
872 =item *
873  
874 C<uid:gid>
875  
876 =item *
877  
878 C<user:gid>
879  
880 =item *
881  
882 C<uid:group>
883  
884 =back
885  
886 This parameter is not supported for Windows containers.
887  
888  
889 =head2 VolumesFrom => ArrayRef[L<Paws::ECS::VolumeFrom>]
890  
891 Data volumes to mount from another container. This parameter maps to
892 C<VolumesFrom> in the Create a container
893 (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
894 section of the Docker Remote API
895 (https://docs.docker.com/engine/api/v1.35/) and the C<--volumes-from>
896 option to docker run
897 (https://docs.docker.com/engine/reference/run/#security-configuration).
898  
899  
900 =head2 WorkingDirectory => Str
901  
902 The working directory in which to run commands inside the container.
903 This parameter maps to C<WorkingDir> in the Create a container
904 (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
905 section of the Docker Remote API
906 (https://docs.docker.com/engine/api/v1.35/) and the C<--workdir> option
907 to docker run
908 (https://docs.docker.com/engine/reference/run/#security-configuration).
909  
910  
911  
912 =head1 SEE ALSO
913  
914 This class forms part of L<Paws>, describing an object used in L<Paws::ECS>
915  
916 =head1 BUGS and CONTRIBUTIONS
917  
918 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
919  
920 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
921  
922 =cut
923