Package software.amazon.awscdk.services.ecs

Interface FargateTaskDefinitionProps

All Superinterfaces:
CommonTaskDefinitionProps, software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
FargateTaskDefinitionProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)", date="2024-05-08T21:35:06.571Z") @Stability(Stable) public interface FargateTaskDefinitionProps extends software.amazon.jsii.JsiiSerializable, CommonTaskDefinitionProps
The properties for a task definition.

Example: 

 FargateTaskDefinition fargateTaskDefinition = FargateTaskDefinition.Builder.create(this, "TaskDef")
         .runtimePlatform(RuntimePlatform.builder()
                 .operatingSystemFamily(OperatingSystemFamily.LINUX)
                 .cpuArchitecture(CpuArchitecture.ARM64)
                 .build())
         .memoryLimitMiB(512)
         .cpu(256)
         .pidMode(PidMode.HOST)
         .build();

  • Method Details

    • getCpu

      @Stability(Stable) @Nullable default Number getCpu()
      The 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)

      Default: 256

    • getEphemeralStorageGiB

      @Stability(Stable) @Nullable default Number getEphemeralStorageGiB()
      The 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

    • getMemoryLimitMiB

      @Stability(Stable) @Nullable default Number getMemoryLimitMiB()
      The 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)

      Default: 512

    • getPidMode

      @Stability(Stable) @Nullable default PidMode getPidMode()
      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). Not supported in Windows containers.

      Default: - PidMode used by the task is not specified

    • getRuntimePlatform

      @Stability(Stable) @Nullable default RuntimePlatform getRuntimePlatform()
      The operating system that your task definitions are running on.

      A runtimePlatform is supported only for tasks using the Fargate launch type.

      Default: - Undefined.

    • builder

      @Stability(Stable) static FargateTaskDefinitionProps.Builder builder()
      Returns:
      a FargateTaskDefinitionProps.Builder of FargateTaskDefinitionProps