/AWS1/CL_ECSTASKDEFINITION¶
The details of a task definition which describes the container and volume definitions of an Amazon Elastic Container Service 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¶
Optional arguments:¶
iv_taskdefinitionarn
TYPE /AWS1/ECSSTRING
/AWS1/ECSSTRING
¶
The full Amazon Resource Name (ARN) of the task definition.
it_containerdefinitions
TYPE /AWS1/CL_ECSCONTAINERDEFN=>TT_CONTAINERDEFINITIONS
TT_CONTAINERDEFINITIONS
¶
A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.
iv_family
TYPE /AWS1/ECSSTRING
/AWS1/ECSSTRING
¶
The name of a family that this task definition is registered to. Up to 255 characters are allowed. Letters (both uppercase and lowercase letters), numbers, hyphens (-), and underscores (_) are allowed.
A family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add.
iv_taskrolearn
TYPE /AWS1/ECSSTRING
/AWS1/ECSSTRING
¶
The short name or full Amazon Resource Name (ARN) of the Identity and Access Management role that grants containers in the task permission to call Amazon Web Services APIs on your behalf. For informationabout the required IAM roles for Amazon ECS, see IAM roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
iv_executionrolearn
TYPE /AWS1/ECSSTRING
/AWS1/ECSSTRING
¶
The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make Amazon Web Services API calls on your behalf. For informationabout the required IAM roles for Amazon ECS, see IAM roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
iv_networkmode
TYPE /AWS1/ECSNETWORKMODE
/AWS1/ECSNETWORKMODE
¶
The Docker networking mode to use for the containers in the task. The valid values are
none
,bridge
,awsvpc
, andhost
. If no network mode is specified, the default isbridge
.For Amazon ECS tasks on Fargate, the
awsvpc
network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances,or
awsvpc
can be used. If the network mode is set tonone
, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. Thehost
andawsvpc
network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by thebridge
mode.With the
host
andawsvpc
network modes, exposed container ports are mapped directly to the corresponding host port (for thehost
network mode) or the attached elastic network interface port (for theawsvpc
network mode), so you cannot take advantage of dynamic host port mappings.When using the
host
network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.If the network mode is
awsvpc
, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.If the network mode is
host
, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.
iv_revision
TYPE /AWS1/ECSINTEGER
/AWS1/ECSINTEGER
¶
The revision of the task in a particular family. The revision is a version number of a task definition in a family. When you register a task definition for the first time, the revision is
1
. Each time that you register a new revision of a task definition in the same family, the revision value always increases by one. This is even if you deregistered previous revisions in this family.
it_volumes
TYPE /AWS1/CL_ECSVOLUME=>TT_VOLUMELIST
TT_VOLUMELIST
¶
The list of data volume definitions for the task. For more information, see Using data volumes in tasks in the Amazon Elastic Container Service Developer Guide.
The
host
andsourcePath
parameters aren't supported for tasks run on Fargate.
iv_status
TYPE /AWS1/ECSTASKDEFINITIONSTATUS
/AWS1/ECSTASKDEFINITIONSTATUS
¶
The status of the task definition.
it_requiresattributes
TYPE /AWS1/CL_ECSATTRIBUTE=>TT_REQUIRESATTRIBUTES
TT_REQUIRESATTRIBUTES
¶
The container instance attributes required by your task. When an Amazon EC2 instance is registered to your cluster, the Amazon ECS container agent assigns some standard attributes to the instance. You can apply custom attributes. These are specified as key-value pairs using the Amazon ECS console or the PutAttributes API. These attributes are used when determining task placement for tasks hosted on Amazon EC2 instances. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.
This parameter isn't supported for tasks run on Fargate.
it_placementconstraints
TYPE /AWS1/CL_ECSTASKDEFPLCCNS=>TT_TASKDEFNPLACEMENTCNSTRNTS
TT_TASKDEFNPLACEMENTCNSTRNTS
¶
An array of placement constraint objects to use for tasks.
This parameter isn't supported for tasks run on Fargate.
it_compatibilities
TYPE /AWS1/CL_ECSCOMPATIBILITYLST_W=>TT_COMPATIBILITYLIST
TT_COMPATIBILITYLIST
¶
Amazon ECS validates the task definition parameters with those supported by the launch type. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
io_runtimeplatform
TYPE REF TO /AWS1/CL_ECSRUNTIMEPLATFORM
/AWS1/CL_ECSRUNTIMEPLATFORM
¶
The operating system that your task definitions are running on. A platform family is specified only for tasks using the Fargate launch type.
When you specify a task in a service, this value must match the
runtimePlatform
value of the service.
it_requirescompatibilities
TYPE /AWS1/CL_ECSCOMPATIBILITYLST_W=>TT_COMPATIBILITYLIST
TT_COMPATIBILITYLIST
¶
The task launch types the task definition was validated against. The valid values are
EC2
,FARGATE
, andEXTERNAL
. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
iv_cpu
TYPE /AWS1/ECSSTRING
/AWS1/ECSSTRING
¶
The number of
cpu
units used by the task. If you use the EC2 launch type, this field is optional. Any value can be used. If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines your range of valid values for thememory
parameter.If you're using the EC2 launch type or the external launch type, this field is optional. Supported values are between
128
CPU units (0.125
vCPUs) and196608
CPU units (192
vCPUs).This field is required for Fargate. For information about the valid values, see Task size in the Amazon Elastic Container Service Developer Guide.
iv_memory
TYPE /AWS1/ECSSTRING
/AWS1/ECSSTRING
¶
The amount (in MiB) of memory used by the task.
If your tasks runs on Amazon EC2 instances, you must specify either a task-level memory value or a container-level memory value. This field is optional and any value can be used. If a task-level memory value is specified, the container-level memory value is optional. For more information regarding container-level memory and memory reservation, see ContainerDefinition.
If your tasks runs on Fargate, this field is required. You must use one of the following values. The value you choose determines your range of valid values for the
cpu
parameter.
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available
cpu
values: 256 (.25 vCPU)1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available
cpu
values: 512 (.5 vCPU)2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available
cpu
values: 1024 (1 vCPU)Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available
cpu
values: 2048 (2 vCPU)Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available
cpu
values: 4096 (4 vCPU)Between 16 GB and 60 GB in 4 GB increments - Available
cpu
values: 8192 (8 vCPU)This option requires Linux platform
1.4.0
or later.Between 32GB and 120 GB in 8 GB increments - Available
cpu
values: 16384 (16 vCPU)This option requires Linux platform
1.4.0
or later.
it_inferenceaccelerators
TYPE /AWS1/CL_ECSINFERENCEACCELER00=>TT_INFERENCEACCELERATORS
TT_INFERENCEACCELERATORS
¶
The Elastic Inference accelerator that's associated with the task.
iv_pidmode
TYPE /AWS1/ECSPIDMODE
/AWS1/ECSPIDMODE
¶
The process namespace to use for the containers in the task. The valid values are
host
ortask
. On Fargate for Linux containers, the only valid value istask
. 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 same 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.
If the
host
PID mode is used, there's a heightened risk of undesired process namespace exposure.This parameter is not supported for Windows containers.
This parameter is only supported for tasks that are hosted on Fargate if the tasks are using platform version
1.4.0
or later (Linux). This isn't supported for Windows containers on Fargate.
iv_ipcmode
TYPE /AWS1/ECSIPCMODE
/AWS1/ECSIPCMODE
¶
The IPC resource namespace to use for the containers in the task. The valid values are
host
,task
, ornone
. Ifhost
is specified, then 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. Iftask
is specified, all containers within the specified task share the same IPC resources. Ifnone
is specified, then IPC resources within the containers of a task are private and 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.If the
host
IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose.If you are setting namespaced kernel parameters using
systemControls
for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide.
For tasks that use the
host
IPC mode, IPC namespace relatedsystemControls
are not supported.For tasks that use the
task
IPC mode, IPC namespace relatedsystemControls
will apply to all containers within a task.This parameter is not supported for Windows containers or tasks run on Fargate.
io_proxyconfiguration
TYPE REF TO /AWS1/CL_ECSPROXYCONFIGURATION
/AWS1/CL_ECSPROXYCONFIGURATION
¶
The configuration details for the App Mesh proxy.
Your Amazon ECS container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the
ecs-init
package to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version20190301
or later, they contain the required versions of the container agent andecs-init
. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
iv_registeredat
TYPE /AWS1/ECSTIMESTAMP
/AWS1/ECSTIMESTAMP
¶
The Unix timestamp for the time when the task definition was registered.
iv_deregisteredat
TYPE /AWS1/ECSTIMESTAMP
/AWS1/ECSTIMESTAMP
¶
The Unix timestamp for the time when the task definition was deregistered.
iv_registeredby
TYPE /AWS1/ECSSTRING
/AWS1/ECSSTRING
¶
The principal that registered the task definition.
io_ephemeralstorage
TYPE REF TO /AWS1/CL_ECSEPHEMERALSTORAGE
/AWS1/CL_ECSEPHEMERALSTORAGE
¶
The ephemeral storage settings to use for tasks run with the task definition.
iv_enablefaultinjection
TYPE /AWS1/ECSBOXEDBOOLEAN
/AWS1/ECSBOXEDBOOLEAN
¶
Enables fault injection and allows for fault injection requests to be accepted from the task's containers. The default value is
false
.
Queryable Attributes¶
taskDefinitionArn¶
The full Amazon Resource Name (ARN) of the task definition.
Accessible with the following methods¶
Method | Description |
---|---|
GET_TASKDEFINITIONARN() |
Getter for TASKDEFINITIONARN, with configurable default |
ASK_TASKDEFINITIONARN() |
Getter for TASKDEFINITIONARN w/ exceptions if field has no v |
HAS_TASKDEFINITIONARN() |
Determine if TASKDEFINITIONARN has a value |
containerDefinitions¶
A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.
Accessible with the following methods¶
Method | Description |
---|---|
GET_CONTAINERDEFINITIONS() |
Getter for CONTAINERDEFINITIONS, with configurable default |
ASK_CONTAINERDEFINITIONS() |
Getter for CONTAINERDEFINITIONS w/ exceptions if field has n |
HAS_CONTAINERDEFINITIONS() |
Determine if CONTAINERDEFINITIONS has a value |
family¶
The name of a family that this task definition is registered to. Up to 255 characters are allowed. Letters (both uppercase and lowercase letters), numbers, hyphens (-), and underscores (_) are allowed.
A family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add.
Accessible with the following methods¶
Method | Description |
---|---|
GET_FAMILY() |
Getter for FAMILY, with configurable default |
ASK_FAMILY() |
Getter for FAMILY w/ exceptions if field has no value |
HAS_FAMILY() |
Determine if FAMILY has a value |
taskRoleArn¶
The short name or full Amazon Resource Name (ARN) of the Identity and Access Management role that grants containers in the task permission to call Amazon Web Services APIs on your behalf. For informationabout the required IAM roles for Amazon ECS, see IAM roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
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 |
executionRoleArn¶
The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make Amazon Web Services API calls on your behalf. For informationabout the required IAM roles for Amazon ECS, see IAM roles for Amazon ECS in the Amazon Elastic Container Service Developer 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 |
networkMode¶
The Docker networking mode to use for the containers in the task. The valid values are
none
,bridge
,awsvpc
, andhost
. If no network mode is specified, the default isbridge
.For Amazon ECS tasks on Fargate, the
awsvpc
network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances,or
awsvpc
can be used. If the network mode is set tonone
, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. Thehost
andawsvpc
network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by thebridge
mode.With the
host
andawsvpc
network modes, exposed container ports are mapped directly to the corresponding host port (for thehost
network mode) or the attached elastic network interface port (for theawsvpc
network mode), so you cannot take advantage of dynamic host port mappings.When using the
host
network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.If the network mode is
awsvpc
, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.If the network mode is
host
, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.
Accessible with the following methods¶
Method | Description |
---|---|
GET_NETWORKMODE() |
Getter for NETWORKMODE, with configurable default |
ASK_NETWORKMODE() |
Getter for NETWORKMODE w/ exceptions if field has no value |
HAS_NETWORKMODE() |
Determine if NETWORKMODE has a value |
revision¶
The revision of the task in a particular family. The revision is a version number of a task definition in a family. When you register a task definition for the first time, the revision is
1
. Each time that you register a new revision of a task definition in the same family, the revision value always increases by one. This is even if you deregistered previous revisions in this family.
Accessible with the following methods¶
Method | Description |
---|---|
GET_REVISION() |
Getter for REVISION |
volumes¶
The list of data volume definitions for the task. For more information, see Using data volumes in tasks in the Amazon Elastic Container Service Developer Guide.
The
host
andsourcePath
parameters aren't supported for tasks run on Fargate.
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 |
status¶
The status of the task definition.
Accessible with the following methods¶
Method | Description |
---|---|
GET_STATUS() |
Getter for STATUS, with configurable default |
ASK_STATUS() |
Getter for STATUS w/ exceptions if field has no value |
HAS_STATUS() |
Determine if STATUS has a value |
requiresAttributes¶
The container instance attributes required by your task. When an Amazon EC2 instance is registered to your cluster, the Amazon ECS container agent assigns some standard attributes to the instance. You can apply custom attributes. These are specified as key-value pairs using the Amazon ECS console or the PutAttributes API. These attributes are used when determining task placement for tasks hosted on Amazon EC2 instances. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.
This parameter isn't supported for tasks run on Fargate.
Accessible with the following methods¶
Method | Description |
---|---|
GET_REQUIRESATTRIBUTES() |
Getter for REQUIRESATTRIBUTES, with configurable default |
ASK_REQUIRESATTRIBUTES() |
Getter for REQUIRESATTRIBUTES w/ exceptions if field has no |
HAS_REQUIRESATTRIBUTES() |
Determine if REQUIRESATTRIBUTES has a value |
placementConstraints¶
An array of placement constraint objects to use for tasks.
This parameter isn't supported for tasks run on Fargate.
Accessible with the following methods¶
Method | Description |
---|---|
GET_PLACEMENTCONSTRAINTS() |
Getter for PLACEMENTCONSTRAINTS, with configurable default |
ASK_PLACEMENTCONSTRAINTS() |
Getter for PLACEMENTCONSTRAINTS w/ exceptions if field has n |
HAS_PLACEMENTCONSTRAINTS() |
Determine if PLACEMENTCONSTRAINTS has a value |
compatibilities¶
Amazon ECS validates the task definition parameters with those supported by the launch type. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
Accessible with the following methods¶
Method | Description |
---|---|
GET_COMPATIBILITIES() |
Getter for COMPATIBILITIES, with configurable default |
ASK_COMPATIBILITIES() |
Getter for COMPATIBILITIES w/ exceptions if field has no val |
HAS_COMPATIBILITIES() |
Determine if COMPATIBILITIES has a value |
runtimePlatform¶
The operating system that your task definitions are running on. A platform family is specified only for tasks using the Fargate launch type.
When you specify a task in a service, this value must match the
runtimePlatform
value of the service.
Accessible with the following methods¶
Method | Description |
---|---|
GET_RUNTIMEPLATFORM() |
Getter for RUNTIMEPLATFORM |
requiresCompatibilities¶
The task launch types the task definition was validated against. The valid values are
EC2
,FARGATE
, andEXTERNAL
. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
Accessible with the following methods¶
Method | Description |
---|---|
GET_REQUIRESCOMPATIBILITIES() |
Getter for REQUIRESCOMPATIBILITIES, with configurable defaul |
ASK_REQUIRESCOMPATIBILITIES() |
Getter for REQUIRESCOMPATIBILITIES w/ exceptions if field ha |
HAS_REQUIRESCOMPATIBILITIES() |
Determine if REQUIRESCOMPATIBILITIES has a value |
cpu¶
The number of
cpu
units used by the task. If you use the EC2 launch type, this field is optional. Any value can be used. If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines your range of valid values for thememory
parameter.If you're using the EC2 launch type or the external launch type, this field is optional. Supported values are between
128
CPU units (0.125
vCPUs) and196608
CPU units (192
vCPUs).This field is required for Fargate. For information about the valid values, see Task size in the Amazon Elastic Container Service Developer Guide.
Accessible with the following methods¶
Method | Description |
---|---|
GET_CPU() |
Getter for CPU, with configurable default |
ASK_CPU() |
Getter for CPU w/ exceptions if field has no value |
HAS_CPU() |
Determine if CPU has a value |
memory¶
The amount (in MiB) of memory used by the task.
If your tasks runs on Amazon EC2 instances, you must specify either a task-level memory value or a container-level memory value. This field is optional and any value can be used. If a task-level memory value is specified, the container-level memory value is optional. For more information regarding container-level memory and memory reservation, see ContainerDefinition.
If your tasks runs on Fargate, this field is required. You must use one of the following values. The value you choose determines your range of valid values for the
cpu
parameter.
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available
cpu
values: 256 (.25 vCPU)1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available
cpu
values: 512 (.5 vCPU)2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available
cpu
values: 1024 (1 vCPU)Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available
cpu
values: 2048 (2 vCPU)Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available
cpu
values: 4096 (4 vCPU)Between 16 GB and 60 GB in 4 GB increments - Available
cpu
values: 8192 (8 vCPU)This option requires Linux platform
1.4.0
or later.Between 32GB and 120 GB in 8 GB increments - Available
cpu
values: 16384 (16 vCPU)This option requires Linux platform
1.4.0
or later.
Accessible with the following methods¶
Method | Description |
---|---|
GET_MEMORY() |
Getter for MEMORY, with configurable default |
ASK_MEMORY() |
Getter for MEMORY w/ exceptions if field has no value |
HAS_MEMORY() |
Determine if MEMORY has a value |
inferenceAccelerators¶
The Elastic Inference accelerator that's associated with the task.
Accessible with the following methods¶
Method | Description |
---|---|
GET_INFERENCEACCELERATORS() |
Getter for INFERENCEACCELERATORS, with configurable default |
ASK_INFERENCEACCELERATORS() |
Getter for INFERENCEACCELERATORS w/ exceptions if field has |
HAS_INFERENCEACCELERATORS() |
Determine if INFERENCEACCELERATORS has a value |
pidMode¶
The process namespace to use for the containers in the task. The valid values are
host
ortask
. On Fargate for Linux containers, the only valid value istask
. 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 same 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.
If the
host
PID mode is used, there's a heightened risk of undesired process namespace exposure.This parameter is not supported for Windows containers.
This parameter is only supported for tasks that are hosted on Fargate if the tasks are using platform version
1.4.0
or later (Linux). This isn't supported for Windows containers on Fargate.
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 |
ipcMode¶
The IPC resource namespace to use for the containers in the task. The valid values are
host
,task
, ornone
. Ifhost
is specified, then 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. Iftask
is specified, all containers within the specified task share the same IPC resources. Ifnone
is specified, then IPC resources within the containers of a task are private and 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.If the
host
IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose.If you are setting namespaced kernel parameters using
systemControls
for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide.
For tasks that use the
host
IPC mode, IPC namespace relatedsystemControls
are not supported.For tasks that use the
task
IPC mode, IPC namespace relatedsystemControls
will apply to all containers within a task.This parameter is not supported for Windows containers or tasks run on Fargate.
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 |
proxyConfiguration¶
The configuration details for the App Mesh proxy.
Your Amazon ECS container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the
ecs-init
package to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version20190301
or later, they contain the required versions of the container agent andecs-init
. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
Accessible with the following methods¶
Method | Description |
---|---|
GET_PROXYCONFIGURATION() |
Getter for PROXYCONFIGURATION |
registeredAt¶
The Unix timestamp for the time when the task definition was registered.
Accessible with the following methods¶
Method | Description |
---|---|
GET_REGISTEREDAT() |
Getter for REGISTEREDAT, with configurable default |
ASK_REGISTEREDAT() |
Getter for REGISTEREDAT w/ exceptions if field has no value |
HAS_REGISTEREDAT() |
Determine if REGISTEREDAT has a value |
deregisteredAt¶
The Unix timestamp for the time when the task definition was deregistered.
Accessible with the following methods¶
Method | Description |
---|---|
GET_DEREGISTEREDAT() |
Getter for DEREGISTEREDAT, with configurable default |
ASK_DEREGISTEREDAT() |
Getter for DEREGISTEREDAT w/ exceptions if field has no valu |
HAS_DEREGISTEREDAT() |
Determine if DEREGISTEREDAT has a value |
registeredBy¶
The principal that registered the task definition.
Accessible with the following methods¶
Method | Description |
---|---|
GET_REGISTEREDBY() |
Getter for REGISTEREDBY, with configurable default |
ASK_REGISTEREDBY() |
Getter for REGISTEREDBY w/ exceptions if field has no value |
HAS_REGISTEREDBY() |
Determine if REGISTEREDBY has a value |
ephemeralStorage¶
The ephemeral storage settings to use for tasks run with the task definition.
Accessible with the following methods¶
Method | Description |
---|---|
GET_EPHEMERALSTORAGE() |
Getter for EPHEMERALSTORAGE |
enableFaultInjection¶
Enables fault injection and allows for fault injection requests to be accepted from the task's containers. The default value is
false
.
Accessible with the following methods¶
Method | Description |
---|---|
GET_ENABLEFAULTINJECTION() |
Getter for ENABLEFAULTINJECTION, with configurable default |
ASK_ENABLEFAULTINJECTION() |
Getter for ENABLEFAULTINJECTION w/ exceptions if field has n |
HAS_ENABLEFAULTINJECTION() |
Determine if ENABLEFAULTINJECTION 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_TASKDEFINITIONLIST
¶
TYPES TT_TASKDEFINITIONLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_ECSTASKDEFINITION WITH DEFAULT KEY
.