AWS::Batch::JobDefinition 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.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Containers" : [ TaskContainerProperties, ... ],
  "EphemeralStorage" : EphemeralStorage,
  "ExecutionRoleArn" : String,
  "IpcMode" : String,
  "NetworkConfiguration" : NetworkConfiguration,
  "PidMode" : String,
  "PlatformVersion" : String,
  "RuntimePlatform" : RuntimePlatform,
  "TaskRoleArn" : String,
  "Volumes" : [ Volumes, ... ]
}

YAML

  Containers: 
    - TaskContainerProperties
  EphemeralStorage: 
    EphemeralStorage
  ExecutionRoleArn: String
  IpcMode: String
  NetworkConfiguration: 
    NetworkConfiguration
  PidMode: String
  PlatformVersion: String
  RuntimePlatform: 
    RuntimePlatform
  TaskRoleArn: String
  Volumes: 
    - Volumes

Properties

Containers

This object is a list of containers.

Required: No

Type: Array of TaskContainerProperties

Update requires: No interruption

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 AWS Fargate.

Required: No

Type: EphemeralStorage

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, or none.

If host is specified, all containers within the tasks that specified the host 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 specified task 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.

Required: No

Type: String

Update requires: No interruption

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.

Required: No

Type: NetworkConfiguration

Update requires: No interruption

PidMode

The process namespace to use for the containers in the task. The valid values are host or task. For example, monitoring sidecars might need pidMode to access information about other containers running in the same task.

If host is specified, all containers within the tasks that specified the host 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.

Required: No

Type: String

Update requires: No interruption

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 AWS Fargate platform versions in the Amazon Elastic Container Service Developer Guide.

Required: No

Type: String

Update requires: No interruption

RuntimePlatform

An object that represents the compute environment architecture for AWS Batch jobs on Fargate.

Required: No

Type: RuntimePlatform

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 Volumes

Update requires: No interruption