Package software.amazon.awssdk.services.ecs.model

Interface TaskDefinition.Builder

All Superinterfaces:
Buildable, CopyableBuilder<TaskDefinition.Builder,TaskDefinition>, SdkBuilder<TaskDefinition.Builder,TaskDefinition>, SdkPojo
Enclosing class:
TaskDefinition
public static interface TaskDefinition.Builder extends SdkPojo, CopyableBuilder<TaskDefinition.Builder,TaskDefinition>

  • Method Details

    • taskDefinitionArn

      TaskDefinition.Builder taskDefinitionArn(String taskDefinitionArn)

      The full Amazon Resource Name (ARN) of the task definition.

      Parameters:
      taskDefinitionArn - The full Amazon Resource Name (ARN) of the task definition.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • containerDefinitions

      TaskDefinition.Builder containerDefinitions(Collection<ContainerDefinition> containerDefinitions)

      A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.

      Parameters:
      containerDefinitions - A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • containerDefinitions

      TaskDefinition.Builder containerDefinitions(ContainerDefinition... containerDefinitions)

      A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.

      Parameters:
      containerDefinitions - A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • containerDefinitions

      TaskDefinition.Builder containerDefinitions(Consumer<ContainerDefinition.Builder>... containerDefinitions)

      A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.

      This is a convenience method that creates an instance of the ContainerDefinition.Builder avoiding the need to create one manually via ContainerDefinition.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to containerDefinitions(List<ContainerDefinition>).

      Parameters:
      containerDefinitions - a consumer that will call methods on ContainerDefinition.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • family

      TaskDefinition.Builder family(String family)

      The name of a family that this task definition is registered to. Up to 255 characters are allowed. Letters (both uppercase and lowercase letters), numbers, hyphens (-), and underscores (_) are allowed.

      A family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add.

      Parameters:
      family - The name of a family that this task definition is registered to. Up to 255 characters are allowed. Letters (both uppercase and lowercase letters), numbers, hyphens (-), and underscores (_) are allowed.

      A family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • taskRoleArn

      TaskDefinition.Builder taskRoleArn(String taskRoleArn)

      The short name or full Amazon Resource Name (ARN) of the Identity and Access Management role that grants containers in the task permission to call Amazon Web Services APIs on your behalf. For more information, see Amazon ECS Task Role in the Amazon Elastic Container Service Developer Guide.

      IAM roles for tasks on Windows require that the -EnableTaskIAMRole option is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code to use the feature. For more information, see Windows IAM roles for tasks in the Amazon Elastic Container Service Developer Guide.

      Parameters:
      taskRoleArn - The short name or full Amazon Resource Name (ARN) of the Identity and Access Management role that grants containers in the task permission to call Amazon Web Services APIs on your behalf. For more information, see Amazon ECS Task Role in the Amazon Elastic Container Service Developer Guide.

      IAM roles for tasks on Windows require that the -EnableTaskIAMRole option is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code to use the feature. For more information, see Windows IAM roles for tasks in the Amazon Elastic Container Service Developer Guide.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • executionRoleArn

      TaskDefinition.Builder executionRoleArn(String executionRoleArn)

      The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make Amazon Web Services API calls on your behalf. The task execution IAM role is required depending on the requirements of your task. For more information, see Amazon ECS task execution IAM role in the Amazon Elastic Container Service Developer Guide.

      Parameters:
      executionRoleArn - The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make Amazon Web Services API calls on your behalf. The task execution IAM role is required depending on the requirements of your task. For more information, see Amazon ECS task execution IAM role in the Amazon Elastic Container Service Developer Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • networkMode

      TaskDefinition.Builder networkMode(String networkMode)

      The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host. If no network mode is specified, the default is bridge.

      For Amazon ECS tasks on Fargate, the awsvpc network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, <default> or awsvpc can be used. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.

      With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached elastic network interface port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.

      When using the host network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.

      If the network mode is awsvpc, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.

      If the network mode is host, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.

      For more information, see Network settings in the Docker run reference.

      Parameters:
      networkMode - The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host. If no network mode is specified, the default is bridge.

      For Amazon ECS tasks on Fargate, the awsvpc network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, <default> or awsvpc can be used. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.

      With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached elastic network interface port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.

      When using the host network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.

      If the network mode is awsvpc, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.

      If the network mode is host, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.

      For more information, see Network settings in the Docker run reference.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • networkMode

      TaskDefinition.Builder networkMode(NetworkMode networkMode)

      The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host. If no network mode is specified, the default is bridge.

      For Amazon ECS tasks on Fargate, the awsvpc network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, <default> or awsvpc can be used. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.

      With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached elastic network interface port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.

      When using the host network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.

      If the network mode is awsvpc, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.

      If the network mode is host, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.

      For more information, see Network settings in the Docker run reference.

      Parameters:
      networkMode - The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host. If no network mode is specified, the default is bridge.

      For Amazon ECS tasks on Fargate, the awsvpc network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, <default> or awsvpc can be used. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.

      With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached elastic network interface port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.

      When using the host network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.

      If the network mode is awsvpc, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.

      If the network mode is host, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.

      For more information, see Network settings in the Docker run reference.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • revision

      TaskDefinition.Builder revision(Integer revision)

      The revision of the task in a particular family. The revision is a version number of a task definition in a family. When you register a task definition for the first time, the revision is 1. Each time that you register a new revision of a task definition in the same family, the revision value always increases by one. This is even if you deregistered previous revisions in this family.

      Parameters:
      revision - The revision of the task in a particular family. The revision is a version number of a task definition in a family. When you register a task definition for the first time, the revision is 1. Each time that you register a new revision of a task definition in the same family, the revision value always increases by one. This is even if you deregistered previous revisions in this family.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • volumes

      TaskDefinition.Builder volumes(Collection<Volume> volumes)

      The list of data volume definitions for the task. For more information, see Using data volumes in tasks in the Amazon Elastic Container Service Developer Guide.

      The host and sourcePath parameters aren't supported for tasks run on Fargate.

      Parameters:
      volumes - The list of data volume definitions for the task. For more information, see Using data volumes in tasks in the Amazon Elastic Container Service Developer Guide.

      The host and sourcePath parameters aren't supported for tasks run on Fargate.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • volumes

      TaskDefinition.Builder volumes(Volume... volumes)

      The list of data volume definitions for the task. For more information, see Using data volumes in tasks in the Amazon Elastic Container Service Developer Guide.

      The host and sourcePath parameters aren't supported for tasks run on Fargate.

      Parameters:
      volumes - The list of data volume definitions for the task. For more information, see Using data volumes in tasks in the Amazon Elastic Container Service Developer Guide.

      The host and sourcePath parameters aren't supported for tasks run on Fargate.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • volumes

      TaskDefinition.Builder volumes(Consumer<Volume.Builder>... volumes)

      The list of data volume definitions for the task. For more information, see Using data volumes in tasks in the Amazon Elastic Container Service Developer Guide.

      The host and sourcePath parameters aren't supported for tasks run on Fargate.

      This is a convenience method that creates an instance of the Volume.Builder avoiding the need to create one manually via Volume.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to volumes(List<Volume>).

      Parameters:
      volumes - a consumer that will call methods on Volume.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      TaskDefinition.Builder status(String status)

      The status of the task definition.

      Parameters:
      status - The status of the task definition.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      TaskDefinition.Builder status(TaskDefinitionStatus status)

      The status of the task definition.

      Parameters:
      status - The status of the task definition.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • requiresAttributes

      TaskDefinition.Builder requiresAttributes(Collection<Attribute> requiresAttributes)

      The container instance attributes required by your task. When an Amazon EC2 instance is registered to your cluster, the Amazon ECS container agent assigns some standard attributes to the instance. You can apply custom attributes. These are specified as key-value pairs using the Amazon ECS console or the PutAttributes API. These attributes are used when determining task placement for tasks hosted on Amazon EC2 instances. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.

      This parameter isn't supported for tasks run on Fargate.

      Parameters:
      requiresAttributes - The container instance attributes required by your task. When an Amazon EC2 instance is registered to your cluster, the Amazon ECS container agent assigns some standard attributes to the instance. You can apply custom attributes. These are specified as key-value pairs using the Amazon ECS console or the PutAttributes API. These attributes are used when determining task placement for tasks hosted on Amazon EC2 instances. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.

      This parameter isn't supported for tasks run on Fargate.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • requiresAttributes

      TaskDefinition.Builder requiresAttributes(Attribute... requiresAttributes)

      The container instance attributes required by your task. When an Amazon EC2 instance is registered to your cluster, the Amazon ECS container agent assigns some standard attributes to the instance. You can apply custom attributes. These are specified as key-value pairs using the Amazon ECS console or the PutAttributes API. These attributes are used when determining task placement for tasks hosted on Amazon EC2 instances. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.

      This parameter isn't supported for tasks run on Fargate.

      Parameters:
      requiresAttributes - The container instance attributes required by your task. When an Amazon EC2 instance is registered to your cluster, the Amazon ECS container agent assigns some standard attributes to the instance. You can apply custom attributes. These are specified as key-value pairs using the Amazon ECS console or the PutAttributes API. These attributes are used when determining task placement for tasks hosted on Amazon EC2 instances. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.

      This parameter isn't supported for tasks run on Fargate.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • requiresAttributes

      TaskDefinition.Builder requiresAttributes(Consumer<Attribute.Builder>... requiresAttributes)

      The container instance attributes required by your task. When an Amazon EC2 instance is registered to your cluster, the Amazon ECS container agent assigns some standard attributes to the instance. You can apply custom attributes. These are specified as key-value pairs using the Amazon ECS console or the PutAttributes API. These attributes are used when determining task placement for tasks hosted on Amazon EC2 instances. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.

      This parameter isn't supported for tasks run on Fargate.

      This is a convenience method that creates an instance of the Attribute.Builder avoiding the need to create one manually via Attribute.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to requiresAttributes(List<Attribute>).

      Parameters:
      requiresAttributes - a consumer that will call methods on Attribute.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • placementConstraints

      TaskDefinition.Builder placementConstraints(Collection<TaskDefinitionPlacementConstraint> placementConstraints)

      An array of placement constraint objects to use for tasks.

      This parameter isn't supported for tasks run on Fargate.

      Parameters:
      placementConstraints - An array of placement constraint objects to use for tasks.

      This parameter isn't supported for tasks run on Fargate.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • placementConstraints

      TaskDefinition.Builder placementConstraints(TaskDefinitionPlacementConstraint... placementConstraints)

      An array of placement constraint objects to use for tasks.

      This parameter isn't supported for tasks run on Fargate.

      Parameters:
      placementConstraints - An array of placement constraint objects to use for tasks.

      This parameter isn't supported for tasks run on Fargate.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • placementConstraints

      TaskDefinition.Builder placementConstraints(Consumer<TaskDefinitionPlacementConstraint.Builder>... placementConstraints)

      An array of placement constraint objects to use for tasks.

      This parameter isn't supported for tasks run on Fargate.

      This is a convenience method that creates an instance of the TaskDefinitionPlacementConstraint.Builder avoiding the need to create one manually via TaskDefinitionPlacementConstraint.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to placementConstraints(List<TaskDefinitionPlacementConstraint>).

      Parameters:
      placementConstraints - a consumer that will call methods on TaskDefinitionPlacementConstraint.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • compatibilitiesWithStrings

      TaskDefinition.Builder compatibilitiesWithStrings(Collection<String> compatibilities)

      The task launch types the task definition validated against during task definition registration. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

      Parameters:
      compatibilities - The task launch types the task definition validated against during task definition registration. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • compatibilitiesWithStrings

      TaskDefinition.Builder compatibilitiesWithStrings(String... compatibilities)

      The task launch types the task definition validated against during task definition registration. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

      Parameters:
      compatibilities - The task launch types the task definition validated against during task definition registration. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • compatibilities

      TaskDefinition.Builder compatibilities(Collection<Compatibility> compatibilities)

      The task launch types the task definition validated against during task definition registration. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

      Parameters:
      compatibilities - The task launch types the task definition validated against during task definition registration. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • compatibilities

      TaskDefinition.Builder compatibilities(Compatibility... compatibilities)

      The task launch types the task definition validated against during task definition registration. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

      Parameters:
      compatibilities - The task launch types the task definition validated against during task definition registration. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • runtimePlatform

      TaskDefinition.Builder runtimePlatform(RuntimePlatform runtimePlatform)

      The operating system that your task definitions are running on. A platform family is specified only for tasks using the Fargate launch type.

      When you specify a task in a service, this value must match the runtimePlatform value of the service.

      Parameters:
      runtimePlatform - The operating system that your task definitions are running on. A platform family is specified only for tasks using the Fargate launch type.

      When you specify a task in a service, this value must match the runtimePlatform value of the service.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • runtimePlatform

      default TaskDefinition.Builder runtimePlatform(Consumer<RuntimePlatform.Builder> runtimePlatform)

      The operating system that your task definitions are running on. A platform family is specified only for tasks using the Fargate launch type.

      When you specify a task in a service, this value must match the runtimePlatform value of the service.

      This is a convenience method that creates an instance of the RuntimePlatform.Builder avoiding the need to create one manually via RuntimePlatform.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to runtimePlatform(RuntimePlatform).

      Parameters:
      runtimePlatform - a consumer that will call methods on RuntimePlatform.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • requiresCompatibilitiesWithStrings

      TaskDefinition.Builder requiresCompatibilitiesWithStrings(Collection<String> requiresCompatibilities)

      The task launch types the task definition was validated against. The valid values are EC2, FARGATE, and EXTERNAL. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

      Parameters:
      requiresCompatibilities - The task launch types the task definition was validated against. The valid values are EC2 , FARGATE, and EXTERNAL. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • requiresCompatibilitiesWithStrings

      TaskDefinition.Builder requiresCompatibilitiesWithStrings(String... requiresCompatibilities)

      The task launch types the task definition was validated against. The valid values are EC2, FARGATE, and EXTERNAL. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

      Parameters:
      requiresCompatibilities - The task launch types the task definition was validated against. The valid values are EC2 , FARGATE, and EXTERNAL. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • requiresCompatibilities

      TaskDefinition.Builder requiresCompatibilities(Collection<Compatibility> requiresCompatibilities)

      The task launch types the task definition was validated against. The valid values are EC2, FARGATE, and EXTERNAL. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

      Parameters:
      requiresCompatibilities - The task launch types the task definition was validated against. The valid values are EC2 , FARGATE, and EXTERNAL. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • requiresCompatibilities

      TaskDefinition.Builder requiresCompatibilities(Compatibility... requiresCompatibilities)

      The task launch types the task definition was validated against. The valid values are EC2, FARGATE, and EXTERNAL. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

      Parameters:
      requiresCompatibilities - The task launch types the task definition was validated against. The valid values are EC2 , FARGATE, and EXTERNAL. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • cpu

      TaskDefinition.Builder cpu(String cpu)

      The number of cpu units used by the task. If you use the EC2 launch type, this field is optional. Any value can be used. If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines your range of valid values for the memory parameter.

      The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.

      • 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: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)

      • 4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)

      • 8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments

        This option requires Linux platform 1.4.0 or later.

      • 16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments

        This option requires Linux platform 1.4.0 or later.

      Parameters:
      cpu - The number of cpu units used by the task. If you use the EC2 launch type, this field is optional. Any value can be used. If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines your range of valid values for the memory parameter.

      The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.

      • 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: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)

      • 4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)

      • 8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments

        This option requires Linux platform 1.4.0 or later.

      • 16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments

        This option requires Linux platform 1.4.0 or later.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • memory

      TaskDefinition.Builder memory(String memory)

      The amount (in MiB) of memory used by the task.

      If your tasks runs on Amazon EC2 instances, you must specify either a task-level memory value or a container-level memory value. This field is optional and any value can be used. If a task-level memory value is specified, the container-level memory value is optional. For more information regarding container-level memory and memory reservation, see ContainerDefinition.

      If your tasks runs on Fargate, this field is required. You must use one of the following values. The value you choose 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 16 GB and 60 GB in 4 GB increments - Available cpu values: 8192 (8 vCPU)

        This option requires Linux platform 1.4.0 or later.

      • Between 32GB and 120 GB in 8 GB increments - Available cpu values: 16384 (16 vCPU)

        This option requires Linux platform 1.4.0 or later.

      Parameters:
      memory - The amount (in MiB) of memory used by the task.

      If your tasks runs on Amazon EC2 instances, you must specify either a task-level memory value or a container-level memory value. This field is optional and any value can be used. If a task-level memory value is specified, the container-level memory value is optional. For more information regarding container-level memory and memory reservation, see ContainerDefinition.

      If your tasks runs on Fargate, this field is required. You must use one of the following values. The value you choose 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 16 GB and 60 GB in 4 GB increments - Available cpu values: 8192 (8 vCPU)

        This option requires Linux platform 1.4.0 or later.

      • Between 32GB and 120 GB in 8 GB increments - Available cpu values: 16384 (16 vCPU)

        This option requires Linux platform 1.4.0 or later.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inferenceAccelerators

      TaskDefinition.Builder inferenceAccelerators(Collection<InferenceAccelerator> inferenceAccelerators)

      The Elastic Inference accelerator that's associated with the task.

      Parameters:
      inferenceAccelerators - The Elastic Inference accelerator that's associated with the task.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inferenceAccelerators

      TaskDefinition.Builder inferenceAccelerators(InferenceAccelerator... inferenceAccelerators)

      The Elastic Inference accelerator that's associated with the task.

      Parameters:
      inferenceAccelerators - The Elastic Inference accelerator that's associated with the task.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inferenceAccelerators

      TaskDefinition.Builder inferenceAccelerators(Consumer<InferenceAccelerator.Builder>... inferenceAccelerators)

      The Elastic Inference accelerator that's associated with the task.

      This is a convenience method that creates an instance of the InferenceAccelerator.Builder avoiding the need to create one manually via InferenceAccelerator.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to inferenceAccelerators(List<InferenceAccelerator>).

      Parameters:
      inferenceAccelerators - a consumer that will call methods on InferenceAccelerator.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • pidMode

      TaskDefinition.Builder pidMode(String pidMode)

      The process namespace to use for the containers in the task. The valid values are host or task. On Fargate for Linux containers, the only valid value is task. For example, monitoring sidecars might need pidMode to access information about other containers running in the same task.

      If host is specified, all containers within the tasks that specified the host PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance.

      If task is specified, all containers within the specified task share the same process namespace.

      If no value is specified, the default is a private namespace for each container. For more information, see PID settings in the Docker run reference.

      If the host PID mode is used, there's a heightened risk of undesired process namespace exposure. For more information, see Docker security.

      This parameter is not supported for Windows containers.

      This parameter is only supported for tasks that are hosted on Fargate if the tasks are using platform version 1.4.0 or later (Linux). This isn't supported for Windows containers on Fargate.

      Parameters:
      pidMode - The process namespace to use for the containers in the task. The valid values are host or task. On Fargate for Linux containers, the only valid value is task. For example, monitoring sidecars might need pidMode to access information about other containers running in the same task.

      If host is specified, all containers within the tasks that specified the host PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance.

      If task is specified, all containers within the specified task share the same process namespace.

      If no value is specified, the default is a private namespace for each container. For more information, see PID settings in the Docker run reference.

      If the host PID mode is used, there's a heightened risk of undesired process namespace exposure. For more information, see Docker security.

      This parameter is not supported for Windows containers.

      This parameter is only supported for tasks that are hosted on Fargate if the tasks are using platform version 1.4.0 or later (Linux). This isn't supported for Windows containers on Fargate.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • pidMode

      TaskDefinition.Builder pidMode(PidMode pidMode)

      The process namespace to use for the containers in the task. The valid values are host or task. On Fargate for Linux containers, the only valid value is task. For example, monitoring sidecars might need pidMode to access information about other containers running in the same task.

      If host is specified, all containers within the tasks that specified the host PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance.

      If task is specified, all containers within the specified task share the same process namespace.

      If no value is specified, the default is a private namespace for each container. For more information, see PID settings in the Docker run reference.

      If the host PID mode is used, there's a heightened risk of undesired process namespace exposure. For more information, see Docker security.

      This parameter is not supported for Windows containers.

      This parameter is only supported for tasks that are hosted on Fargate if the tasks are using platform version 1.4.0 or later (Linux). This isn't supported for Windows containers on Fargate.

      Parameters:
      pidMode - The process namespace to use for the containers in the task. The valid values are host or task. On Fargate for Linux containers, the only valid value is task. For example, monitoring sidecars might need pidMode to access information about other containers running in the same task.

      If host is specified, all containers within the tasks that specified the host PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance.

      If task is specified, all containers within the specified task share the same process namespace.

      If no value is specified, the default is a private namespace for each container. For more information, see PID settings in the Docker run reference.

      If the host PID mode is used, there's a heightened risk of undesired process namespace exposure. For more information, see Docker security.

      This parameter is not supported for Windows containers.

      This parameter is only supported for tasks that are hosted on Fargate if the tasks are using platform version 1.4.0 or later (Linux). This isn't supported for Windows containers on Fargate.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • ipcMode

      TaskDefinition.Builder ipcMode(String ipcMode)

      The IPC resource namespace to use for the containers in the task. The valid values are host, task, or none. If host is specified, then all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same IPC resources. If none is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference.

      If the host IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see Docker security.

      If you are setting namespaced kernel parameters using systemControls for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide.

      • For tasks that use the host IPC mode, IPC namespace related systemControls are not supported.

      • For tasks that use the task IPC mode, IPC namespace related systemControls will apply to all containers within a task.

      This parameter is not supported for Windows containers or tasks run on Fargate.

      Parameters:
      ipcMode - The IPC resource namespace to use for the containers in the task. The valid values are host, task, or none. If host is specified, then all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same IPC resources. If none is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference.

      If the host IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see Docker security.

      If you are setting namespaced kernel parameters using systemControls for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide.

      • For tasks that use the host IPC mode, IPC namespace related systemControls are not supported.

      • For tasks that use the task IPC mode, IPC namespace related systemControls will apply to all containers within a task.

      This parameter is not supported for Windows containers or tasks run on Fargate.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • ipcMode

      TaskDefinition.Builder ipcMode(IpcMode ipcMode)

      The IPC resource namespace to use for the containers in the task. The valid values are host, task, or none. If host is specified, then all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same IPC resources. If none is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference.

      If the host IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see Docker security.

      If you are setting namespaced kernel parameters using systemControls for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide.

      • For tasks that use the host IPC mode, IPC namespace related systemControls are not supported.

      • For tasks that use the task IPC mode, IPC namespace related systemControls will apply to all containers within a task.

      This parameter is not supported for Windows containers or tasks run on Fargate.

      Parameters:
      ipcMode - The IPC resource namespace to use for the containers in the task. The valid values are host, task, or none. If host is specified, then all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same IPC resources. If none is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference.

      If the host IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see Docker security.

      If you are setting namespaced kernel parameters using systemControls for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide.

      • For tasks that use the host IPC mode, IPC namespace related systemControls are not supported.

      • For tasks that use the task IPC mode, IPC namespace related systemControls will apply to all containers within a task.

      This parameter is not supported for Windows containers or tasks run on Fargate.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • proxyConfiguration

      TaskDefinition.Builder proxyConfiguration(ProxyConfiguration proxyConfiguration)

      The configuration details for the App Mesh proxy.

      Your Amazon ECS container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ecs-init package to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version 20190301 or later, they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

      Parameters:
      proxyConfiguration - The configuration details for the App Mesh proxy.

      Your Amazon ECS container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ecs-init package to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version 20190301 or later, they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • proxyConfiguration

      default TaskDefinition.Builder proxyConfiguration(Consumer<ProxyConfiguration.Builder> proxyConfiguration)

      The configuration details for the App Mesh proxy.

      Your Amazon ECS container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ecs-init package to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version 20190301 or later, they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

      This is a convenience method that creates an instance of the ProxyConfiguration.Builder avoiding the need to create one manually via ProxyConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to proxyConfiguration(ProxyConfiguration).

      Parameters:
      proxyConfiguration - a consumer that will call methods on ProxyConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • registeredAt

      TaskDefinition.Builder registeredAt(Instant registeredAt)

      The Unix timestamp for the time when the task definition was registered.

      Parameters:
      registeredAt - The Unix timestamp for the time when the task definition was registered.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deregisteredAt

      TaskDefinition.Builder deregisteredAt(Instant deregisteredAt)

      The Unix timestamp for the time when the task definition was deregistered.

      Parameters:
      deregisteredAt - The Unix timestamp for the time when the task definition was deregistered.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • registeredBy

      TaskDefinition.Builder registeredBy(String registeredBy)

      The principal that registered the task definition.

      Parameters:
      registeredBy - The principal that registered the task definition.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ephemeralStorage

      TaskDefinition.Builder ephemeralStorage(EphemeralStorage ephemeralStorage)

      The ephemeral storage settings to use for tasks run with the task definition.

      Parameters:
      ephemeralStorage - The ephemeral storage settings to use for tasks run with the task definition.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ephemeralStorage

      default TaskDefinition.Builder ephemeralStorage(Consumer<EphemeralStorage.Builder> ephemeralStorage)

      The ephemeral storage settings to use for tasks run with the task definition.

      This is a convenience method that creates an instance of the EphemeralStorage.Builder avoiding the need to create one manually via EphemeralStorage.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to ephemeralStorage(EphemeralStorage).

      Parameters:
      ephemeralStorage - a consumer that will call methods on EphemeralStorage.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: