Interface Task.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Task.Builder,Task>, SdkBuilder<Task.Builder,Task>, SdkPojo
Enclosing class:
Task
@Mutable @NotThreadSafe public static interface Task.Builder extends SdkPojo, CopyableBuilder<Task.Builder,Task>

  • Method Details

    • attachments

      Task.Builder attachments(Collection<Attachment> attachments)

      The Elastic Network Adapter that's associated with the task if the task uses the awsvpc network mode.

      Parameters:
      attachments - The Elastic Network Adapter that's associated with the task if the task uses the awsvpc network mode.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attachments

      Task.Builder attachments(Attachment... attachments)

      The Elastic Network Adapter that's associated with the task if the task uses the awsvpc network mode.

      Parameters:
      attachments - The Elastic Network Adapter that's associated with the task if the task uses the awsvpc network mode.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attachments

      Task.Builder attachments(Consumer<Attachment.Builder>... attachments)

      The Elastic Network Adapter that's associated with the task if the task uses the awsvpc network mode.

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

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

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

    • attributes

      Task.Builder attributes(Collection<Attribute> attributes)

      The attributes of the task

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

    • attributes

      Task.Builder attributes(Attribute... attributes)

      The attributes of the task

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

    • attributes

      Task.Builder attributes(Consumer<Attribute.Builder>... attributes)

      The attributes of the task

      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 attributes(List<Attribute>).

      Parameters:
      attributes - 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:

    • availabilityZone

      Task.Builder availabilityZone(String availabilityZone)

      The Availability Zone for the task.

      Parameters:
      availabilityZone - The Availability Zone for the task.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • capacityProviderName

      Task.Builder capacityProviderName(String capacityProviderName)

      The capacity provider that's associated with the task.

      Parameters:
      capacityProviderName - The capacity provider that's associated with the task.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clusterArn

      Task.Builder clusterArn(String clusterArn)

      The ARN of the cluster that hosts the task.

      Parameters:
      clusterArn - The ARN of the cluster that hosts the task.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • connectivity

      Task.Builder connectivity(String connectivity)

      The connectivity status of a task.

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

    • connectivity

      Task.Builder connectivity(Connectivity connectivity)

      The connectivity status of a task.

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

    • connectivityAt

      Task.Builder connectivityAt(Instant connectivityAt)

      The Unix timestamp for the time when the task last went into CONNECTED status.

      Parameters:
      connectivityAt - The Unix timestamp for the time when the task last went into CONNECTED status.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • containerInstanceArn

      Task.Builder containerInstanceArn(String containerInstanceArn)

      The ARN of the container instances that host the task.

      Parameters:
      containerInstanceArn - The ARN of the container instances that host the task.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • containers

      Task.Builder containers(Collection<Container> containers)

      The containers that's associated with the task.

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

    • containers

      Task.Builder containers(Container... containers)

      The containers that's associated with the task.

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

    • containers

      Task.Builder containers(Consumer<Container.Builder>... containers)

      The containers that's associated with the task.

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

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

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

    • cpu

      Task.Builder cpu(String cpu)

      The number of CPU units used by the task as expressed in a task definition. It can be expressed as an integer using CPU units (for example, 1024). It can also be expressed as a string using vCPUs (for example, 1 vCPU or 1 vcpu). String values are converted to an integer that indicates the CPU units when the task definition is registered.

      If you're using the EC2 launch type or the external launch type, this field is optional. Supported values are between 128 CPU units (0.125 vCPUs) and 196608 CPU units ( 192 vCPUs). If you do not specify a value, the parameter is ignored.

      This field is required for Fargate. For information about the valid values, see Task size in the Amazon Elastic Container Service Developer Guide.

      Parameters:
      cpu - The number of CPU units used by the task as expressed in a task definition. It can be expressed as an integer using CPU units (for example, 1024). It can also be expressed as a string using vCPUs (for example, 1 vCPU or 1 vcpu). String values are converted to an integer that indicates the CPU units when the task definition is registered.

      If you're using the EC2 launch type or the external launch type, this field is optional. Supported values are between 128 CPU units (0.125 vCPUs) and 196608 CPU units (192 vCPUs). If you do not specify a value, the parameter is ignored.

      This field is required for Fargate. For information about the valid values, see Task size in the Amazon Elastic Container Service Developer Guide.

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

    • createdAt

      Task.Builder createdAt(Instant createdAt)

      The Unix timestamp for the time when the task was created. More specifically, it's for the time when the task entered the PENDING state.

      Parameters:
      createdAt - The Unix timestamp for the time when the task was created. More specifically, it's for the time when the task entered the PENDING state.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • desiredStatus

      Task.Builder desiredStatus(String desiredStatus)

      The desired status of the task. For more information, see Task Lifecycle.

      Parameters:
      desiredStatus - The desired status of the task. For more information, see Task Lifecycle.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • enableExecuteCommand

      Task.Builder enableExecuteCommand(Boolean enableExecuteCommand)

      Determines whether execute command functionality is turned on for this task. If true, execute command functionality is turned on all the containers in the task.

      Parameters:
      enableExecuteCommand - Determines whether execute command functionality is turned on for this task. If true, execute command functionality is turned on all the containers in the task.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • executionStoppedAt

      Task.Builder executionStoppedAt(Instant executionStoppedAt)

      The Unix timestamp for the time when the task execution stopped.

      Parameters:
      executionStoppedAt - The Unix timestamp for the time when the task execution stopped.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • group

      Task.Builder group(String group)

      The name of the task group that's associated with the task.

      Parameters:
      group - The name of the task group that's associated with the task.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • healthStatus

      Task.Builder healthStatus(String healthStatus)

      The health status for the task. It's determined by the health of the essential containers in the task. If all essential containers in the task are reporting as HEALTHY, the task status also reports as HEALTHY. If any essential containers in the task are reporting as UNHEALTHY or UNKNOWN, the task status also reports as UNHEALTHY or UNKNOWN.

      The Amazon ECS container agent doesn't monitor or report on Docker health checks that are embedded in a container image and not specified in the container definition. For example, this includes those specified in a parent image or from the image's Dockerfile. Health check parameters that are specified in a container definition override any Docker health checks that are found in the container image.

      Parameters:
      healthStatus - The health status for the task. It's determined by the health of the essential containers in the task. If all essential containers in the task are reporting as HEALTHY, the task status also reports as HEALTHY. If any essential containers in the task are reporting as UNHEALTHY or UNKNOWN, the task status also reports as UNHEALTHY or UNKNOWN.

      The Amazon ECS container agent doesn't monitor or report on Docker health checks that are embedded in a container image and not specified in the container definition. For example, this includes those specified in a parent image or from the image's Dockerfile. Health check parameters that are specified in a container definition override any Docker health checks that are found in the container image.

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

    • healthStatus

      Task.Builder healthStatus(HealthStatus healthStatus)

      The health status for the task. It's determined by the health of the essential containers in the task. If all essential containers in the task are reporting as HEALTHY, the task status also reports as HEALTHY. If any essential containers in the task are reporting as UNHEALTHY or UNKNOWN, the task status also reports as UNHEALTHY or UNKNOWN.

      The Amazon ECS container agent doesn't monitor or report on Docker health checks that are embedded in a container image and not specified in the container definition. For example, this includes those specified in a parent image or from the image's Dockerfile. Health check parameters that are specified in a container definition override any Docker health checks that are found in the container image.

      Parameters:
      healthStatus - The health status for the task. It's determined by the health of the essential containers in the task. If all essential containers in the task are reporting as HEALTHY, the task status also reports as HEALTHY. If any essential containers in the task are reporting as UNHEALTHY or UNKNOWN, the task status also reports as UNHEALTHY or UNKNOWN.

      The Amazon ECS container agent doesn't monitor or report on Docker health checks that are embedded in a container image and not specified in the container definition. For example, this includes those specified in a parent image or from the image's Dockerfile. Health check parameters that are specified in a container definition override any Docker health checks that are found in the container image.

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

    • inferenceAccelerators

      Task.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

      Task.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

      Task.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:

    • lastStatus

      Task.Builder lastStatus(String lastStatus)

      The last known status for the task. For more information, see Task Lifecycle.

      Parameters:
      lastStatus - The last known status for the task. For more information, see Task Lifecycle.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • launchType

      Task.Builder launchType(String launchType)

      The infrastructure where your task runs on. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

      Parameters:
      launchType - The infrastructure where your task runs on. 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.
      See Also:

    • launchType

      Task.Builder launchType(LaunchType launchType)

      The infrastructure where your task runs on. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

      Parameters:
      launchType - The infrastructure where your task runs on. 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.
      See Also:

    • memory

      Task.Builder memory(String memory)

      The amount of memory (in MiB) that the task uses as expressed in a task definition. It can be expressed as an integer using MiB (for example, 1024). If it's expressed as a string using GB (for example, 1GB or 1 GB), it's converted to an integer indicating the MiB when the task definition is registered.

      If you use the EC2 launch type, this field is optional.

      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 the range of supported 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 of memory (in MiB) that the task uses as expressed in a task definition. It can be expressed as an integer using MiB (for example, 1024). If it's expressed as a string using GB (for example, 1GB or 1 GB), it's converted to an integer indicating the MiB when the task definition is registered.

      If you use the EC2 launch type, this field is optional.

      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 the range of supported 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.

    • overrides

      Task.Builder overrides(TaskOverride overrides)

      One or more container overrides.

      Parameters:
      overrides - One or more container overrides.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrides

      default Task.Builder overrides(Consumer<TaskOverride.Builder> overrides)

      One or more container overrides.

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

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

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

    • platformVersion

      Task.Builder platformVersion(String platformVersion)

      The platform version where your task runs on. A platform version is only specified for tasks that use the Fargate launch type. If you didn't specify one, the LATEST platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

      Parameters:
      platformVersion - The platform version where your task runs on. A platform version is only specified for tasks that use the Fargate launch type. If you didn't specify one, the LATEST platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • platformFamily

      Task.Builder platformFamily(String platformFamily)

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

      All tasks that run as part of this service must use the same platformFamily value as the service (for example, LINUX.).

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

      All tasks that run as part of this service must use the same platformFamily value as the service (for example, LINUX.).

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

    • pullStartedAt

      Task.Builder pullStartedAt(Instant pullStartedAt)

      The Unix timestamp for the time when the container image pull began.

      Parameters:
      pullStartedAt - The Unix timestamp for the time when the container image pull began.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • pullStoppedAt

      Task.Builder pullStoppedAt(Instant pullStoppedAt)

      The Unix timestamp for the time when the container image pull completed.

      Parameters:
      pullStoppedAt - The Unix timestamp for the time when the container image pull completed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • startedAt

      Task.Builder startedAt(Instant startedAt)

      The Unix timestamp for the time when the task started. More specifically, it's for the time when the task transitioned from the PENDING state to the RUNNING state.

      Parameters:
      startedAt - The Unix timestamp for the time when the task started. More specifically, it's for the time when the task transitioned from the PENDING state to the RUNNING state.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • startedBy

      Task.Builder startedBy(String startedBy)

      The tag specified when a task is started. If an Amazon ECS service started the task, the startedBy parameter contains the deployment ID of that service.

      Parameters:
      startedBy - The tag specified when a task is started. If an Amazon ECS service started the task, the startedBy parameter contains the deployment ID of that service.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stopCode

      Task.Builder stopCode(String stopCode)

      The stop code indicating why a task was stopped. The stoppedReason might contain additional details.

      For more information about stop code, see Stopped tasks error codes in the Amazon ECS Developer Guide.

      Parameters:
      stopCode - The stop code indicating why a task was stopped. The stoppedReason might contain additional details.

      For more information about stop code, see Stopped tasks error codes in the Amazon ECS Developer Guide.

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

    • stopCode

      Task.Builder stopCode(TaskStopCode stopCode)

      The stop code indicating why a task was stopped. The stoppedReason might contain additional details.

      For more information about stop code, see Stopped tasks error codes in the Amazon ECS Developer Guide.

      Parameters:
      stopCode - The stop code indicating why a task was stopped. The stoppedReason might contain additional details.

      For more information about stop code, see Stopped tasks error codes in the Amazon ECS Developer Guide.

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

    • stoppedAt

      Task.Builder stoppedAt(Instant stoppedAt)

      The Unix timestamp for the time when the task was stopped. More specifically, it's for the time when the task transitioned from the RUNNING state to the STOPPED state.

      Parameters:
      stoppedAt - The Unix timestamp for the time when the task was stopped. More specifically, it's for the time when the task transitioned from the RUNNING state to the STOPPED state.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stoppedReason

      Task.Builder stoppedReason(String stoppedReason)

      The reason that the task was stopped.

      Parameters:
      stoppedReason - The reason that the task was stopped.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stoppingAt

      Task.Builder stoppingAt(Instant stoppingAt)

      The Unix timestamp for the time when the task stops. More specifically, it's for the time when the task transitions from the RUNNING state to STOPPING.

      Parameters:
      stoppingAt - The Unix timestamp for the time when the task stops. More specifically, it's for the time when the task transitions from the RUNNING state to STOPPING.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      Task.Builder tags(Collection<Tag> tags)

      The metadata that you apply to the task to help you categorize and organize the task. Each tag consists of a key and an optional value. You define both the key and value.

      The following basic restrictions apply to tags:

      • Maximum number of tags per resource - 50

      • For each resource, each tag key must be unique, and each tag key can have only one value.

      • Maximum key length - 128 Unicode characters in UTF-8

      • Maximum value length - 256 Unicode characters in UTF-8

      • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

      • Tag keys and values are case-sensitive.

      • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

      Parameters:
      tags - The metadata that you apply to the task to help you categorize and organize the task. Each tag consists of a key and an optional value. You define both the key and value.

      The following basic restrictions apply to tags:

      • Maximum number of tags per resource - 50

      • For each resource, each tag key must be unique, and each tag key can have only one value.

      • Maximum key length - 128 Unicode characters in UTF-8

      • Maximum value length - 256 Unicode characters in UTF-8

      • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

      • Tag keys and values are case-sensitive.

      • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

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

    • tags

      Task.Builder tags(Tag... tags)

      The metadata that you apply to the task to help you categorize and organize the task. Each tag consists of a key and an optional value. You define both the key and value.

      The following basic restrictions apply to tags:

      • Maximum number of tags per resource - 50

      • For each resource, each tag key must be unique, and each tag key can have only one value.

      • Maximum key length - 128 Unicode characters in UTF-8

      • Maximum value length - 256 Unicode characters in UTF-8

      • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

      • Tag keys and values are case-sensitive.

      • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

      Parameters:
      tags - The metadata that you apply to the task to help you categorize and organize the task. Each tag consists of a key and an optional value. You define both the key and value.

      The following basic restrictions apply to tags:

      • Maximum number of tags per resource - 50

      • For each resource, each tag key must be unique, and each tag key can have only one value.

      • Maximum key length - 128 Unicode characters in UTF-8

      • Maximum value length - 256 Unicode characters in UTF-8

      • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

      • Tag keys and values are case-sensitive.

      • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

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

    • tags

      Task.Builder tags(Consumer<Tag.Builder>... tags)

      The metadata that you apply to the task to help you categorize and organize the task. Each tag consists of a key and an optional value. You define both the key and value.

      The following basic restrictions apply to tags:

      • Maximum number of tags per resource - 50

      • For each resource, each tag key must be unique, and each tag key can have only one value.

      • Maximum key length - 128 Unicode characters in UTF-8

      • Maximum value length - 256 Unicode characters in UTF-8

      • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

      • Tag keys and values are case-sensitive.

      • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

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

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

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

    • taskArn

      Task.Builder taskArn(String taskArn)

      The Amazon Resource Name (ARN) of the task.

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

    • taskDefinitionArn

      Task.Builder taskDefinitionArn(String taskDefinitionArn)

      The ARN of the task definition that creates the task.

      Parameters:
      taskDefinitionArn - The ARN of the task definition that creates the task.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • version

      Task.Builder version(Long version)

      The version counter for the task. Every time a task experiences a change that starts a CloudWatch event, the version counter is incremented. If you replicate your Amazon ECS task state with CloudWatch Events, you can compare the version of a task reported by the Amazon ECS API actions with the version reported in CloudWatch Events for the task (inside the detail object) to verify that the version in your event stream is current.

      Parameters:
      version - The version counter for the task. Every time a task experiences a change that starts a CloudWatch event, the version counter is incremented. If you replicate your Amazon ECS task state with CloudWatch Events, you can compare the version of a task reported by the Amazon ECS API actions with the version reported in CloudWatch Events for the task (inside the detail object) to verify that the version in your event stream is current.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ephemeralStorage

      Task.Builder ephemeralStorage(EphemeralStorage ephemeralStorage)

      The ephemeral storage settings for the task.

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

    • ephemeralStorage

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

      The ephemeral storage settings for the task.

      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:

    • fargateEphemeralStorage

      Task.Builder fargateEphemeralStorage(TaskEphemeralStorage fargateEphemeralStorage)

      The Fargate ephemeral storage settings for the task.

      Parameters:
      fargateEphemeralStorage - The Fargate ephemeral storage settings for the task.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fargateEphemeralStorage

      default Task.Builder fargateEphemeralStorage(Consumer<TaskEphemeralStorage.Builder> fargateEphemeralStorage)

      The Fargate ephemeral storage settings for the task.

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

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

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