Amazon ECS task definition parameters
Task definitions are split into separate parts: the task family, the AWS Identity and Access Management (IAM) task role, the network mode, container definitions, volumes, task placement constraints, and launch types. The family and container definitions are required in a task definition. In contrast, task role, network mode, volumes, task placement constraints, and launch type are optional.
You can use these parameters in a JSON file to configure your task definition.
The following are more detailed descriptions for each task definition parameter.
Family
family
-
Type: String
Required: Yes
When you register a task definition, you give it a family, which is similar to a name for multiple versions of the task definition, specified with a revision number. The first task definition that's registered into a particular family is given a revision of 1, and any task definitions registered after that are given a sequential revision number.
Launch types
When you register a task definition, you can specify a launch type that Amazon ECS should validate the task definition against. If the task definition doesn't validate against the compatibilities specified, a client exception is returned. For more information, see Amazon ECS launch types.
The following parameter is allowed in a task definition.
requiresCompatibilities
-
Type: String array
Required: No
Valid Values:
EC2
|FARGATE
|EXTERNAL
The launch type to validate the task definition against. This initiates a check to ensure that all of the parameters that are used in the task definition meet the requirements of the launch type.
Task role
taskRoleArn
-
Type: String
Required: No
When you register a task definition, you can provide a task role for an IAM role that allows the containers in the task permission to call the AWS APIs that are specified in its associated policies on your behalf. For more information, see Amazon ECS task IAM role.
When you launch the Amazon ECS-optimized Windows Server AMI, IAM roles for tasks on Windows require that the
-EnableTaskIAMRole
option is set. Your containers must also run some configuration code to use the feature. For more information, see Amazon EC2 Windows instance additional configuration.
Task execution role
executionRoleArn
-
Type: String
Required: Conditional
The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make AWS API calls on your behalf.
Note
The task execution IAM role is required depending on the requirements of your task. For more information, see Amazon ECS task execution IAM role.
Network mode
networkMode
-
Type: String
Required: No
The Docker networking mode to use for the containers in the task. For Amazon ECS tasks that are hosted on Amazon EC2 Linux instances, the valid values are
none
,bridge
,awsvpc
, andhost
. If no network mode is specified, the default network mode isbridge
. For Amazon ECS tasks hosted on Amazon EC2 Windows instances, the valid values aredefault
, andawsvpc
. If no network mode is specified, thedefault
network mode is used. For Amazon ECS tasks hosted on Fargate, theawsvpc
network mode is required.If the network mode is set to
none
, the task's containers don't have external connectivity and port mappings can't be specified in the container definition.If the network mode is
bridge
, the task uses Docker's built-in virtual network on Linux, which runs inside each Amazon EC2 instance that hosts the task. The built-in virtual network on Linux uses thebridge
Docker network driver.If the network mode is
host
, the task uses the host's network which bypasses Docker's built-in virtual network by mapping container ports directly to the ENI of the Amazon EC2 instance that hosts the task. Dynamic port mappings can’t be used in this network mode. A container in a task definition that uses this mode must specify a specifichostPort
number. A port number on a host can’t be used by multiple tasks. As a result, you can’t run multiple tasks of the same task definition on a single Amazon EC2 instance.Important
When running tasks that use the
host
network mode, do not run containers using the root user (UID 0) for better security. As a security best practice, always use a non-root user.For the Amazon EC2 launch types, if the network mode is
awsvpc
, the task is allocated an elastic network interface, and you must specify aNetworkConfiguration
when you create a service or run a task with the task definition. For more information, see Amazon ECS task networking options for the EC2 launch type.If the network mode is
default
, the task uses Docker's built-in virtual network on Windows, which runs inside each Amazon EC2 instance that hosts the task. The built-in virtual network on Windows uses thenat
Docker network driver.For the Fargate launch types, when the network mode is
awsvpc
, the task is allocated an elastic network interface, and you must specify aNetworkConfiguration
when you create a service or run a task with the task definition. For more information, see Fargate Task Networking. Theawsvpc
network mode offers the highest networking performance for containers because they use the Amazon EC2 network stack. Exposed container ports are mapped directly to the attached elastic network interface port. Because of this, you can't use dynamic host port mappings.The
host
andawsvpc
network modes offer the highest networking performance for containers because they use the Amazon EC2 network stack. With thehost
andawsvpc
network modes, exposed container ports are mapped directly to the corresponding host port (for thehost
network mode) or the attached elastic network interface port (for theawsvpc
network mode). Because of this, you can't use dynamic host port mappings.If using the Fargate launch type, the
awsvpc
network mode is required. If using the EC2 launch type, the allowable network mode depends on the underlying EC2 instance's operating system. If Linux, any network mode can be used. If Windows, thedefault
, andawsvpc
modes can be used.
Runtime platform
operatingSystemFamily
-
Type: String
Required: Conditional
Default: LINUX
This parameter is required for Amazon ECS tasks that are hosted on Fargate.
When you register a task definition, you specify the operating system family.
The valid values for Amazon ECS tasks that are hosted on Fargate are
LINUX
,WINDOWS_SERVER_2019_FULL
,WINDOWS_SERVER_2019_CORE
,WINDOWS_SERVER_2022_FULL
, andWINDOWS_SERVER_2022_CORE
.The valid values for Amazon ECS tasks hosted on EC2 are
LINUX
,WINDOWS_SERVER_2022_CORE
,WINDOWS_SERVER_2022_FULL
,WINDOWS_SERVER_2019_FULL
, andWINDOWS_SERVER_2019_CORE
,WINDOWS_SERVER_2016_FULL
,WINDOWS_SERVER_2004_CORE
, andWINDOWS_SERVER_20H2_CORE
.All task definitions that are used in a service must have the same value for this parameter.
When a task definition is part of a service, this value must match the service
platformFamily
value. cpuArchitecture
-
Type: String
Required: Conditional
Default: X86_64
This parameter is required for Amazon ECS tasks hosted on Fargate. If the parameter is left as
null
, the default value is automatically assigned upon the initiation of a task hosted on Fargate.When you register a task definition, you specify the CPU architecture. The valid values are
X86_64
andARM64
.All task definitions that are used in a service must have the same value for this parameter.
When you have Linux tasks for either the Fargate launch type, or the EC2 launch type, you can set the value to
ARM64
. For more information, see Amazon ECS task definitions for 64-bit ARM workloads.
Task size
When you register a task definition, you can specify the total CPU and memory used for
the task. This is separate from the cpu
and memory
values at
the container definition level. For tasks that are hosted on Amazon EC2 instances, these
fields are optional. For tasks that are hosted on Fargate (both Linux and Windows),
these fields are required and there are specific values for both cpu
and
memory
that are supported.
Note
Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.
The following parameter is allowed in a task definition:
cpu
-
Type: String
Required: Conditional
Note
This parameter is not supported for Windows containers.
The hard limit of CPU units to present for the task. You can specify CPU values in the JSON file as a string in CPU units or virtual CPUs (vCPUs). For example, you can specify a CPU value either as
1024
in CPU units or1 vCPU
in vCPUs. When the task definition is registered, a vCPU value is converted to an integer indicating the CPU units.For tasks that run on EC2 or external instances, this field is optional. If your cluster doesn't have any registered container instances with the requested CPU units available, the task fails. Supported values for tasks that run on EC2 or external instances are between
0.125
vCPUs and10
vCPUs.For tasks that run on Fargate (both Linux and Windows containers), this field is required and you must use one of the following values, which determines your range of supported values for the
memory
parameter. The table below shows the valid combinations of task-level CPU and memory.CPU value Memory value Operating systems supported for AWS Fargate 256 (.25 vCPU) 512 MiB, 1 GB, 2 GB Linux 512 (.5 vCPU) 1 GB, 2 GB, 3 GB, 4 GB Linux 1024 (1 vCPU) 2 GB, 3 GB, 4 GB, 5 GB, 6 GB, 7 GB, 8 GB Linux, Windows 2048 (2 vCPU) Between 4 GB and 16 GB in 1 GB increments Linux, Windows 4096 (4 vCPU) Between 8 GB and 30 GB in 1 GB increments Linux, Windows 8192 (8 vCPU) Note
This option requires Linux platform
1.4.0
or later.Between 16 GB and 60 GB in 4 GB increments Linux 16384 (16vCPU) Note
This option requires Linux platform
1.4.0
or later.Between 32 GB and 120 GB in 8 GB increments Linux
memory
-
Type: String
Required: Conditional
Note
This parameter is not supported for Windows containers.
The hard limit of memory to present to the task. You can specify memory values in the task definition as a string in mebibytes (MiB) or gigabytes (GB). For example, you can specify a memory value either as
3072
in MiB or3 GB
in GB. When the task definition is registered, a GB value is converted to an integer indicating the MiB.For tasks that are hosted on Amazon EC2 instances, this field is optional and any value can be used. If a task-level memory value is specified, then the container-level memory value is optional. If your cluster doesn't have any registered container instances with the requested memory available, the task fails. You can maximize your resource utilization by providing your tasks as much memory as possible for a particular instance type. For more information, see Reserving Amazon ECS Linux container instance memory.
For tasks hosted on Fargate (both Linux and Windows containers), this field is required and you must use one of the following values, which determines your range of supported values for the
cpu
parameter:Memory value (in MiB, with approximate equivalent value in GB) CPU value Operating systems supported for Fargate 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) 256 (.25 vCPU) Linux 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) 512 (.5 vCPU) Linux 2048 (2 GB), 3072 (3 GB), 4096 (4GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) 1024 (1 vCPU) Linux, Windows Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) 2048 (2 vCPU) Linux, Windows Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) 4096 (4 vCPU) Linux, Windows Between 16 GB and 60 GB in 4 GB increments Note
This option requires Linux platform
1.4.0
or later.8192 (8 vCPU) Linux
Between 32 GB and 120 GB in 8 GB increments Note
This option requires Linux platform
1.4.0
or later.16384 (16vCPU) Linux
Container definitions
When you register a task definition, you must specify a list of container definitions that are passed to the Docker daemon on a container instance. The following parameters are allowed in a container definition.
Topics
Standard container definition parameters
The following task definition parameters are either required or used in most container definitions.
Name
name
-
Type: String
Required: Yes
The name of a container. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. If you're linking multiple containers in a task definition, the
name
of one container can be entered in thelinks
of another container. This is to connect the containers.
Image
image
-
Type: String
Required: Yes
The image used to start a container. This string is passed directly to the Docker daemon. By default, images in the Docker Hub registry are available. You can also specify other repositories with either
orrepository-url
/image
:tag
. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps torepository-url
/image
@digest
Image
in the docker create-container command and theIMAGE
parameter of the docker run command.-
When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image aren't propagated to already running tasks.
-
Images in private registries are supported. For more information, see Using non-AWS container images in Amazon ECS.
-
Images in Amazon ECR repositories can be specified by using either the full
registry/repository:tag
orregistry/repository@digest
naming convention (for example,aws_account_id
.dkr.ecr.region
.amazonaws.com/
ormy-web-app
:latest
aws_account_id
.dkr.ecr.region
.amazonaws.com/
).my-web-app
@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE
-
Images in official repositories on Docker Hub use a single name (for example,
ubuntu
ormongo
). -
Images in other repositories on Docker Hub are qualified with an organization name (for example,
amazon/amazon-ecs-agent
). -
Images in other online repositories are qualified further by a domain name (for example,
quay.io/assemblyline/ubuntu
).
-
Memory
memory
-
Type: Integer
Required: No
The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. The total amount of memory reserved for all containers within a task must be lower than the task
memory
value, if one is specified. This parameter maps toMemory
in the docker create-container command and the--memory
option to docker run.If you're using the Fargate launch type, this parameter is optional.
If you're using the EC2 launch type, you must specify either a task-level memory value or a container-level memory value. If you specify both a container-level
memory
andmemoryReservation
value, thememory
value must be greater than thememoryReservation
value. If you specifymemoryReservation
, then that value is subtracted from the available memory resources for the container instance that the container is placed on. Otherwise, the value ofmemory
is used.The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers.
The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers.
Note
If you're trying to maximize your resource utilization by providing your tasks as much memory as possible for a particular instance type, see Reserving Amazon ECS Linux container instance memory.
memoryReservation
-
Type: Integer
Required: No
The soft limit (in MiB) of memory to reserve for the container. When system memory is under contention, Docker attempts to keep the container memory to this soft limit. However, your container can use more memory when needed. The container can use up to the hard limit that's specified with the
memory
parameter (if applicable) or all of the available memory on the container instance, whichever comes first. This parameter maps toMemoryReservation
in the docker create-container command and the--memory-reservation
option to docker run.If a task-level memory value isn't specified, you must specify a non-zero integer for one or both of
memory
ormemoryReservation
in a container definition. If you specify both,memory
must be greater thanmemoryReservation
. If you specifymemoryReservation
, then that value is subtracted from the available memory resources for the container instance that the container is placed on. Otherwise, the value ofmemory
is used.For example, suppose that 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 amemory
hard limit of 300 MiB. This configuration allows the container to only reserve 128 MiB of memory from the remaining resources on the container instance. At the same time, this configuration also allows the container to use more memory resources when needed.Note
This parameter isn't supported for Windows containers.
The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers.
The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers.
Note
If you're trying to maximize your resource utilization by providing your tasks as much memory as possible for a particular instance type, see Reserving Amazon ECS Linux container instance memory.
Port mappings
portMappings
-
Type: Object array
Required: No
Port mappings expose your container's network ports to the outside world. this allows clients to access your application. It's also used for inter-container communication within the same task.
For task definitions (both the Fargate and EC2 launch type) that use the
awsvpc
network mode, only specify thecontainerPort
. ThehostPort
is always ignored, and the container port is automatically mapped to a random high-numbered port on the host.Port mappings on Windows use the
NetNAT
gateway address rather thanlocalhost
. There's no loopback for port mappings on Windows, so you can't access a container's mapped port from the host itself.Most fields of this parameter (including
containerPort
,hostPort
,protocol
) map toPortBindings
in thedocker create-container command and the--publish
option to docker run. If the network mode of a task definition is set tohost
, host ports must either be undefined or match the container port in the port mapping.Note
After a task reaches the
RUNNING
status, manual and automatic host and container port assignments are visible in the following locations:-
Console: The Network Bindings section of a container description for a selected task.
-
AWS CLI: The
networkBindings
section of the describe-tasks command output. -
API: The
DescribeTasks
response. -
Metadata: The task metadata endpoint.
appProtocol
-
Type: String
Required: No
The application protocol that's used for the port mapping. This parameter only applies to Service Connect. We recommend that you set this parameter to be consistent with the protocol that your application uses. If you set this parameter, Amazon ECS adds protocol-specific connection handling to the service connect proxy. If you set this parameter, Amazon ECS adds protocol-specific telemetry in the Amazon ECS console and CloudWatch.
If you don't set a value for this parameter, then TCP is used. However, Amazon ECS doesn't add protocol-specific telemetry for TCP.
For more information, see Use Service Connect to connect Amazon ECS services with short names.
Valid protocol values:
"HTTP" | "HTTP2" | "GRPC"
containerPort
-
Type: Integer
Required: Yes, when
portMappings
are usedThe port number on the container that's bound to the user-specified or automatically assigned host port.
For tasks that use the Fargate launch type or EC2 tasks that use the
awsvpc
network mode, you usecontainerPort
to specify the exposed ports.For Windows containers on Fargate, you can't use port 3150 for the
containerPort
. This is because it's reserved.Suppose that you're using containers in a task with the EC2 launch type and you specify a container port and not a host port. Then, your container automatically receives a host port in the ephemeral port range. For more information, see
hostPort
. Port mappings that are automatically assigned in this way don't count toward the 100 reserved ports quota of a container instance. containerPortRange
-
Type: String
Required: No
The port number range on the container that's bound to the dynamically mapped host port range.
You can only set this parameter by using the
register-task-definition
API. The option is available in theportMappings
parameter. For more information, see register-task-definition in the AWS Command Line Interface Reference.The following rules apply when you specify a
containerPortRange
:-
You must use either the
bridge
network mode or theawsvpc
network mode. -
This parameter is available for both the EC2 and AWS Fargate launch types.
-
This parameter is available for both the Linux and Windows operating systems.
-
The container instance must have at least version 1.67.0 of the container agent and at least version 1.67.0-1 of the
ecs-init
package. -
You can specify a maximum of 100 port ranges for each container.
-
You don't specify a
hostPortRange
. The value of thehostPortRange
is set as follows:-
For containers in a task with the
awsvpc
network mode, thehostPort
is set to the same value as thecontainerPort
. This is a static mapping strategy. -
For containers in a task with the
bridge
network mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports.
-
-
The
containerPortRange
valid values are between 1 and 65535. -
A port can only be included in one port mapping for each container.
-
You can't specify overlapping port ranges.
-
The first port in the range must be less than last port in the range.
-
Docker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports.
For more information, see Issue #11185
on GitHub. For information about how to turn off the docker-proxy in the Docker daemon config file, see Docker daemon in the Amazon ECS Developer Guide.
You can call
DescribeTasks
to view thehostPortRange
, which are the host ports that are bound to the container ports.The port ranges aren't included in the Amazon ECS task events, which are sent to EventBridge. For more information, see Automate responses to Amazon ECS errors using EventBridge.
-
hostPortRange
-
Type: String
Required: No
The port number range on the host that's used with the network binding. This is assigned by Docker and delivered by the Amazon ECS agent.
hostPort
-
Type: Integer
Required: No
The port number on the container instance to reserve for your container.
If using containers in a task with the Fargate launch type, the
hostPort
can either be kept blank or be the same value ascontainerPort
.Suppose that you're using containers in a task with the EC2 launch type. You can specify a non-reserved host port for your container port mapping. This is referred to as static host port mapping. Or, you can omit the
hostPort
(or set it to0
) while specifying acontainerPort
. Your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version. This is referred to as dynamic host port mapping.The default ephemeral port range Docker version 1.6.0 and later is listed on the instance under
/proc/sys/net/ipv4/ip_local_port_range
. If this kernel parameter is unavailable, the default ephemeral port range from49153–65535
is used. Don't attempt to specify a host port in the ephemeral port range. This is because these are reserved for automatic assignment. In general, ports under32768
are outside of the ephemeral port range.The default reserved ports are
22
for SSH, the Docker ports2375
and2376
, and the Amazon ECS container agent ports51678-51680
. Any host port that was previously user-specified for a running task is also reserved while the task is running. After a task stops, the host port is released. The current reserved ports are displayed in theremainingResources
of describe-container-instances output. A container instance might have up to 100 reserved ports at a time, including the default reserved ports. Automatically assigned ports don't count toward the 100 reserved ports quota. name
-
Type: String
Required: No, required for Service Connect to be configured in a service
The name that's used for the port mapping. This parameter only applies to Service Connect. This parameter is the name that you use in the Service Connect configuration of a service.
For more information, see Use Service Connect to connect Amazon ECS services with short names.
In the following example, both of the required fields for Service Connect are used.
"portMappings": [ { "name":
string
, "containerPort":integer
} ] protocol
-
Type: String
Required: No
The protocol that's used for the port mapping. Valid values are
tcp
andudp
. The default istcp
.Important
Only
tcp
is supported for Service Connect. Remember thattcp
is implied if this field isn't set.Important
UDP support is only available on container instances that were launched with version 1.2.0 of the Amazon ECS container agent (such as the
amzn-ami-2015.03.c-amazon-ecs-optimized
AMI) or later, or with container agents that have been updated to version 1.3.0 or later. To update your container agent to the latest version, see Updating the Amazon ECS container agent.
If you're specifying a host port, use the following syntax.
"portMappings": [ { "containerPort": integer, "hostPort": integer } ... ]
If you want an automatically assigned host port, use the following syntax.
"portMappings": [ { "containerPort": integer } ... ]
-
Private Repository Credentials
repositoryCredentials
-
Type: RepositoryCredentials object
Required: No
The repository credentials for private registry authentication.
For more information, see Using non-AWS container images in Amazon ECS.
-
credentialsParameter
-
Type: String
Required: Yes, when
repositoryCredentials
are usedThe Amazon Resource Name (ARN) of the secret containing the private repository credentials.
For more information, see Using non-AWS container images in Amazon ECS.
Note
When you use the Amazon ECS API, AWS CLI, or AWS SDKs, if the secret exists in the same Region as the task that you're launching then you can use either the full ARN or the name of the secret. When you use the AWS Management Console, you must specify the full ARN of the secret.
The following is a snippet of a task definition that shows the required parameters:
"containerDefinitions": [ { "image": "
private-repo/private-image
", "repositoryCredentials": { "credentialsParameter": "arn:aws:secretsmanager:region:aws_account_id:secret:secret_name
" } } ]
-
Advanced container definition parameters
The following advanced container definition parameters provide extended capabilities to the docker run command that's used to launch containers on your Amazon ECS container instances.
Topics
Restart policy
restartPolicy
-
The container restart policy and associated configuration parameters. When you set up a restart policy for a container, Amazon ECS can restart the container without needing to replace the task. For more information, see Restart individual containers in Amazon ECS tasks with container restart policies.
enabled
-
Type: Boolean
Required: Yes
Specifies whether a restart policy is enabled for the container.
ignoredExitCodes
-
Type: Integer array
Required: No
A list of exit codes that Amazon ECS will ignore and not attempt a restart on. You can specify a maximum of 50 container exit codes. By default, Amazon ECS does not ignore any exit codes.
restartAttemptPeriod
-
Type: Integer
Required: No
A period of time (in seconds) that the container must run for before a restart can be attempted. A container can be restarted only once every
restartAttemptPeriod
seconds. If a container isn't able to run for this time period and exits early, it will not be restarted. You can set a minimumrestartAttemptPeriod
of 60 seconds and a maximumrestartAttemptPeriod
of 1800 seconds. By default, a container must run for 300 seconds before it can be restarted.
Health check
healthCheck
-
The container health check command and the associated configuration parameters for the container. For more information, see Determine Amazon ECS task health using container health checks.
command
-
A string array that represents the command that the container runs to determine if it's healthy. The string array can start with
CMD
to run the command arguments directly, orCMD-SHELL
to run the command with the container's default shell. If neither is specified,CMD
is used.When registering a task definition in the AWS Management Console, use a comma separated list of commands. These commands are converted to a string after the task definition is created. An example input for a health check is the following.
CMD-SHELL, curl -f http://localhost/ || exit 1
When registering a task definition using the AWS Management Console JSON panel, the AWS CLI, or the APIs, enclose the list of commands in brackets. An example input for a health check is the following.
[ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ]
An exit code of 0, with no
stderr
output, indicates success, and a non-zero exit code indicates failure. interval
-
The period of time (in seconds) between each health check. You can specify between 5 and 300 seconds. The default value is 30 seconds.
timeout
-
The period of time (in seconds) to wait for a health check to succeed before it's considered a failure. You can specify between 2 and 60 seconds. The default value is 5 seconds.
retries
-
The number of times to retry a failed health check before the container is considered unhealthy. You can specify between 1 and 10 retries. The default value is three retries.
startPeriod
-
The optional grace period to provide containers time to bootstrap in before failed health checks count towards the maximum number of retries. You can specify between 0 and 300 seconds. By default,
startPeriod
is disabled.
Environment
cpu
-
Type: Integer
Required: No
The number of
cpu
units the Amazon ECS container agent reserves for the container. On Linux, this parameter maps toCpuShares
in the Create a containersection. This field is optional for tasks that use the Fargate launch type. The total amount of CPU reserved for all the containers that are within a task must be lower than the task-level
cpu
value.Note
You can determine the number of CPU units that are available to each Amazon EC2 instance type. To do this, multiply the number of vCPUs listed for that instance type on the Amazon EC2 Instances
detail page by 1,024. Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, assume that you run a single-container task on a single-core instance type with 512 CPU units specified for that container. Moreover, that task is the only task running on the container instance. In this example, the container can use the full 1,024 CPU unit share at any given time. However, assume then that you launched another copy of the same task on that container instance. Each task is guaranteed a minimum of 512 CPU units when needed. Similarly, if the other container isn't using the remaining CPU, each container can float to higher CPU usage. However, if both tasks were 100% active all of the time, they are limited to 512 CPU units.
On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. The minimum valid CPU share value that the Linux kernel allows is 2, and the maximum valid CPU share value that the Linux kernel allows is 262144. However, the CPU parameter isn't required, and you can use CPU values below two and above 262144 in your container definitions. For CPU values below two (including null) and above 262144, the behavior varies based on your Amazon ECS container agent version:
-
Agent versions <= 1.1.0: Null and zero CPU values are passed to Docker as 0. Docker then converts this value to 1,024 CPU shares. CPU values of one are passed to Docker as one, which the Linux kernel converts to two CPU shares.
-
Agent versions >= 1.2.0: Null, zero, and CPU values of one are passed to Docker as two CPU shares.
-
Agent versions >= 1.84.0: CPU values greater than 256 vCPU are passed to Docker as 256, which is equivalent to 262144 CPU shares.
On Windows container instances, the CPU quota is enforced as an absolute quota. Windows containers only have access to the specified amount of CPU that's defined in the task definition. A null or zero CPU value is passed to Docker as
0
. Windows then interprets this value as 1% of one CPU.For more examples, see How Amazon ECS manages CPU and memory resources
. -
gpu
-
Type: ResourceRequirement object
Required: No
The number of physical
GPUs
that the Amazon ECS container agent reserves for the container. The number of GPUs reserved for all containers in a task must not exceed the number of available GPUs on the container instance the task is launched on. For more information, see Amazon ECS task definitions for GPU workloads.Note
This parameter isn't supported for Windows containers or containers that are hosted on Fargate.
Elastic Inference accelerator
-
Type: ResourceRequirement object
Required: No
For the
InferenceAccelerator
type, thevalue
matches thedeviceName
for anInferenceAccelerator
specified in a task definition. For more information, see Elastic Inference accelerator name.Note
Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
Note
This parameter isn't supported for Windows containers or containers that are hosted on Fargate.
essential
-
Type: Boolean
Required: No
Suppose that the
essential
parameter of a container is marked astrue
, and that container fails or stops for any reason. Then, all other containers that are part of the task are stopped. If theessential
parameter of a container is marked asfalse
, then its failure doesn't 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. Suppose that you have an application that's composed of multiple containers. Then, group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Architect your application for Amazon ECS.
"essential": true|false
entryPoint
-
Important
Early versions of the Amazon ECS container agent don't properly handle
entryPoint
parameters. If you have problems usingentryPoint
, update your container agent or enter your commands and arguments ascommand
array items instead.Type: String array
Required: No
The entry point that's passed to the container.
"entryPoint": ["string", ...]
command
-
Type: String array
Required: No
The command that's passed to the container. This parameter maps to
Cmd
in the create-container command and theCOMMAND
parameter to docker run. If there are multiple arguments, make sure that each argument is a separated string in the array."command": ["string", ...]
workingDirectory
-
Type: String
Required: No
The working directory to run commands inside the container in. This parameter maps to
WorkingDir
in the Create a containersection of the Docker Remote API and the --workdir
option to docker run. "workingDirectory": "string"
environmentFiles
-
Type: Object array
Required: No
A list of files containing the environment variables to pass to a container. This parameter maps to the
--env-file
option to the docker run command.When FIPS is enabled on a host using the EC2 launch type, bucket names that have periods (.) (for example, amzn-s3-demo-bucket1.name.example) aren't supported. Having periods (.) in the bucket name prevents the task from starting because the agent can't pull the environment variable file from Amazon S3.
This isn't available for Windows containers and Windows container on Fargate
You can specify up to 10 environment files. The file must have a
.env
file extension. Each line in an environment file contains an environment variable inVARIABLE=VALUE
format. Lines that start with#
are treated as comments and are ignored.If there are individual environment variables specified in the container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they're processed from the top down. We recommend that you use unique variable names. For more information, see Pass an individual environment variable to an Amazon ECS container.
value
-
Type: String
Required: Yes
The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file.
type
-
Type: String
Required: Yes
The file type to use. The only supported value is
s3
.
environment
-
Type: Object array
Required: No
The environment variables to pass to a container. This parameter maps to
Env
in the docker create-container command and the--env
option to the docker run command.Important
We do not recommend using plaintext environment variables for sensitive information, such as credential data.
name
-
Type: String
Required: Yes, when
environment
is usedThe name of the environment variable.
value
-
Type: String
Required: Yes, when
environment
is usedThe value of the environment variable.
"environment" : [ { "name" : "string", "value" : "string" }, { "name" : "string", "value" : "string" } ]
secrets
-
Type: Object array
Required: No
An object that represents the secret to expose to your container. For more information, see Pass sensitive data to an Amazon ECS container.
name
-
Type: String
Required: Yes
The value to set as the environment variable on the container.
valueFrom
-
Type: String
Required: Yes
The secret to expose to the container. The supported values are either the full Amazon Resource Name (ARN) of the AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store.
Note
If the Systems Manager Parameter Store parameter or Secrets Manager parameter exists in the same AWS Region as the task that you're launching, you can use either the full ARN or name of the secret. If the parameter exists in a different Region, then the full ARN must be specified.
"secrets": [ { "name": "environment_variable_name", "valueFrom": "arn:aws:ssm:
region
:aws_account_id
:parameter/parameter_name
" } ]
Network settings
disableNetworking
-
Type: Boolean
Required: No
When this parameter is true, networking is off within the container.
Note
This parameter isn't supported for Windows containers or tasks using the
awsvpc
network mode.The default is
false
."disableNetworking": true|false
links
-
Type: String array
Required: No
The
link
parameter allows containers to communicate with each other without the need for port mappings. This parameter is only supported if the network mode of a task definition is set tobridge
. Thename:internalName
construct is analogous toname:alias
in Docker links. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed..Note
This parameter isn't supported for Windows containers or tasks using the
awsvpc
network mode.Important
Containers that are collocated on the same container instance might communicate with each other without requiring links or host port mappings. The network isolation on a container instance is controlled by security groups and VPC settings.
"links": ["name:internalName", ...]
hostname
-
Type: String
Required: No
The hostname to use for your container. This parameter maps to
Hostname
in the docker create-container and the--hostname
option to docker run.Note
If you're using the
awsvpc
network mode, thehostname
parameter isn't supported."hostname": "string"
dnsServers
-
Type: String array
Required: No
A list of DNS servers that are presented to the container.
Note
This parameter isn't supported for Windows containers or tasks using the
awsvpc
network mode."dnsServers": ["string", ...]
dnsSearchDomains
-
Type: String array
Required: No
Pattern: ^[a-zA-Z0-9-.]{0,253}[a-zA-Z0-9]$
A list of DNS search domains that are presented to the container. This parameter maps to
DnsSearch
in the docker create-container command the--dns-search
option to docker run.Note
This parameter isn't supported for Windows containers or tasks that use the
awsvpc
network mode."dnsSearchDomains": ["string", ...]
extraHosts
-
Type: Object array
Required: No
A list of hostnames and IP address mappings to append to the
/etc/hosts
file on the container.This parameter maps to
ExtraHosts
in the docker create-container command and the--add-host
option to docker run.Note
This parameter isn't supported for Windows containers or tasks that use the
awsvpc
network mode."extraHosts": [ { "hostname": "string", "ipAddress": "string" } ... ]
hostname
-
Type: String
Required: Yes, when
extraHosts
are usedThe hostname to use in the
/etc/hosts
entry. ipAddress
-
Type: String
Required: Yes, when
extraHosts
are usedThe IP address to use in the
/etc/hosts
entry.
Storage and logging
readonlyRootFilesystem
-
Type: Boolean
Required: No
When this parameter is true, the container is given read-only access to its root file system. This parameter maps to
ReadonlyRootfs
in the docker create-container command the--read-only
option to docker run.Note
This parameter is not supported for Windows containers.
The default is
false
."readonlyRootFilesystem": true|false
mountPoints
-
Type: Object array
Required: No
The mount points for the data volumes in your container. This parameter maps to
Volumes
in the creat-container Docker API and the--volume
option to docker run.Windows containers can mount whole directories on the same drive as
$env:ProgramData
. Windows containers cannot mount directories on a different drive, and mount points cannot be used across drives. You must specify mount points to attach an Amazon EBS volume directly to an Amazon ECS task.sourceVolume
-
Type: String
Required: Yes, when
mountPoints
are usedThe name of the volume to mount.
containerPath
-
Type: String
Required: Yes, when
mountPoints
are usedThe path in the container where the volume will be mounted.
readOnly
-
Type: Boolean
Required: No
If this value is
true
, the container has read-only access to the volume. If this value isfalse
, then the container can write to the volume. The default value isfalse
.
volumesFrom
-
Type: Object array
Required: No
Data volumes to mount from another container. This parameter maps to
VolumesFrom
in the docker create-container command and the--volumes-from
option to docker run.sourceContainer
-
Type: String
Required: Yes, when
volumesFrom
is usedThe name of the container to mount volumes from.
readOnly
-
Type: Boolean
Required: No
If this value is
true
, the container has read-only access to the volume. If this value isfalse
, then the container can write to the volume. The default value isfalse
.
"volumesFrom": [ { "sourceContainer": "string", "readOnly": true|false } ]
logConfiguration
-
Type: LogConfiguration Object
Required: No
The log configuration specification for the container.
For example task definitions that use a log configuration, see Example Amazon ECS task definitions.
This parameter maps to
LogConfig
in the docker create-container command and the--log-driver
option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However, the container might 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).Consider the following when specifying a log configuration for your containers:
-
Amazon ECS supports a subset of the logging drivers that are available to the Docker daemon. Additional log drivers might be available in future releases of the Amazon ECS container agent.
-
This parameter requires version 1.18 or later of the Docker Remote API on your container instance.
-
For tasks that use the EC2 launch type, the Amazon ECS container agent that runs on a container instance must register the logging drivers that are available on that instance with the
ECS_AVAILABLE_LOGGING_DRIVERS
environment variable before containers that are placed on that instance can use these log configuration options. For more information, see Amazon ECS container agent configuration. -
For tasks that use the Fargate launch type, you must install any additional software outside of the task. For example, the Fluentd output aggregators or a remote host running Logstash to send Gelf logs to.
"logConfiguration": { "logDriver": "awslogs","fluentd","gelf","json-file","journald","logentries","splunk","syslog","awsfirelens", "options": {"
string
": "string
" ...}, "secretOptions": [{ "name": "string
", "valueFrom": "string
" }] }logDriver
-
Type: String
Valid values:
"awslogs","fluentd","gelf","json-file","journald","logentries","splunk","syslog","awsfirelens"
Required: Yes, when
logConfiguration
is usedThe log driver to use for the container. By default, the valid values that are listed earlier are log drivers that the Amazon ECS container agent can communicate with.
For tasks that use the Fargate launch type, the supported log drivers are
awslogs
,splunk
, andawsfirelens
.For tasks that use the EC2 launch type, the supported log drivers are
awslogs
,fluentd
,gelf
,json-file
,journald
,logentries
,syslog
,splunk
, andawsfirelens
.For more information about how to use the
awslogs
log driver in task definitions to send your container logs to CloudWatch Logs, see Send Amazon ECS logs to CloudWatch .For more information about using the
awsfirelens
log driver, see Custom Log Routing.Note
If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's available on GitHub
and customize it to work with that driver. We encourage you to submit pull requests for changes that you want to have included. However, we don't currently support running modified copies of this software. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance.
options
-
Type: String to string map
Required: No
The key/value map of configuration options to send to the log driver.
The options you can specify depend on the log driver. Some of the options you can specify when you use the
awslogs
router to route logs to Amazon CloudWatch include the following:awslogs-create-group
-
Required: No
Specify whether you want the log group to be created automatically. If this option isn't specified, it defaults to
false
.Note
Your IAM policy must include the
logs:CreateLogGroup
permission before you attempt to useawslogs-create-group
. awslogs-region
-
Required: Yes
Specify the AWS Region that the
awslogs
log driver is to send your Docker logs to. You can choose to send all of your logs from clusters in different Regions to a single region in CloudWatch Logs. This is so that they're all visible in one location. Otherwise, you can separate them by Region for more granularity. Make sure that the specified log group exists in the Region that you specify with this option. awslogs-group
-
Required: Yes
Make sure to specify a log group that the
awslogs
log driver sends its log streams to. awslogs-stream-prefix
-
Required: Optional for the EC2 launch type, required for the Fargate launch type.
Use the
awslogs-stream-prefix
option to associate a log stream with the specified prefix, the container name, and the ID of the Amazon ECS task that the container belongs to. If you specify a prefix with this option, then the log stream takes the following format.prefix-name
/container-name
/ecs-task-id
If you don't specify a prefix with this option, then the log stream is named after the container ID that's assigned by the Docker daemon on the container instance. Because it's difficult to trace logs back to the container that sent them with just the Docker container ID (which is only available on the container instance), we recommend that you specify a prefix with this option.
For Amazon ECS services, you can use the service name as the prefix. Doing so, you can trace log streams to the service that the container belongs to, the name of the container that sent them, and the ID of the task that the container belongs to.
You must specify a stream-prefix for your logs to have your logs appear in the Log pane when using the Amazon ECS console.
awslogs-datetime-format
-
Required: No
This option defines a multiline start pattern in Python
strftime
format. A log message consists of a line that matches the pattern and any following lines that don’t match the pattern. The matched line is the delimiter between log messages.One example of a use case for using this format is for parsing output such as a stack dump, which might otherwise be logged in multiple entries. The correct pattern allows it to be captured in a single entry.
For more information, see awslogs-datetime-format
. You cannot configure both the
awslogs-datetime-format
andawslogs-multiline-pattern
options.Note
Multiline logging performs regular expression parsing and matching of all log messages. This might have a negative impact on logging performance.
awslogs-multiline-pattern
-
Required: No
This option defines a multiline start pattern that uses a regular expression. A log message consists of a line that matches the pattern and any following lines that don’t match the pattern. The matched line is the delimiter between log messages.
For more information, see awslogs-multiline-pattern
. This option is ignored if
awslogs-datetime-format
is also configured.You cannot configure both the
awslogs-datetime-format
andawslogs-multiline-pattern
options.Note
Multiline logging performs regular expression parsing and matching of all log messages. This might have a negative impact on logging performance.
mode
-
Required: No
Valid values:
non-blocking
|blocking
This option defines the delivery mode of log messages from the container to CloudWatch Logs. The delivery mode you choose affects application availability when the flow of logs from container to CloudWatch is interrupted.
If you use the
blocking
mode and the flow of logs to CloudWatch is interrupted, calls from container code to write to thestdout
andstderr
streams will block. The logging thread of the application will block as a result. This may cause the application to become unresponsive and lead to container healthcheck failure.If you use the
non-blocking
mode, the container's logs are instead stored in an in-memory intermediate buffer configured with themax-buffer-size
option. This prevents the application from becoming unresponsive when logs cannot be sent to CloudWatch. We recommend using this mode if you want to ensure service availability and are okay with some log loss. For more information, see Preventing log loss with non-blocking mode in theawslogs
container log driver. max-buffer-size
-
Required: No
Default value:
1m
When
non-blocking
mode is used, themax-buffer-size
log option controls the size of the buffer that's used for intermediate message storage. Make sure to specify an adequate buffer size based on your application. When the buffer fills up, further logs cannot be stored. Logs that cannot be stored are lost.
To route logs using the
splunk
log router, you need to specify asplunk-token
and asplunk-url
.When you use the
awsfirelens
log router to route logs to an AWS service or AWS Partner Network destination for log storage and analytics, you can set thelog-driver-buffer-limit
option to limit the number of events that are buffered in memory, before being sent to the log router container. It can help to resolve potential log loss issue because high throughput might result in memory running out for the buffer inside of Docker. For more information, see Configuring Amazon ECS logs for high throughput.Other options you can specify when using
awsfirelens
to route logs depend on the destination. When you export logs to Amazon Data Firehose, you can specify the AWS Region withregion
and a name for the log stream withdelivery_stream
.When you export logs to Amazon Kinesis Data Streams, you can specify an AWS Region with
region
and a data stream name withstream
.When you export logs to Amazon OpenSearch Service, you can specify options like
Name
,Host
(OpenSearch Service endpoint without protocol),Port
,Index
,Type
,Aws_auth
,Aws_region
,Suppress_Type_Name
, andtls
.When you export logs to Amazon S3, you can specify the bucket using the
bucket
option. You can also specifyregion
,total_file_size
,upload_timeout
, anduse_put_object
as options.This parameter requires version 1.19 of the Docker Remote API or greater on your container instance.
secretOptions
-
Type: Object array
Required: No
An object that represents the secret to pass to the log configuration. Secrets that are used in log configuration can include an authentication token, certificate, or encryption key. For more information, see Pass sensitive data to an Amazon ECS container.
name
-
Type: String
Required: Yes
The value to set as the environment variable on the container.
valueFrom
-
Type: String
Required: Yes
The secret to expose to the log configuration of the container.
"logConfiguration": { "logDriver": "splunk", "options": { "splunk-url": "https://cloud.splunk.com:8080", "splunk-token": "...", "tag": "...", ... }, "secretOptions": [{ "name": "
splunk-token
", "valueFrom": "/ecs/logconfig/splunkcred
" }] }
-
firelensConfiguration
-
Type: FirelensConfiguration Object
Required: No
The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Send Amazon ECS logs to an AWS service or AWS Partner.
{ "firelensConfiguration": { "type": "fluentd", "options": { "KeyName": "" } } }
options
-
Type: String to string map
Required: No
The key/value map of options to use when configuring the log router. This field is optional and can be used to specify a custom configuration file or to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. If specified, the syntax to use is
"options":{"enable-ecs-log-metadata":"true|false","config-file-type:"s3|file","config-file-value":"arn:aws:s3:::
. For more information, see Example Amazon ECS task definition: Route logs to FireLens.amzn-s3-demo-bucket
/fluent.conf|filepath"} type
-
Type: String
Required: Yes
The log router to use. The valid values are
fluentd
orfluentbit
.
Security
For more information about container security, see Task and container security in the Amazon ECS Best Practices Guide.
credentialSpecs
-
Type: String array
Required: No
A list of ARNs in SSM or Amazon S3 to a credential spec (
CredSpec
) file that configures the container for Active Directory authentication. We recommend that you use this parameter instead of thedockerSecurityOptions
. The maximum number of ARNs is 1.There are two formats for each ARN.
- credentialspecdomainless:MyARN
-
You use
credentialspecdomainless:MyARN
to provide aCredSpec
with an additional section for a secret in Secrets Manager. You provide the login credentials to the domain in the secret.Each task that runs on any container instance can join different domains.
You can use this format without joining the container instance to a domain.
- credentialspec:MyARN
-
You use
credentialspec:MyARN
to provide aCredSpec
for a single domain.You must join the container instance to the domain before you start any tasks that use this task definition.
In both formats, replace
MyARN
with the ARN in SSM or Amazon S3.The
credspec
must provide a ARN in Secrets Manager for a secret containing the username, password, and the domain to connect to. For better security, the instance isn't joined to the domain for domainless authentication. Other applications on the instance can't use the domainless credentials. You can use this parameter to run tasks on the same instance, even it the tasks need to join different domains. For more information, see Using gMSAs for Windows Containers and Using gMSAs for Linux Containers. privileged
-
Type: Boolean
Required: No
When this parameter is true, the container is given elevated privileges on the host container instance (similar to the
root
user). We recommend against running containers withprivileged
. In most cases, you can specify the exact privileges that you need by using the specific parameters instead of usingprivileged
.This parameter maps to
Privileged
in the docker create-container command and the--privileged
option to docker run.Note
This parameter is not supported for Windows containers or tasks using the Fargate launch type.
The default is
false
."privileged": true|false
user
-
Type: String
Required: No
The user to use inside the container. This parameter maps to
User
in the docker create-container command and the--user
option to docker run.Important
When running tasks that use the
host
network mode, don't run containers using the root user (UID 0). As a security best practice, always use a non-root user.You can specify the
user
using the following formats. If specifying a UID or GID, you must specify it as a positive integer.-
user
-
user:group
-
uid
-
uid:gid
-
user:gid
-
uid:group
Note
This parameter is not supported for Windows containers.
"user": "string"
-
dockerSecurityOptions
-
Type: String array
Valid values: "no-new-privileges" | "apparmor:PROFILE" | "label:
value
" | "credentialspec:CredentialSpecFilePath
"Required: No
A list of strings to provide custom configuration for multiple security systems. This field isn't valid for containers in tasks using the Fargate launch type.
For Linux tasks on EC2, this parameter can be used to reference custom labels for SELinux and AppArmor multi-level security systems.
For any tasks on EC2, this parameter can be used to reference a credential spec file that configures a container for Active Directory authentication. For more information, see Learn how to use gMSAs for EC2 Windows containers for Amazon ECS and Using gMSA for EC2 Linux containers on Amazon ECS.
This parameter maps to
SecurityOpt
in the docker create-container command and the--security-opt
option to docker run."dockerSecurityOptions": ["string", ...]
Note
The Amazon ECS container agent that run on a container instance must register with the
ECS_SELINUX_CAPABLE=true
orECS_APPARMOR_CAPABLE=true
environment variables before containers that are placed on that instance can use these security options. For more information, see Amazon ECS container agent configuration.
Resource limits
ulimits
-
Type: Object array
Required: No
A list of
ulimit
values to define for a container. This value overwrites the default resource quota setting for the operating system. This parameter maps toUlimits
in the docker create-container command and the--ulimit
option to docker run.Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating system with the exception of the
nofile
resource limit parameter. Thenofile
resource limit sets a restriction on the number of open files that a container can use. On Fargate, the defaultnofile
soft limit is65535
and hard limit is65535
. You can set the values of both limits up to1048576
. For more information, see Task resource limits.This parameter requires version 1.18 of the Docker Remote API or greater on your container instance.
Note
This parameter is not supported for Windows containers.
"ulimits": [ { "name": "core"|"cpu"|"data"|"fsize"|"locks"|"memlock"|"msgqueue"|"nice"|"nofile"|"nproc"|"rss"|"rtprio"|"rttime"|"sigpending"|"stack", "softLimit": integer, "hardLimit": integer } ... ]
name
-
Type: String
Valid values:
"core" | "cpu" | "data" | "fsize" | "locks" | "memlock" | "msgqueue" | "nice" | "nofile" | "nproc" | "rss" | "rtprio" | "rttime" | "sigpending" | "stack"
Required: Yes, when
ulimits
are usedThe
type
of theulimit
. hardLimit
-
Type: Integer
Required: Yes, when
ulimits
are usedThe hard limit for the
ulimit
type. The value can be specified in bytes, seconds, or as a count, depending on thetype
of theulimit
. softLimit
-
Type: Integer
Required: Yes, when
ulimits
are usedThe soft limit for the
ulimit
type. The value can be specified in bytes, seconds, or as a count, depending on thetype
of theulimit
.
Docker labels
dockerLabels
-
Type: String to string map
Required: No
A key/value map of labels to add to the container. This parameter maps to
Labels
in the docker create-container command and the--label
option to docker run.This parameter requires version 1.18 of the Docker Remote API or greater on your container instance.
"dockerLabels": {"string": "string" ...}
Other container definition parameters
The following container definition parameters can be used when registering task definitions in the Amazon ECS console by using the Configure via JSON option. For more information, see Creating an Amazon ECS task definition using the console.
Topics
Linux parameters
linuxParameters
-
Type: LinuxParameters object
Required: No
Linux-specific options that are applied to the container, such as KernelCapabilities.
Note
This parameter isn't supported for Windows containers.
"linuxParameters": { "capabilities": { "add": ["string", ...], "drop": ["string", ...] } }
capabilities
-
Type: KernelCapabilities object
Required: No
The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker. For more information about these Linux capabilities, see the capabilities(7)
Linux manual page. add
-
Type: String array
Valid values:
"ALL" | "AUDIT_CONTROL" | "AUDIT_READ" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"
Required: No
The Linux capabilities for the container to add to the default configuration provided by Docker. This parameter maps to
CapAdd
in the docker create-container command and the--cap-add
option to docker run.Note
Tasks that are launched on Fargate only support adding the
SYS_PTRACE
kernel capability. add
-
Type: String array
Valid values:
"SYS_PTRACE"
Required: No
The Linux capabilities for the container to add to the default configuration that's provided by Docker. This parameter maps to
CapAdd
in the docker create-container command and the--cap-add
option to docker run. drop
-
Type: String array
Valid values:
"ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"
Required: No
The Linux capabilities for the container to remove from the default configuration that's provided by Docker. This parameter maps to
CapDrop
in the docker create-container command and the--cap-drop
option to docker run.
devices
-
Any host devices to expose to the container. This parameter maps to
Devices
in the docker create-container command and the--device
option to docker run.Note
The
devices
parameter isn't supported when you use the Fargate launch type, or Windows containers.Type: Array of Device objects
Required: No
hostPath
-
The path for the device on the host container instance.
Type: String
Required: Yes
containerPath
-
The path inside the container to expose the host device at.
Type: String
Required: No
permissions
-
The explicit permissions to provide to the container for the device. By default, the container has permissions for
read
,write
, andmknod
on the device.Type: Array of strings
Valid Values:
read
|write
|mknod
initProcessEnabled
-
Run an
init
process inside the container that forwards signals and reaps processes. This parameter maps to the--init
option to docker run.This parameter requires version 1.25 of the Docker Remote API or greater on your container instance.
maxSwap
-
The total amount of swap memory (in MiB) a container can use. This parameter is translated to the
--memory-swap
option to docker run where the value is the sum of the container memory plus themaxSwap
value.If a
maxSwap
value of0
is specified, the container doesn't use swap. Accepted values are0
or any positive integer. If themaxSwap
parameter is omitted, the container uses the swap configuration for the container instance that it's running on. AmaxSwap
value must be set for theswappiness
parameter to be used.Note
If you're using tasks that use the Fargate launch type, the
maxSwap
parameter isn't supported. sharedMemorySize
-
The value for the size (in MiB) of the
/dev/shm
volume. This parameter maps to the--shm-size
option to docker run.Note
If you're using tasks that use the Fargate launch type, the
sharedMemorySize
parameter isn't supported.Type: Integer
swappiness
-
You can use this parameter to tune a container's memory swappiness behavior. A
swappiness
value of0
prevents swapping from happening unless required. Aswappiness
value of100
causes pages to be swapped frequently. Accepted values are whole numbers between0
and100
. If you don't specify a value, the default value of60
is used. Moreover, if you don't specify a value formaxSwap
, then this parameter is ignored. This parameter maps to the--memory-swappiness
option to docker run.Note
If you're using tasks that use the Fargate launch type, the
swappiness
parameter isn't supported.If you're using tasks on Amazon Linux 2023 the
swappiness
parameter isn't supported. tmpfs
-
The container path, mount options, and maximum size (in MiB) of the tmpfs mount. This parameter maps to the
--tmpfs
option to docker run.Note
If you're using tasks that use the Fargate launch type, the
tmpfs
parameter isn't supported.Type: Array of Tmpfs objects
Required: No
containerPath
-
The absolute file path where the tmpfs volume is to be mounted.
Type: String
Required: Yes
mountOptions
-
The list of tmpfs volume mount options.
Type: Array of strings
Required: No
Valid Values:
"defaults" | "ro" | "rw" | "suid" | "nosuid" | "dev" | "nodev" | "exec" | "noexec" | "sync" | "async" | "dirsync" | "remount" | "mand" | "nomand" | "atime" | "noatime" | "diratime" | "nodiratime" | "bind" | "rbind" | "unbindable" | "runbindable" | "private" | "rprivate" | "shared" | "rshared" | "slave" | "rslave" | "relatime" | "norelatime" | "strictatime" | "nostrictatime" | "mode" | "uid" | "gid" | "nr_inodes" | "nr_blocks" | "mpol"
size
-
The maximum size (in MiB) of the tmpfs volume.
Type: Integer
Required: Yes
Container dependency
dependsOn
-
Type: Array of ContainerDependency objects
Required: No
The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed. For an example, see Container dependency.
Note
If a container doesn't meet a dependency constraint or times out before meeting the constraint, Amazon ECS doesn't progress dependent containers to their next state.
For Amazon ECS tasks that are hosted on Amazon EC2 instances, the instances require at least version
1.26.0
of the container agent to enable container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS container agent. If you're using an Amazon ECS-optimized Amazon Linux AMI, your instance needs at least version1.26.0-1
of theecs-init
package. If your container instances are launched from version20190301
or later, they contain the required versions of the container agent andecs-init
. For more information, see Amazon ECS-optimized Linux AMIs.For Amazon ECS tasks that are hosted on Fargate, this parameter requires that the task or service uses platform version
1.3.0
or later (Linux) or1.0.0
(Windows)."dependsOn": [ { "containerName": "
string
", "condition": "string
" } ]containerName
-
Type: String
Required: Yes
The container name that must meet the specified condition.
condition
-
Type: String
Required: Yes
The dependency condition of the container. The following are the available conditions and their behavior:
-
START
– This condition emulates the behavior of links and volumes today. The condition validates that a dependent container is started before permitting other containers to start. -
COMPLETE
– This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for non-essential containers that run a script and then exit. This condition can't be set on an essential container. -
SUCCESS
– This condition is the same asCOMPLETE
, but it also requires that the container exits with azero
status. This condition can't be set on an essential container. -
HEALTHY
– This condition validates that the dependent container passes its container health check before permitting other containers to start. This requires that the dependent container has health checks configured in the task definition. This condition is confirmed only at task startup.
-
Container timeouts
startTimeout
-
Type: Integer
Required: No
Example values:
120
Time duration (in seconds) to wait before giving up on resolving dependencies for a container.
For example, you specify two containers in a task definition with
containerA
having a dependency oncontainerB
reaching aCOMPLETE
,SUCCESS
, orHEALTHY
status. If astartTimeout
value is specified forcontainerB
and it doesn't reach the desired status within that time, thencontainerA
doesn't start.Note
If a container doesn't meet a dependency constraint or times out before meeting the constraint, Amazon ECS doesn't progress dependent containers to their next state.
For Amazon ECS tasks that are hosted on Fargate, this parameter requires that the task or service uses platform version
1.3.0
or later (Linux). The maximum value is 120 seconds. stopTimeout
-
Type: Integer
Required: No
Example values:
120
Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own.
For Amazon ECS tasks that are hosted on Fargate, this parameter requires that the task or service uses platform version
1.3.0
or later (Linux). If the parameter isn't specified, then the default value of 30 seconds is used. The maximum value for Fargate is 120 seconds.For tasks that use the EC2 launch type, if the
stopTimeout
parameter isn't specified, the value set for the Amazon ECS container agent configuration variableECS_CONTAINER_STOP_TIMEOUT
is used. If neither thestopTimeout
parameter or theECS_CONTAINER_STOP_TIMEOUT
agent configuration variable is set, the default values of 30 seconds for Linux containers and 30 seconds on Windows containers are used. Container instances require at least version 1.26.0 of the container agent to enable a container stop timeout value. However, we recommend using the latest container agent version. For information about how to check your agent version and update to the latest version, see Updating the Amazon ECS container agent. If you're using an Amazon ECS-optimized Amazon Linux AMI, your instance needs at least version 1.26.0-1 of theecs-init
package. If your container instances are launched from version20190301
or later, they contain the required versions of the container agent andecs-init
. For more information, see Amazon ECS-optimized Linux AMIs.
System controls
systemControls
-
Type: SystemControl object
Required: No
A list of namespace kernel parameters to set in the container. This parameter maps to
Sysctls
in the docker create-container commandand the--sysctl
option to docker run. For example, you can configurenet.ipv4.tcp_keepalive_time
setting to maintain longer lived connections.We don't recommend that you specify network-related
systemControls
parameters for multiple containers in a single task that also uses either theawsvpc
orhost
network mode. Doing this has the following disadvantages:-
For tasks that use the
awsvpc
network mode including Fargate, if you setsystemControls
for any container, it applies to all containers in the task. If you set differentsystemControls
for multiple containers in a single task, the container that's started last determines whichsystemControls
take effect. -
For tasks that use the
host
network mode, the network namespacesystemControls
aren't supported.
If you're setting an IPC resource namespace to use for the containers in the task, the following conditions apply to your system controls. For more information, see IPC mode.
-
For tasks that use the
host
IPC mode, IPC namespacesystemControls
aren't supported. -
For tasks that use the
task
IPC mode, IPC namespacesystemControls
values apply to all containers within a task.
Note
This parameter is not supported for Windows containers.
Note
This parameter is only supported for tasks that are hosted on AWS Fargate if the tasks are using platform version
1.4.0
or later (Linux). This isn't supported for Windows containers on Fargate."systemControls": [ { "namespace":"
string
", "value":"string
" } ]namespace
-
Type: String
Required: No
The namespace kernel parameter to set a
value
for.Valid IPC namespace values:
"kernel.msgmax" | "kernel.msgmnb" | "kernel.msgmni" | "kernel.sem" | "kernel.shmall" | "kernel.shmmax" | "kernel.shmmni" | "kernel.shm_rmid_forced"
, andSysctls
that start with"fs.mqueue.*"
Valid network namespace values:
Sysctls
that start with"net.*"
All of these values are supported by Fargate.
value
-
Type: String
Required: No
The value for the namespace kernel parameter that's specified in
namespace
.
-
Interactive
interactive
-
Type: Boolean
Required: No
When this parameter is
true
, you can deploy containerized applications that requirestdin
or atty
to be allocated. This parameter maps toOpenStdin
in the docker create-container command and the--interactive
option to docker run.The default is
false
.
Pseudo terminal
pseudoTerminal
-
Type: Boolean
Required: No
When this parameter is
true
, a TTY is allocated. This parameter maps toTty
in the docker create-container command and the--tty
option todocker run.The default is
false
.
Elastic Inference accelerator name
Note
Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
The Elastic Inference accelerator resource requirement for your task definition. For more information, see What Is Amazon Elastic Inference? in the Amazon Elastic Inference Developer Guide.
The following parameters are allowed in a task definition:
deviceName
-
Type: String
Required: Yes
The Elastic Inference accelerator device name. The
deviceName
must also be referenced in a container definition see Elastic Inference accelerator. deviceType
-
Type: String
Required: Yes
The Elastic Inference accelerator to use.
Task placement constraints
When you register a task definition, you can provide task placement constraints that customize how Amazon ECS places tasks.
If you're using the Fargate launch type, task placement constraints aren't supported. By default Fargate tasks are spread across Availability Zones.
For tasks that use the EC2 launch type, you can use constraints to place tasks based on Availability Zone, instance type, or custom attributes. For more information, see Define which container instances Amazon ECS uses for tasks.
The following parameters are allowed in a container definition:
expression
-
Type: String
Required: No
A cluster query language expression to apply to the constraint. For more information, see Create expressions to define container instances for Amazon ECS tasks.
type
-
Type: String
Required: Yes
The type of constraint. Use
memberOf
to restrict the selection to a group of valid candidates.
Proxy configuration
proxyConfiguration
-
Type: ProxyConfiguration object
Required: No
The configuration details for the App Mesh proxy.
For tasks that use the EC2 launch type, the container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the
ecs-init
package to enable a proxy configuration. If your container instances are launched from the Amazon ECS-optimized AMI version20190301
or later, then they contain the required versions of the container agent andecs-init
. For more information, see Amazon ECS-optimized Linux AMIs.For tasks that use the Fargate launch type, this feature requires that the task or service uses platform version 1.3.0 or later.
Note
This parameter is not supported for Windows containers.
"proxyConfiguration": { "type": "APPMESH", "containerName": "
string
", "properties": [ { "name": "string
", "value": "string
" } ] }type
-
Type: String
Value values:
APPMESH
Required: No
The proxy type. The only supported value is
APPMESH
. containerName
-
Type: String
Required: Yes
The name of the container that serves as the App Mesh proxy.
properties
-
Type: Array of KeyValuePair objects
Required: No
The set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified as key-value pairs.
-
IgnoredUID
– (Required) The user ID (UID) of the proxy container as defined by theuser
parameter in a container definition. This is used to ensure the proxy ignores its own traffic. IfIgnoredGID
is specified, this field can be empty. -
IgnoredGID
– (Required) The group ID (GID) of the proxy container as defined by theuser
parameter in a container definition. This is used to ensure the proxy ignores its own traffic. IfIgnoredUID
is specified, this field can be empty. -
AppPorts
– (Required) The list of ports that the application uses. Network traffic to these ports is forwarded to theProxyIngressPort
andProxyEgressPort
. -
ProxyIngressPort
– (Required) Specifies the port that incoming traffic to theAppPorts
is directed to. -
ProxyEgressPort
– (Required) Specifies the port that outgoing traffic from theAppPorts
is directed to. -
EgressIgnoredPorts
– (Required) The outbound traffic going to these specified ports is ignored and not redirected to theProxyEgressPort
. It can be an empty list. -
EgressIgnoredIPs
– (Required) The outbound traffic going to these specified IP addresses is ignored and not redirected to theProxyEgressPort
. It can be an empty list.
name
-
Type: String
Required: No
The name of the key-value pair.
value
-
Type: String
Required: No
The value of the key-value pair.
-
Volumes
When you register a task definition, you can optionally specify a list of volumes to be passed to the Docker daemon on a container instance, which then becomes available for access by other containers on the same container instance.
The following are the types of data volumes that can be used:
-
Amazon EBS volumes — Provides cost-effective, durable, high-performance block storage for data intensive containerized workloads. You can attach 1 Amazon EBS volume per Amazon ECS task when running a standalone task, or when creating or updating a service. Amazon EBS volumes are supported for Linux tasks hosted on Fargate or Amazon EC2 instances. For more information, see Use Amazon EBS volumes with Amazon ECS.
-
Amazon EFS volumes — Provides simple, scalable, and persistent file storage for use with your Amazon ECS tasks. With Amazon EFS, storage capacity is elastic. It grows and shrinks automatically as you add and remove files. Your applications can have the storage that they need and when they need it. Amazon EFS volumes are supported for tasks that are hosted on Fargate or Amazon EC2 instances. For more information, see Use Amazon EFS volumes with Amazon ECS.
-
FSx for Windows File Server volumes — Provides fully managed Microsoft Windows file servers. These file servers are backed by a Windows file system. When using FSx for Windows File Server together with Amazon ECS, you can provision your Windows tasks with persistent, distributed, shared, and static file storage. For more information, see Use FSx for Windows File Server volumes with Amazon ECS.
Windows containers on Fargate do not support this option.
-
Docker volumes – A Docker-managed volume that is created under
/var/lib/docker/volumes
on the host Amazon EC2 instance. Docker volume drivers (also referred to as plugins) are used to integrate the volumes with external storage systems, such as Amazon EBS. The built-inlocal
volume driver or a third-party volume driver can be used. Docker volumes are supported only when running tasks on Amazon EC2 instances. Windows containers support only the use of thelocal
driver. To use Docker volumes, specify adockerVolumeConfiguration
in your task definition. -
Bind mounts – A file or directory on the host machine that is mounted into a container. Bind mount host volumes are supported when running tasks on either AWS Fargate or Amazon EC2 instances. To use bind mount host volumes, specify a
host
and optionalsourcePath
value in your task definition.
For more information, see Storage options for Amazon ECS tasks.
The following parameters are allowed in a container definition.
name
-
Type: String
Required: No
The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens (
-
), and underscores (_
) are allowed. This name is referenced in thesourceVolume
parameter of the container definitionmountPoints
object. host
-
Required: No
The
host
parameter is used to tie the lifecycle of the bind mount to the host Amazon EC2 instance, rather than the task, and where it is stored. If thehost
parameter is empty, then the Docker daemon assigns a host path for your data volume, but the data is not guaranteed to persist after the containers associated with it stop running.Windows containers can mount whole directories on the same drive as
$env:ProgramData
.Note
The
sourcePath
parameter is supported only when using tasks that are hosted on Amazon EC2 instances.sourcePath
-
Type: String
Required: No
When the
host
parameter is used, specify asourcePath
to declare the path on the host Amazon EC2 instance that is presented to the container. If this parameter is empty, then the Docker daemon assigns a host path for you. If thehost
parameter contains asourcePath
file location, then the data volume persists at the specified location on the host Amazon EC2 instance until you delete it manually. If thesourcePath
value does not exist on the host Amazon EC2 instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.
configuredAtLaunch
-
Type: Boolean
Required: No
Specifies whether a volume is configurable at launch. When set to
true
, you can configure the volume when running a standalone task, or when creating or updating a service. When set totrue
, you won't be able to provide another volume configuration in the task definition. This parameter must be set totrue
to configure an Amazon EBS volume for attachment to a task. SettingconfiguredAtLaunch
totrue
and deferring volume configuration to the launch phase allows you to create task definitions that aren't constrained to a volume type or to specific volume settings. Doing this makes your task definition reusable across different execution environments. For more information, see Amazon EBS volumes. dockerVolumeConfiguration
-
Type: DockerVolumeConfiguration Object
Required: No
This parameter is specified when using Docker volumes. Docker volumes are supported only when running tasks on EC2 instances. Windows containers support only the use of the
local
driver. To use bind mounts, specify ahost
instead.scope
-
Type: String
Valid Values:
task
|shared
Required: No
The scope for the Docker volume, which determines its lifecycle. Docker volumes that are scoped to a
task
are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped asshared
persist after the task stops. autoprovision
-
Type: Boolean
Default value:
false
Required: No
If this value is
true
, the Docker volume is created if it doesn't already exist. This field is used only if thescope
isshared
. If thescope
istask
, then this parameter must be omitted. driver
-
Type: String
Required: No
The Docker volume driver to use. The driver value must match the driver name provided by Docker because this name is used for task placement. If the driver was installed by using the Docker plugin CLI, use
docker plugin ls
to retrieve the driver name from your container instance. If the driver was installed by using another method, use Docker plugin discovery to retrieve the driver name. driverOpts
-
Type: String
Required: No
A map of Docker driver-specific options to pass through. This parameter maps to
DriverOpts
in the Create a volume section of Docker. labels
-
Type: String
Required: No
Custom metadata to add to your Docker volume.
efsVolumeConfiguration
-
Type: EFSVolumeConfiguration Object
Required: No
This parameter is specified when using Amazon EFS volumes.
fileSystemId
-
Type: String
Required: Yes
The Amazon EFS file system ID to use.
rootDirectory
-
Type: String
Required: No
The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume will be used. Specifying
/
has the same effect as omitting this parameter.Important
If an EFS access point is specified in the
authorizationConfig
, the root directory parameter must either be omitted or set to/
, which will enforce the path set on the EFS access point. transitEncryption
-
Type: String
Valid values:
ENABLED
|DISABLED
Required: No
Specifies whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. If Amazon EFS IAM authorization is used, transit encryption must be enabled. If this parameter is omitted, the default value of
DISABLED
is used. For more information, see Encrypting Data in Transit in the Amazon Elastic File System User Guide. transitEncryptionPort
-
Type: Integer
Required: No
The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you don't specify a transit encryption port, the task will use the port selection strategy that the Amazon EFS mount helper uses. For more information, see EFS Mount Helper in the Amazon Elastic File System User Guide.
authorizationConfig
-
Type: EFSAuthorizationConfiguration Object
Required: No
The authorization configuration details for the Amazon EFS file system.
accessPointId
-
Type: String
Required: No
The access point ID to use. If an access point is specified, the root directory value in the
efsVolumeConfiguration
must either be omitted or set to/
, which will enforce the path set on the EFS access point. If an access point is used, transit encryption must be enabled in theEFSVolumeConfiguration
. For more information, see Working with Amazon EFS Access Points in the Amazon Elastic File System User Guide. iam
-
Type: String
Valid values:
ENABLED
|DISABLED
Required: No
Specifies whether to use the Amazon ECS task IAM role that's defined in a task definition when mounting the Amazon EFS file system. If enabled, transit encryption must be enabled in the
EFSVolumeConfiguration
. If this parameter is omitted, the default value ofDISABLED
is used. For more information, see IAM Roles for Tasks.
FSxWindowsFileServerVolumeConfiguration
-
Type: FSxWindowsFileServerVolumeConfiguration Object
Required: Yes
This parameter is specified when you're using an Amazon FSx for Windows File Server file system for task storage.
fileSystemId
-
Type: String
Required: Yes
The FSx for Windows File Server file system ID to use.
rootDirectory
-
Type: String
Required: Yes
The directory within the FSx for Windows File Server file system to mount as the root directory inside the host.
authorizationConfig
-
credentialsParameter
-
Type: String
Required: Yes
The authorization credential options.
options:
Amazon Resource Name (ARN) of an AWS Secrets Manager secret.
ARN of an AWS Systems Manager parameter.
domain
-
Type: String
Required: Yes
A fully qualified domain name hosted by an AWS Directory Service for Microsoft Active Directory (AWS Managed Microsoft AD) directory or a self-hosted EC2 Active Directory.
Tags
When you register a task definition, you can optionally specify metadata tags that are applied to the task definition. Tags help you categorize and organize your task definition. Each tag consists of a key and an optional value. You define both of them. For more information, see Tagging Amazon ECS resources.
Important
Don't add personally identifiable information or other confidential or sensitive information in tags. Tags are accessible to many AWS services, including billing. Tags aren't intended to be used for private or sensitive data.
The following parameters are allowed in a tag object.
key
-
Type: String
Required: No
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
value
-
Type: String
Required: No
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
Other task definition parameters
The following task definition parameters can be used when registering task definitions in the Amazon ECS console by using the Configure via JSON option. For more information, see Creating an Amazon ECS task definition using the console.
Ephemeral storage
ephemeralStorage
-
Type: EphemeralStorage object
Required: No
The amount of ephemeral storage (in GB) to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks that are hosted on AWS Fargate. For more information, see Use bind mounts with Amazon ECS.
Note
This parameter is only supported for tasks that are hosted on AWS Fargate using platform version
1.4.0
or later (Linux) or1.0.0
or later (Windows).
IPC mode
ipcMode
-
Type: String
Required: No
The IPC resource namespace to use for the containers in the task. The valid values are
host
,task
, ornone
. Ifhost
is specified, then all the containers that are within the tasks that specified thehost
IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. Iftask
is specified, all the containers that are within the specified task share the same IPC resources. Ifnone
is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance.If the
host
IPC mode is used, there's a heightened risk of undesired IPC namespace exposure.If you're setting namespaced kernel parameters that use
systemControls
for the containers in the task, the following applies to your IPC resource namespace.-
For tasks that use the
host
IPC mode, IPC namespace that's relatedsystemControls
aren't supported. -
For tasks that use the
task
IPC mode,systemControls
that relate to the IPC namespace apply to all containers within a task.
-
Note
This parameter is not supported for Windows containers or tasks using the Fargate launch type.
PID mode
pidMode
-
Type: String
Valid Values:
host
|task
Required: No
The process namespace to use for the containers in the task. The valid values are
host
ortask
. On Fargate for Linux containers, the only valid value istask
. For example, monitoring sidecars might needpidMode
to access information about other containers running in the same task.If
host
is specified, all containers within the tasks that specified thehost
PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance.If
task
is specified, all containers within the specified task share the same process namespace.If no value is specified, the default is a private namespace for each container.
If the
host
PID mode is used, there's a heightened risk of undesired process namespace exposure.
Note
This parameter is not supported for Windows containers.
Note
This parameter is only supported for tasks that are hosted on
AWS Fargate if the tasks are using platform version 1.4.0
or later
(Linux). This isn't supported for Windows containers on
Fargate.