EcsTaskProperties
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.
Contents
- containers
-
This object is a list of containers.
Type: Array of TaskContainerProperties objects
Required: Yes
- ephemeralStorage
-
The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on Amazon Fargate.
Type: EphemeralStorage object
Required: No
- executionRoleArn
-
The Amazon Resource Name (ARN) of the execution role that Amazon Batch can assume. For jobs that run on Fargate resources, you must provide an execution role. For more information, see Amazon Batch execution IAM role in the Amazon Batch User Guide.
Type: String
Required: No
- ipcMode
-
The IPC resource namespace to use for the containers in the task. The valid values are
host
,task
, ornone
.If
host
is specified, all containers within the tasks that specified thehost
IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance.If
task
is specified, all containers within the specifiedtask
share the same IPC resources.If
none
is 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. Type: String
Required: No
- networkConfiguration
-
The network configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter.
Type: NetworkConfiguration object
Required: No
- pidMode
-
The process namespace to use for the containers in the task. The valid values are
host
ortask
. 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 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. For more information, see PID settings
in the Docker run reference. Type: String
Required: No
- platformVersion
-
The Fargate platform version where the jobs are running. A platform version is specified only for jobs that are running on Fargate resources. If one isn't specified, the
LATEST
platform version is used by default. This uses a recent, approved version of the Fargate platform for compute resources. For more information, see Amazon Fargate platform versions in the Amazon Elastic Container Service Developer Guide.Type: String
Required: No
- runtimePlatform
-
An object that represents the compute environment architecture for Amazon Batch jobs on Fargate.
Type: RuntimePlatform object
Required: No
- taskRoleArn
-
The Amazon Resource Name (ARN) that's associated with the Amazon ECS task.
Note
This is object is comparable to ContainerProperties:jobRoleArn.
Type: String
Required: No
- volumes
-
A list of volumes that are associated with the job.
Type: Array of Volume objects
Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: