FargateTaskDefinition
The details of a task definition run on a Fargate cluster.
Import
import { FargateTaskDefinition } from 'aws-cdk-lib/aws-ecs';Or use the module namespace:
import * as ecs from 'aws-cdk-lib/aws-ecs';
// ecs.FargateTaskDefinitionProperties
Configuration passed to the constructor as FargateTaskDefinitionProps.
cpuOptionalnumberThe number of cpu units used by the task. For tasks 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) Note: For windows platforms, this field is not enforced at runtime. However, it is still required as it is used to determine the instance type and size that tasks run on.
Default: 256
ephemeralStorageGiBOptionalnumberThe amount (in GiB) of ephemeral storage to be allocated to the task. The maximum supported value is 200 GiB. NOTE: This parameter is only supported for tasks hosted on AWS Fargate using platform version 1.4.0 or later.
Default: 20
memoryLimitMiBOptionalnumberThe amount (in MiB) of memory used by the task. For tasks 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) Note: For windows platforms, this field is not enforced at runtime. However, it is still required as it is used to determine the instance type and size that tasks run on.
Default: 512
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
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