The properties for a task definition that describes the container and volume definitions of an Amazon ECS task. You can specify which Docker images to use, the required resources, and other configurations related to launching the task definition through an Amazon ECS service or task.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{
"Containers" : [ TaskContainerProperties, ... ],
"ExecutionRoleArn" : String,
"IpcMode" : String,
"PidMode" : String,
"TaskRoleArn" : String,
"Volumes" : [ Volume, ... ]
}
YAML
Containers:
- TaskContainerProperties
ExecutionRoleArn: String
IpcMode: String
PidMode: String
TaskRoleArn: String
Volumes:
- Volume
Properties
Containers-
This object is a list of containers.
Required: No
Type: Array of TaskContainerProperties
Update requires: No interruption
ExecutionRoleArn-
The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume. For jobs that run on Fargate resources, you must provide an execution role. For more information, see AWS Batch execution IAM role in the AWS Batch User Guide.
Required: No
Type: String
Update requires: No interruption
IpcMode-
The IPC resource namespace to use for the containers in the task. The valid values are
host,task, ornone.If
hostis specified, all containers within the tasks that specified thehostIPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance.If
taskis specified, all containers within the specifiedtaskshare the same IPC resources.If
noneis specified, the IPC resources within the containers of a task are private, and are 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. For more information, see IPC settings
in the Docker run reference. Required: No
Type: String
Update requires: No interruption
PidMode-
The process namespace to use for the containers in the task. The valid values are
hostortask. For example, monitoring sidecars might needpidModeto access information about other containers running in the same task.If
hostis specified, all containers within the tasks that specified thehostPID mode on the same container instance share the process namespace with the host Amazon EC2 instance.If
taskis 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. For more information, see PID settings
in the Docker run reference. Required: No
Type: String
Update requires: No interruption
TaskRoleArn-
The Amazon Resource Name (ARN) that's associated with the Amazon ECS task.
Note
This is object is comparable to ContainerProperties:jobRoleArn.
Required: No
Type: String
Update requires: No interruption
Volumes-
A list of volumes that are associated with the job.
Required: No
Type: Array of Volume
Update requires: No interruption
