batch/aws.sdk.kotlin.services.batch.model/EcsTaskProperties

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.

Types

Builder

class Builder

Companion

object Companion

Properties

containers

val containers: List<TaskContainerProperties>?

This object is a list of containers.

enableExecuteCommand

val enableExecuteCommand: Boolean?

Determines whether execute command functionality is turned on for this task. If true, execute command functionality is turned on all the containers in the task.

ephemeralStorage

val ephemeralStorage: 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 Fargate.

executionRoleArn

val executionRoleArn: String?

The Amazon Resource Name (ARN) of the execution role that Batch can assume. For jobs that run on Fargate resources, you must provide an execution role. For more information, see Batch execution IAM role in the Batch User Guide.

ipcMode

val ipcMode: String?

The IPC resource namespace to use for the containers in the task. The valid values are host, task, or none.

networkConfiguration

val networkConfiguration: 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.

pidMode

val pidMode: String?

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.

platformVersion

val platformVersion: String?

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

runtimePlatform

val runtimePlatform: RuntimePlatform?

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

taskRoleArn

val taskRoleArn: String?

The Amazon Resource Name (ARN) that's associated with the Amazon ECS task.

volumes

val volumes: List<Volume>?

A list of volumes that are associated with the job.