TaskDefinition
The base class for all task definitions.
Import
import { TaskDefinition } from 'aws-cdk-lib/aws-ecs';Or use the module namespace:
import * as ecs from 'aws-cdk-lib/aws-ecs';
// ecs.TaskDefinitionProperties
Configuration passed to the constructor as TaskDefinitionProps.
compatibilityRequiredCompatibilityThe task launch type compatibility requirement.
cpuOptionalstringThe number of cpu units used by the task. If you are using the EC2 launch type, this field is optional and any value can be used. If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the memory parameter: 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) 512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) 1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) 2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) 4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) 8192 (8 vCPU) - Available memory values: Between 16384 (16 GB) and 61440 (60 GB) in increments of 4096 (4 GB) 16384 (16 vCPU) - Available memory values: Between 32768 (32 GB) and 122880 (120 GB) in increments of 8192 (8 GB)
Default: - CPU units are not specified.
ephemeralStorageGiBOptionalnumberThe amount (in GiB) of ephemeral storage to be allocated to the task. Only supported in Fargate platform version 1.4.0 or later.
Default: - Undefined, in which case, the task will receive 20GiB ephemeral storage.
inferenceAcceleratorsOptionalDeprecatedInferenceAccelerator[]The inference accelerators to use for the containers in the task. Not supported in Fargate.
Default: - No inference accelerators.
Deprecated: ECS TaskDefinition's inferenceAccelerator is EOL since April 2024
ipcModeOptionalIpcModeThe IPC resource namespace to use for the containers in the task. Not supported in Fargate and Windows containers.
Default: - IpcMode used by the task is not specified
memoryMiBOptionalstringThe amount (in MiB) of memory used by the task. If using the EC2 launch type, this field is optional and any value can be used. If using the Fargate launch type, this field is required and you must use one of the following values, which 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 16384 (16 GB) and 61440 (60 GB) in increments of 4096 (4 GB) - Available cpu values: 8192 (8 vCPU) Between 32768 (32 GB) and 122880 (120 GB) in increments of 8192 (8 GB) - Available cpu values: 16384 (16 vCPU)
Default: - Memory used by task is not specified.
networkModeOptionalNetworkModeThe networking mode to use for the containers in the task. On Fargate, the only supported networking mode is AwsVpc.
Default: - NetworkMode.Bridge for EC2 & External tasks, AwsVpc for Fargate tasks.
pidModeOptionalPidModeThe process namespace to use for the containers in the task. Only supported for tasks that are hosted on AWS Fargate if the tasks are using platform version 1.4.0 or later (Linux). Only the TASK option is supported for Linux-based Fargate containers. Not supported in Windows containers. If pidMode is specified for a Fargate task, then runtimePlatform.operatingSystemFamily must also be specified. For more information, see [Task Definition Parameters](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#task_definition_pidmode).
Default: - PidMode used by the task is not specified
placementConstraintsOptionalPlacementConstraint[]The placement constraints to use for tasks in the service. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at run time). Not supported in Fargate.
Default: - No placement constraints.
runtimePlatformOptionalRuntimePlatformThe operating system that your task definitions are running on. A runtimePlatform is supported only for tasks using the Fargate launch type.
Default: - Undefined.
6 properties inherited from CommonTaskDefinitionProps
enableFaultInjectionOptionalinherited from CommonTaskDefinitionPropsbooleanEnables fault injection and allows for fault injection requests to be accepted from the task's containers. Fault injection only works with tasks using the {@link NetworkMode.AWS_VPC} or {@link NetworkMode.HOST} network modes.
Default: undefined - ECS default setting is false
executionRoleOptionalinherited from CommonTaskDefinitionPropsIRoleThe name of the IAM task execution role that grants the ECS agent permission to call AWS APIs on your behalf. The role will be used to retrieve container images from ECR and create CloudWatch log groups.
Default: - An execution role will be automatically created if you use ECR images in your task definition.
familyOptionalinherited from CommonTaskDefinitionPropsstringThe name of a family that this task definition is registered to. A family groups multiple versions of a task definition.
Default: - Automatically generated name.
proxyConfigurationOptionalinherited from CommonTaskDefinitionPropsProxyConfigurationThe configuration details for the App Mesh proxy.
Default: - No proxy configuration.
taskRoleOptionalinherited from CommonTaskDefinitionPropsIRoleThe name of the IAM role that grants containers in the task permission to call AWS APIs on your behalf.
Default: - A task role is automatically created for you.
volumesOptionalinherited from CommonTaskDefinitionPropsVolume[]The list of volume definitions for the task. For more information, see [Task Definition Parameter Volumes](https://docs.aws.amazon.com/AmazonECS/latest/developerguide//task_definition_parameters.html#volumes).
Default: - No volumes are passed to the Docker daemon on a container instance.
Get the Amazon ECS Cheat Sheet
Everything you need to know about Amazon ECS on one page. HD quality, print-friendly.
Download Free InfographicQuick Facts
aws-ecs