/AWS1/CL_BTCECSTASKPROPERTIES

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.

CONSTRUCTOR

IMPORTING

Required arguments:

it_containers TYPE /AWS1/CL_BTCTASKCONTAINERPRPS=>TT_LISTTASKCONTAINERPROPERTIES TT_LISTTASKCONTAINERPROPERTIES

This object is a list of containers.

Optional arguments:

io_ephemeralstorage TYPE REF TO /AWS1/CL_BTCEPHEMERALSTORAGE /AWS1/CL_BTCEPHEMERALSTORAGE

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.

iv_executionrolearn TYPE /AWS1/BTCSTRING /AWS1/BTCSTRING

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.

iv_platformversion TYPE /AWS1/BTCSTRING /AWS1/BTCSTRING

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.

iv_ipcmode TYPE /AWS1/BTCSTRING /AWS1/BTCSTRING

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.

iv_taskrolearn TYPE /AWS1/BTCSTRING /AWS1/BTCSTRING

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

This is object is comparable to ContainerProperties:jobRoleArn.

iv_pidmode TYPE /AWS1/BTCSTRING /AWS1/BTCSTRING

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.

io_networkconfiguration TYPE REF TO /AWS1/CL_BTCNETWORKCONF /AWS1/CL_BTCNETWORKCONF

The network configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter.

io_runtimeplatform TYPE REF TO /AWS1/CL_BTCRUNTIMEPLATFORM /AWS1/CL_BTCRUNTIMEPLATFORM

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

it_volumes TYPE /AWS1/CL_BTCVOLUME=>TT_VOLUMES TT_VOLUMES

A list of volumes that are associated with the job.

iv_enableexecutecommand TYPE /AWS1/BTCBOOLEAN /AWS1/BTCBOOLEAN

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.

---

Queryable Attributes

containers

This object is a list of containers.

Accessible with the following methods

Method	Description
GET_CONTAINERS()	Getter for CONTAINERS, with configurable default
ASK_CONTAINERS()	Getter for CONTAINERS w/ exceptions if field has no value
HAS_CONTAINERS()	Determine if CONTAINERS has a value

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.

Accessible with the following methods

Method	Description
GET_EPHEMERALSTORAGE()	Getter for EPHEMERALSTORAGE

executionRoleArn

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.

Accessible with the following methods

Method	Description
GET_EXECUTIONROLEARN()	Getter for EXECUTIONROLEARN, with configurable default
ASK_EXECUTIONROLEARN()	Getter for EXECUTIONROLEARN w/ exceptions if field has no va
HAS_EXECUTIONROLEARN()	Determine if EXECUTIONROLEARN has a value

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

Accessible with the following methods

Method	Description
GET_PLATFORMVERSION()	Getter for PLATFORMVERSION, with configurable default
ASK_PLATFORMVERSION()	Getter for PLATFORMVERSION w/ exceptions if field has no val
HAS_PLATFORMVERSION()	Determine if PLATFORMVERSION has a value

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.

Accessible with the following methods

Method	Description
GET_IPCMODE()	Getter for IPCMODE, with configurable default
ASK_IPCMODE()	Getter for IPCMODE w/ exceptions if field has no value
HAS_IPCMODE()	Determine if IPCMODE has a value

taskRoleArn

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

This is object is comparable to ContainerProperties:jobRoleArn.

Accessible with the following methods

Method	Description
GET_TASKROLEARN()	Getter for TASKROLEARN, with configurable default
ASK_TASKROLEARN()	Getter for TASKROLEARN w/ exceptions if field has no value
HAS_TASKROLEARN()	Determine if TASKROLEARN has a value

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.

Accessible with the following methods

Method	Description
GET_PIDMODE()	Getter for PIDMODE, with configurable default
ASK_PIDMODE()	Getter for PIDMODE w/ exceptions if field has no value
HAS_PIDMODE()	Determine if PIDMODE has a value

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.

Accessible with the following methods

Method	Description
GET_NETWORKCONFIGURATION()	Getter for NETWORKCONFIGURATION

runtimePlatform

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

Accessible with the following methods

Method	Description
GET_RUNTIMEPLATFORM()	Getter for RUNTIMEPLATFORM

volumes

A list of volumes that are associated with the job.

Accessible with the following methods

Method	Description
GET_VOLUMES()	Getter for VOLUMES, with configurable default
ASK_VOLUMES()	Getter for VOLUMES w/ exceptions if field has no value
HAS_VOLUMES()	Determine if VOLUMES has a value

enableExecuteCommand

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.

Accessible with the following methods

Method	Description
GET_ENABLEEXECUTECOMMAND()	Getter for ENABLEEXECUTECOMMAND, with configurable default
ASK_ENABLEEXECUTECOMMAND()	Getter for ENABLEEXECUTECOMMAND w/ exceptions if field has n
HAS_ENABLEEXECUTECOMMAND()	Determine if ENABLEEXECUTECOMMAND has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_LISTECSTASKPROPERTIES

TYPES TT_LISTECSTASKPROPERTIES TYPE STANDARD TABLE OF REF TO /AWS1/CL_BTCECSTASKPROPERTIES WITH DEFAULT KEY
.