Interface IFargateTaskDefinitionProps
The properties for a task definition.
Inherited Members
Namespace: Amazon.CDK.AWS.ECS
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IFargateTaskDefinitionProps : ICommonTaskDefinitionProps
Syntax (vb)
Public Interface IFargateTaskDefinitionProps
Inherits ICommonTaskDefinitionProps
Remarks
ExampleMetadata: infused
Examples
var fargateTaskDefinition = new FargateTaskDefinition(this, "TaskDef", new FargateTaskDefinitionProps {
RuntimePlatform = new RuntimePlatform {
OperatingSystemFamily = OperatingSystemFamily.LINUX,
CpuArchitecture = CpuArchitecture.ARM64
},
MemoryLimitMiB = 512,
Cpu = 256,
PidMode = PidMode.TASK
});
Synopsis
Properties
Cpu | The number of cpu units used by the task. |
EphemeralStorageGiB | The amount (in GiB) of ephemeral storage to be allocated to the task. |
MemoryLimitMiB | The amount (in MiB) of memory used by the task. |
PidMode | The process namespace to use for the containers in the task. |
RuntimePlatform | The operating system that your task definitions are running on. |
Properties
Cpu
The number of cpu units used by the task.
virtual Nullable<double> Cpu { get; }
Property Value
System.Nullable<System.Double>
Remarks
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)
Default: 256
EphemeralStorageGiB
The amount (in GiB) of ephemeral storage to be allocated to the task.
virtual Nullable<double> EphemeralStorageGiB { get; }
Property Value
System.Nullable<System.Double>
Remarks
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
MemoryLimitMiB
The amount (in MiB) of memory used by the task.
virtual Nullable<double> MemoryLimitMiB { get; }
Property Value
System.Nullable<System.Double>
Remarks
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)
Default: 512
PidMode
The process namespace to use for the containers in the task.
virtual Nullable<PidMode> PidMode { get; }
Property Value
System.Nullable<PidMode>
Remarks
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.
Default: - PidMode used by the task is not specified
RuntimePlatform
The operating system that your task definitions are running on.
virtual IRuntimePlatform RuntimePlatform { get; }
Property Value
Remarks
A runtimePlatform is supported only for tasks using the Fargate launch type.
Default: - Undefined.