Paws::ECS::ContainerDefinition
This class represents one of two things:
Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.
As an example, if Att1 is expected to be a Paws::ECS::ContainerDefinition object:
$service_obj->Method(Att1 => { Command => $value, ..., WorkingDirectory => $value });
Use accessors for each attribute. If Att1 is expected to be an Paws::ECS::ContainerDefinition object:
$result = $service_obj->Method(...); $result->Att1->Command
Container definitions are used in task definitions to describe the different containers that are launched as part of a task.
The command that is passed to the container. This parameter maps to C<Cmd> in the Create a container section of the Docker Remote API and the C<COMMAND> parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd.
The number of C<cpu> units reserved for the container. A container instance has 1,024 C<cpu> units for every CPU core. This parameter specifies the minimum amount of CPU to reserve for a container, and containers share unallocated CPU units with other containers on the instance with the same ratio as their allocated amount. This parameter maps to C<CpuShares> in the Create a container section of the Docker Remote API and the C<--cpu-shares> option to docker run.
You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024.
For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.
The Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2; however, the CPU parameter is not required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:
Agent versions less than or equal to 1.1.0: Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to 2 CPU shares.
Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values of 1 are passed to Docker as 2.
When this parameter is true, networking is disabled within the container. This parameter maps to C<NetworkDisabled> in the Create a container section of the Docker Remote API.
A list of DNS search domains that are presented to the container. This parameter maps to C<DnsSearch> in the Create a container section of the Docker Remote API and the C<--dns-search> option to docker run.
A list of DNS servers that are presented to the container. This parameter maps to C<Dns> in the Create a container section of the Docker Remote API and the C<--dns> option to docker run.
A key/value map of labels to add to the container. This parameter maps to C<Labels> in the Create a container section of the Docker Remote API and the C<--label> option to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: C<sudo docker version | grep "Server API version">
A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This parameter maps to C<SecurityOpt> in the Create a container section of the Docker Remote API and the C<--security-opt> option to docker run.
The Amazon ECS container agent running on a container instance must register with the ECS_SELINUX_CAPABLE=true or ECS_APPARMOR_CAPABLE=true environment variables before containers placed on that instance can use these security options. For more information, see Amazon ECS Container Agent Configuration in the Amazon EC2 Container Service Developer Guide.
ECS_SELINUX_CAPABLE=true
ECS_APPARMOR_CAPABLE=true
Early versions of the Amazon ECS container agent do not properly handle C<entryPoint> parameters. If you have problems using C<entryPoint>, update your container agent or enter your commands and arguments as C<command> array items instead.
The entry point that is passed to the container. This parameter maps to Entrypoint in the Create a container section of the Docker Remote API and the --entrypoint option to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint.
Entrypoint
--entrypoint
The environment variables to pass to a container. This parameter maps to C<Env> in the Create a container section of the Docker Remote API and the C<--env> option to docker run.
We do not recommend using plain text environment variables for sensitive information, such as credential data.
If the C<essential> parameter of a container is marked as C<true>, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the C<essential> parameter of a container is marked as C<false>, then its failure does not affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.
All tasks must have at least one essential container. If you have an application that is composed of multiple containers, you should group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon EC2 Container Service Developer Guide.
A list of hostnames and IP address mappings to append to the C</etc/hosts> file on the container. This parameter maps to C<ExtraHosts> in the Create a container section of the Docker Remote API and the C<--add-host> option to docker run.
The hostname to use for your container. This parameter maps to C<Hostname> in the Create a container section of the Docker Remote API and the C<--hostname> option to docker run.
The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with C< I<repository-url>/I<image>:I<tag> >. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to C<Image> in the Create a container section of the Docker Remote API and the C<IMAGE> parameter of docker run.
Amazon ECS task definitions currently only support tags as image identifiers within a specified repository (and not sha256 digests).
sha256
Images in Amazon ECR repositories use the full registry and repository URI (for example, 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>).
012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>
Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo).
ubuntu
mongo
Images in other repositories on Docker Hub are qualified with an organization name (for example, amazon/amazon-ecs-agent).
amazon/amazon-ecs-agent
Images in other online repositories are qualified further by a domain name (for example, quay.io/assemblyline/ubuntu).
quay.io/assemblyline/ubuntu
The C<link> parameter allows containers to communicate with each other without the need for port mappings, using the C<name> parameter and optionally, an C<alias> for the link. This construct is analogous to C<name:alias> in Docker links. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed for each C<name> and C<alias>. For more information on linking Docker containers, see https://docs.docker.com/engine/userguide/networking/default_network/dockerlinks/. This parameter maps to C<Links> in the Create a container section of the Docker Remote API and the C<--link> option to docker run.
Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.
The log configuration specification for the container. This parameter maps to C<LogConfig> in the Create a container section of the Docker Remote API and the C<--log-driver> option to docker run. By default, containers use the same logging driver that the Docker daemon uses; however the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.
Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
sudo docker version | grep "Server API version"
The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon EC2 Container Service Developer Guide.
ECS_AVAILABLE_LOGGING_DRIVERS
The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to C<Memory> in the Create a container section of the Docker Remote API and the C<--memory> option to docker run.
You must specify a non-zero integer for one or both of memory or memoryReservation in container definitions. If you specify both, memory must be greater than memoryReservation. If you specify memoryReservation, then that value is subtracted from the available memory resources for the container instance on which the container is placed; otherwise, the value of memory is used.
memory
memoryReservation
The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.
The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit; however, your container can consume more memory when it needs to, up to either the hard limit specified with the C<memory> parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to C<MemoryReservation> in the Create a container section of the Docker Remote API and the C<--memory-reservation> option to docker run.
For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a memoryReservation of 128 MiB, and a memory hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed.
The mount points for data volumes in your container. This parameter maps to C<Volumes> in the Create a container section of the Docker Remote API and the C<--volume> option to docker run.
The name of a container. If you are linking multiple containers together in a task definition, the C<name> of one container can be entered in the C<links> of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This parameter maps to C<name> in the Create a container section of the Docker Remote API and the C<--name> option to docker run.
The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic. This parameter maps to C<PortBindings> in the Create a container section of the Docker Remote API and the C<--publish> option to docker run. If the network mode of a task definition is set to C<none>, then you cannot specify port mappings. If the network mode of a task definition is set to C<host>, then host ports must either be undefined or they must match the container port in the port mapping.
After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the Network Bindings section of a container description of a selected task in the Amazon ECS console, or the networkBindings section DescribeTasks responses.
RUNNING
networkBindings
When this parameter is true, the container is given elevated privileges on the host container instance (similar to the C<root> user). This parameter maps to C<Privileged> in the Create a container section of the Docker Remote API and the C<--privileged> option to docker run.
When this parameter is true, the container is given read-only access to its root file system. This parameter maps to C<ReadonlyRootfs> in the Create a container section of the Docker Remote API and the C<--read-only> option to C<docker run>.
A list of C<ulimits> to set in the container. This parameter maps to C<Ulimits> in the Create a container section of the Docker Remote API and the C<--ulimit> option to docker run. Valid naming values are displayed in the Ulimit data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: C<sudo docker version | grep "Server API version">
The user name to use inside the container. This parameter maps to C<User> in the Create a container section of the Docker Remote API and the C<--user> option to docker run.
Data volumes to mount from another container. This parameter maps to C<VolumesFrom> in the Create a container section of the Docker Remote API and the C<--volumes-from> option to docker run.
The working directory in which to run commands inside the container. This parameter maps to C<WorkingDir> in the Create a container section of the Docker Remote API and the C<--workdir> option to docker run.
This class forms part of Paws, describing an object used in Paws::ECS
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
To install Paws::SDK::Config, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Paws::SDK::Config
CPAN shell
perl -MCPAN -e shell install Paws::SDK::Config
For more information on module installation, please visit the detailed CPAN module installation guide.