Package software.amazon.awscdk.services.ecs

Class TaskDefinition.Builder

java.lang.Object
software.amazon.awscdk.services.ecs.TaskDefinition.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<TaskDefinition>
Enclosing class:
TaskDefinition
@Stability(Stable) public static final class TaskDefinition.Builder extends Object implements software.amazon.jsii.Builder<TaskDefinition>
A fluent builder for TaskDefinition.

  • Method Details

    • create

      @Stability(Stable) public static TaskDefinition.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      Returns:
      a new instance of TaskDefinition.Builder.

    • executionRole

      @Stability(Stable) public TaskDefinition.Builder executionRole(IRole executionRole)
      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.

      Default: - An execution role will be automatically created if you use ECR images in your task definition.

      Parameters:
      executionRole - The name of the IAM task execution role that grants the ECS agent permission to call AWS APIs on your behalf. This parameter is required.
      Returns:
      this

    • family

      @Stability(Stable) public TaskDefinition.Builder family(String family)
      The name of a family that this task definition is registered to.

      A family groups multiple versions of a task definition.

      Default: - Automatically generated name.

      Parameters:
      family - The name of a family that this task definition is registered to. This parameter is required.
      Returns:
      this

    • proxyConfiguration

      @Stability(Stable) public TaskDefinition.Builder proxyConfiguration(ProxyConfiguration proxyConfiguration)
      The configuration details for the App Mesh proxy.

      Default: - No proxy configuration.

      Parameters:
      proxyConfiguration - The configuration details for the App Mesh proxy. This parameter is required.
      Returns:
      this

    • taskRole

      @Stability(Stable) public TaskDefinition.Builder taskRole(IRole taskRole)
      The name of the IAM role that grants containers in the task permission to call AWS APIs on your behalf.

      Default: - A task role is automatically created for you.

      Parameters:
      taskRole - The name of the IAM role that grants containers in the task permission to call AWS APIs on your behalf. This parameter is required.
      Returns:
      this

    • volumes

      @Stability(Stable) public TaskDefinition.Builder volumes(List<? extends Volume> volumes)
      The list of volume definitions for the task.

      For more information, see Task Definition Parameter Volumes.

      Default: - No volumes are passed to the Docker daemon on a container instance.

      Parameters:
      volumes - The list of volume definitions for the task. This parameter is required.
      Returns:
      this

    • compatibility

      @Stability(Stable) public TaskDefinition.Builder compatibility(Compatibility compatibility)
      The task launch type compatiblity requirement.

      Parameters:
      compatibility - The task launch type compatiblity requirement. This parameter is required.
      Returns:
      this

    • cpu

      @Stability(Stable) public TaskDefinition.Builder cpu(String cpu)
      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.

      Parameters:
      cpu - The number of cpu units used by the task. This parameter is required.
      Returns:
      this

    • ephemeralStorageGiB

      @Stability(Stable) public TaskDefinition.Builder ephemeralStorageGiB(Number ephemeralStorageGiB)
      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.

      Parameters:
      ephemeralStorageGiB - The amount (in GiB) of ephemeral storage to be allocated to the task. This parameter is required.
      Returns:
      this

    • inferenceAccelerators

      @Stability(Stable) public TaskDefinition.Builder inferenceAccelerators(List<? extends InferenceAccelerator> inferenceAccelerators)
      The inference accelerators to use for the containers in the task.

      Not supported in Fargate.

      Default: - No inference accelerators.

      Parameters:
      inferenceAccelerators - The inference accelerators to use for the containers in the task. This parameter is required.
      Returns:
      this

    • ipcMode

      @Stability(Stable) public TaskDefinition.Builder ipcMode(IpcMode ipcMode)
      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

      Parameters:
      ipcMode - The IPC resource namespace to use for the containers in the task. This parameter is required.
      Returns:
      this

    • memoryMiB

      @Stability(Stable) public TaskDefinition.Builder memoryMiB(String memoryMiB)
      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.

      Parameters:
      memoryMiB - The amount (in MiB) of memory used by the task. This parameter is required.
      Returns:
      this

    • networkMode

      @Stability(Stable) public TaskDefinition.Builder networkMode(NetworkMode networkMode)
      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.

      Parameters:
      networkMode - The networking mode to use for the containers in the task. This parameter is required.
      Returns:
      this

    • pidMode

      @Stability(Stable) public TaskDefinition.Builder pidMode(PidMode pidMode)
      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

      Parameters:
      pidMode - The process namespace to use for the containers in the task. This parameter is required.
      Returns:
      this

    • placementConstraints

      @Stability(Stable) public TaskDefinition.Builder placementConstraints(List<? extends PlacementConstraint> placementConstraints)
      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.

      Parameters:
      placementConstraints - The placement constraints to use for tasks in the service. This parameter is required.
      Returns:
      this

    • runtimePlatform

      @Stability(Stable) public TaskDefinition.Builder runtimePlatform(RuntimePlatform runtimePlatform)
      The operating system that your task definitions are running on.

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

      Default: - Undefined.

      Parameters:
      runtimePlatform - The operating system that your task definitions are running on. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public TaskDefinition build()
      Specified by:
      build in interface software.amazon.jsii.Builder<TaskDefinition>
      Returns:
      a newly built instance of TaskDefinition.