interface TaskDefinitionProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.ECS.TaskDefinitionProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsecs#TaskDefinitionProps |
![]() | software.amazon.awscdk.services.ecs.TaskDefinitionProps |
![]() | aws_cdk.aws_ecs.TaskDefinitionProps |
![]() | aws-cdk-lib » aws_ecs » TaskDefinitionProps |
The properties for task definitions.
Example
const vpc = ec2.Vpc.fromLookup(this, 'Vpc', {
isDefault: true,
});
const cluster = new ecs.Cluster(this, 'FargateCluster', { vpc });
const taskDefinition = new ecs.TaskDefinition(this, 'TD', {
memoryMiB: '512',
cpu: '256',
compatibility: ecs.Compatibility.FARGATE,
});
const containerDefinition = taskDefinition.addContainer('TheContainer', {
image: ecs.ContainerImage.fromRegistry('foo/bar'),
memoryLimitMiB: 256,
});
const runTask = new tasks.EcsRunTask(this, 'RunFargate', {
integrationPattern: sfn.IntegrationPattern.RUN_JOB,
cluster,
taskDefinition,
assignPublicIp: true,
containerOverrides: [{
containerDefinition,
environment: [{ name: 'SOME_KEY', value: sfn.JsonPath.stringAt('$.SomeKey') }],
}],
launchTarget: new tasks.EcsFargateLaunchTarget(),
propagatedTagSource: ecs.PropagatedTagSource.TASK_DEFINITION,
});
Properties
Name | Type | Description |
---|---|---|
compatibility | Compatibility | The task launch type compatibility requirement. |
cpu? | string | The number of cpu units used by the task. |
enable | boolean | Enables fault injection and allows for fault injection requests to be accepted from the task's containers. |
ephemeral | number | The amount (in GiB) of ephemeral storage to be allocated to the task. |
execution | IRole | The name of the IAM task execution role that grants the ECS agent permission to call AWS APIs on your behalf. |
family? | string | The name of a family that this task definition is registered to. |
inference | Inference [] | The inference accelerators to use for the containers in the task. |
ipc | Ipc | The IPC resource namespace to use for the containers in the task. |
memory | string | The amount (in MiB) of memory used by the task. |
network | Network | The networking mode to use for the containers in the task. |
pid | Pid | The process namespace to use for the containers in the task. |
placement | Placement [] | The placement constraints to use for tasks in the service. |
proxy | Proxy | The configuration details for the App Mesh proxy. |
runtime | Runtime | The operating system that your task definitions are running on. |
task | IRole | The name of the IAM role that grants containers in the task permission to call AWS APIs on your behalf. |
volumes? | Volume [] | The list of volume definitions for the task. |
compatibility
Type:
Compatibility
The task launch type compatibility requirement.
cpu?
Type:
string
(optional, default: CPU units are not specified.)
The 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)
enableFaultInjection?
Type:
boolean
(optional, default: undefined - ECS default setting is false)
Enables 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.
ephemeralStorageGiB?
Type:
number
(optional, default: Undefined, in which case, the task will receive 20GiB ephemeral storage.)
The amount (in GiB) of ephemeral storage to be allocated to the task.
Only supported in Fargate platform version 1.4.0 or later.
executionRole?
Type:
IRole
(optional, default: An execution role will be automatically created if you use ECR images in your task definition.)
The 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.
family?
Type:
string
(optional, default: Automatically generated name.)
The name of a family that this task definition is registered to.
A family groups multiple versions of a task definition.
inferenceAccelerators?
⚠️ Deprecated: ECS TaskDefinition's inferenceAccelerator is EOL since April 2024
Type:
Inference
[]
(optional, default: No inference accelerators.)
The inference accelerators to use for the containers in the task.
Not supported in Fargate.
ipcMode?
Type:
Ipc
(optional, default: IpcMode used by the task is not specified)
The IPC resource namespace to use for the containers in the task.
Not supported in Fargate and Windows containers.
memoryMiB?
Type:
string
(optional, default: Memory used by task is not specified.)
The 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)
networkMode?
Type:
Network
(optional, default: NetworkMode.Bridge for EC2 & External tasks, AwsVpc for Fargate tasks.)
The networking mode to use for the containers in the task.
On Fargate, the only supported networking mode is AwsVpc.
pidMode?
Type:
Pid
(optional, default: PidMode used by the task is not specified)
The 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.
placementConstraints?
Type:
Placement
[]
(optional, default: No placement constraints.)
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.
proxyConfiguration?
Type:
Proxy
(optional, default: No proxy configuration.)
The configuration details for the App Mesh proxy.
runtimePlatform?
Type:
Runtime
(optional, default: Undefined.)
The operating system that your task definitions are running on.
A runtimePlatform is supported only for tasks using the Fargate launch type.
taskRole?
Type:
IRole
(optional, default: A task role is automatically created for you.)
The name of the IAM role that grants containers in the task permission to call AWS APIs on your behalf.
volumes?
Type:
Volume
[]
(optional, default: No volumes are passed to the Docker daemon on a container instance.)
The list of volume definitions for the task.
For more information, see Task Definition Parameter Volumes.