FargateTaskDefinitionProps Struct
The properties for a task definition.
Example
// Create a Task Definition for the Windows container to start
const taskDefinition = new ecs.FargateTaskDefinition(this, 'TaskDef', {
runtimePlatform: {
operatingSystemFamily: ecs.OperatingSystemFamily.WINDOWS_SERVER_2019_CORE,
cpuArchitecture: ecs.CpuArchitecture.X86_64,
},
cpu: 1024,
memoryLimitMiB: 2048,
});
taskDefinition.addContainer('windowsservercore', {
logging: ecs.LogDriver.awsLogs({ streamPrefix: 'win-iis-on-fargate' }),
portMappings: [{ containerPort: 80 }],
image: ecs.ContainerImage.fromRegistry('mcr.microsoft.com/windows/servercore/iis:windowsservercore-ltsc2019'),
});
Properties
notes
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.
enableFaultInjectionoptionalbooleanenable_fault_injectionoptionalboolenableFaultInjectionoptionalBooleanEnableFaultInjectionoptionalboolEnableFaultInjectionoptional*bool#Default: undefined - ECS default setting is false
Fault injection only works with tasks using the {@link NetworkMode.AWS_VPC} or {@link NetworkMode.HOST} network modes.
ephemeralStorageGiBoptionalnumberephemeral_storage_gi_boptionalint | floatephemeralStorageGiBoptionalNumberEphemeralStorageGiBoptionaldoubleEphemeralStorageGiBoptional*float64= 20#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 for Linux tasks, and platform version 1.0.0 or later for Windows tasks.
executionRoleoptionalIRoleexecution_roleoptionalIRoleexecutionRoleoptionalIRoleExecutionRoleoptionalIRoleExecutionRoleoptionalIRole#Default: An execution role will be automatically created if you use ECR images in your task definition.
The role will be used to retrieve container images from ECR and create CloudWatch log groups.
Default: Automatically generated name.
A family groups multiple versions of a task definition.
memoryLimitMiBoptionalnumbermemory_limit_mi_boptionalint | floatmemoryLimitMiBoptionalNumberMemoryLimitMiBoptionaldoubleMemoryLimitMiBoptional*float64= 512#notes
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.
pidModeoptionalPidModepid_modeoptionalPidModepidModeoptionalPidModePidModeoptionalPidModePidModeoptionalPidMode#Default: PidMode used by the task is not specified
notes
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.
proxyConfigurationoptionalProxyConfigurationproxy_configurationoptionalProxyConfigurationproxyConfigurationoptionalProxyConfigurationProxyConfigurationoptionalProxyConfigurationProxyConfigurationoptionalProxyConfiguration#Default: No proxy configuration.
runtimePlatformoptionalRuntimePlatformruntime_platformoptionalRuntimePlatformruntimePlatformoptionalRuntimePlatformRuntimePlatformoptionalRuntimePlatformRuntimePlatformoptionalRuntimePlatform= Undefined.#A runtimePlatform is supported only for tasks using the Fargate launch type.
taskRoleoptionalIRoletask_roleoptionalIRoletaskRoleoptionalIRoleTaskRoleoptionalIRoleTaskRoleoptionalIRole#Default: A task role is automatically created for you.
volumesoptionalVolume[]volumesoptionaltyping.List[Volume]volumesoptionalList<Volume>VolumesoptionalVolume[]Volumesoptional*[]Volume#Default: No volumes are passed to the Docker daemon on a container instance.
For more information, see Task Definition Parameter Volumes.