Package software.amazon.awscdk.services.ecs

Interface TaskDefinitionProps

All Superinterfaces:
CommonTaskDefinitionProps, software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
TaskDefinitionProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-22T02:24:01.183Z") @Stability(Stable) public interface TaskDefinitionProps extends software.amazon.jsii.JsiiSerializable, CommonTaskDefinitionProps
The properties for task definitions.

Example: 

 IVpc vpc = Vpc.fromLookup(this, "Vpc", VpcLookupOptions.builder()
         .isDefault(true)
         .build());
 Cluster cluster = Cluster.Builder.create(this, "FargateCluster").vpc(vpc).build();
 TaskDefinition taskDefinition = TaskDefinition.Builder.create(this, "TD")
         .memoryMiB("512")
         .cpu("256")
         .compatibility(Compatibility.FARGATE)
         .build();
 ContainerDefinition containerDefinition = taskDefinition.addContainer("TheContainer", ContainerDefinitionOptions.builder()
         .image(ContainerImage.fromRegistry("foo/bar"))
         .memoryLimitMiB(256)
         .build());
 EcsRunTask runTask = EcsRunTask.Builder.create(this, "RunFargate")
         .integrationPattern(IntegrationPattern.RUN_JOB)
         .cluster(cluster)
         .taskDefinition(taskDefinition)
         .assignPublicIp(true)
         .containerOverrides(List.of(ContainerOverride.builder()
                 .containerDefinition(containerDefinition)
                 .environment(List.of(TaskEnvironmentVariable.builder().name("SOME_KEY").value(JsonPath.stringAt("$.SomeKey")).build()))
                 .build()))
         .launchTarget(new EcsFargateLaunchTarget())
         .propagatedTagSource(PropagatedTagSource.TASK_DEFINITION)
         .build();

  • Method Details

    • getCompatibility

      @Stability(Stable) @NotNull Compatibility getCompatibility()
      The task launch type compatiblity requirement.

    • getCpu

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

      Default: - CPU units are not specified.

    • getEphemeralStorageGiB

      @Stability(Stable) @Nullable default Number getEphemeralStorageGiB()
      The amount (in GiB) of ephemeral storage to be allocated to the task.

      Only supported in Fargate platform version 1.4.0 or later.

      Default: - Undefined, in which case, the task will receive 20GiB ephemeral storage.

    • getInferenceAccelerators

      @Stability(Stable) @Nullable default List<InferenceAccelerator> getInferenceAccelerators()
      The inference accelerators to use for the containers in the task.

      Not supported in Fargate.

      Default: - No inference accelerators.

    • getIpcMode

      @Stability(Stable) @Nullable default IpcMode getIpcMode()
      The IPC resource namespace to use for the containers in the task.

      Not supported in Fargate and Windows containers.

      Default: - IpcMode used by the task is not specified

    • getMemoryMiB

      @Stability(Stable) @Nullable default String getMemoryMiB()
      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)

      Default: - Memory used by task is not specified.

    • getNetworkMode

      @Stability(Stable) @Nullable default NetworkMode getNetworkMode()
      The networking mode to use for the containers in the task.

      On Fargate, the only supported networking mode is AwsVpc.

      Default: - NetworkMode.Bridge for EC2 invalid input: '&' External tasks, AwsVpc for Fargate tasks.

    • 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). 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

    • getPlacementConstraints

      @Stability(Stable) @Nullable default List<PlacementConstraint> getPlacementConstraints()
      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.

      Default: - No placement constraints.

    • 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 TaskDefinitionProps.Builder builder()
      Returns:
      a TaskDefinitionProps.Builder of TaskDefinitionProps