public static interface Task.Builder extends SdkPojo, CopyableBuilder<Task.Builder,Task>
Modifier and Type | Method and Description |
---|---|
Task.Builder |
attachments(Attachment... attachments)
The Elastic Network Adapter associated with the task if the task uses the
awsvpc network mode. |
Task.Builder |
attachments(Collection<Attachment> attachments)
The Elastic Network Adapter associated with the task if the task uses the
awsvpc network mode. |
Task.Builder |
attachments(Consumer<Attachment.Builder>... attachments)
The Elastic Network Adapter associated with the task if the task uses the
awsvpc network mode. |
Task.Builder |
clusterArn(String clusterArn)
The ARN of the cluster that hosts the task.
|
Task.Builder |
connectivity(Connectivity connectivity)
The connectivity status of a task.
|
Task.Builder |
connectivity(String connectivity)
The connectivity status of a task.
|
Task.Builder |
connectivityAt(Instant connectivityAt)
The Unix timestamp for when the task last went into
CONNECTED status. |
Task.Builder |
containerInstanceArn(String containerInstanceArn)
The ARN of the container instances that host the task.
|
Task.Builder |
containers(Collection<Container> containers)
The containers associated with the task.
|
Task.Builder |
containers(Consumer<Container.Builder>... containers)
The containers associated with the task.
|
Task.Builder |
containers(Container... containers)
The containers associated with the task.
|
Task.Builder |
cpu(String cpu)
The number of CPU units used by the task as expressed in a task definition.
|
Task.Builder |
createdAt(Instant createdAt)
The Unix timestamp for when the task was created (the task entered the
PENDING state). |
Task.Builder |
desiredStatus(String desiredStatus)
The desired status of the task.
|
Task.Builder |
executionStoppedAt(Instant executionStoppedAt)
The Unix timestamp for when the task execution stopped.
|
Task.Builder |
group(String group)
The name of the task group associated with the task.
|
Task.Builder |
healthStatus(HealthStatus healthStatus)
The health status for the task, which is determined by the health of the essential containers in the task.
|
Task.Builder |
healthStatus(String healthStatus)
The health status for the task, which is determined by the health of the essential containers in the task.
|
Task.Builder |
lastStatus(String lastStatus)
The last known status of the task.
|
Task.Builder |
launchType(LaunchType launchType)
The launch type on which your task is running.
|
Task.Builder |
launchType(String launchType)
The launch type on which your task is running.
|
Task.Builder |
memory(String memory)
The amount of memory (in MiB) used by the task as expressed in a task definition.
|
default Task.Builder |
overrides(Consumer<TaskOverride.Builder> overrides)
One or more container overrides.
|
Task.Builder |
overrides(TaskOverride overrides)
One or more container overrides.
|
Task.Builder |
platformVersion(String platformVersion)
The platform version on which your task is running.
|
Task.Builder |
pullStartedAt(Instant pullStartedAt)
The Unix timestamp for when the container image pull began.
|
Task.Builder |
pullStoppedAt(Instant pullStoppedAt)
The Unix timestamp for when the container image pull completed.
|
Task.Builder |
startedAt(Instant startedAt)
The Unix timestamp for when the task started (the task transitioned from the
PENDING state to
the RUNNING state). |
Task.Builder |
startedBy(String startedBy)
The tag specified when a task is started.
|
Task.Builder |
stopCode(String stopCode)
The stop code indicating why a task was stopped.
|
Task.Builder |
stopCode(TaskStopCode stopCode)
The stop code indicating why a task was stopped.
|
Task.Builder |
stoppedAt(Instant stoppedAt)
The Unix timestamp for when the task was stopped (the task transitioned from the
RUNNING state
to the STOPPED state). |
Task.Builder |
stoppedReason(String stoppedReason)
The reason that the task was stopped.
|
Task.Builder |
stoppingAt(Instant stoppingAt)
The Unix timestamp for when the task stops (transitions from the
RUNNING state to
STOPPED ). |
Task.Builder |
tags(Collection<Tag> tags)
The metadata that you apply to the task to help you categorize and organize them.
|
Task.Builder |
tags(Consumer<Tag.Builder>... tags)
The metadata that you apply to the task to help you categorize and organize them.
|
Task.Builder |
tags(Tag... tags)
The metadata that you apply to the task to help you categorize and organize them.
|
Task.Builder |
taskArn(String taskArn)
The Amazon Resource Name (ARN) of the task.
|
Task.Builder |
taskDefinitionArn(String taskDefinitionArn)
The ARN of the task definition that creates the task.
|
Task.Builder |
version(Long version)
The version counter for the task.
|
copy
applyMutation, build
Task.Builder taskArn(String taskArn)
The Amazon Resource Name (ARN) of the task.
taskArn
- The Amazon Resource Name (ARN) of the task.Task.Builder clusterArn(String clusterArn)
The ARN of the cluster that hosts the task.
clusterArn
- The ARN of the cluster that hosts the task.Task.Builder taskDefinitionArn(String taskDefinitionArn)
The ARN of the task definition that creates the task.
taskDefinitionArn
- The ARN of the task definition that creates the task.Task.Builder containerInstanceArn(String containerInstanceArn)
The ARN of the container instances that host the task.
containerInstanceArn
- The ARN of the container instances that host the task.Task.Builder overrides(TaskOverride overrides)
One or more container overrides.
overrides
- One or more container overrides.default Task.Builder overrides(Consumer<TaskOverride.Builder> overrides)
One or more container overrides.
This is a convenience that creates an instance of theTaskOverride.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)
.overrides
- a consumer that will call methods on TaskOverride.Builder
overrides(TaskOverride)
Task.Builder lastStatus(String lastStatus)
The last known status of the task. For more information, see Task Lifecycle.
lastStatus
- The last known status of the task. For more information, see Task
Lifecycle.Task.Builder desiredStatus(String desiredStatus)
The desired status of the task. For more information, see Task Lifecycle.
desiredStatus
- The desired status of the task. For more information, see Task
Lifecycle.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 indicating the CPU
units when the task definition is registered.
If you are using the EC2 launch type, this field is optional. Supported values are between 128
CPU units (0.125
vCPUs) and 10240
CPU units (10
vCPUs).
If you are using the Fargate launch type, this field is required and you must use one of the following
values, which determines your range of supported values for the memory
parameter:
256 (.25 vCPU) - Available memory
values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory
values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory
values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB),
6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory
values: Between 4096 (4 GB) and 16384 (16 GB) in increments of
1024 (1 GB)
4096 (4 vCPU) - Available memory
values: Between 8192 (8 GB) and 30720 (30 GB) in increments of
1024 (1 GB)
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 indicating the CPU units when the task definition is registered.
If you are using the EC2 launch type, this field is optional. Supported values are between
128
CPU units (0.125
vCPUs) and 10240
CPU units (
10
vCPUs).
If you are using the Fargate launch type, this field is required and you must use one of the following
values, which determines your range of supported values for the memory
parameter:
256 (.25 vCPU) - Available memory
values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory
values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4
GB)
1024 (1 vCPU) - Available memory
values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5
GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory
values: Between 4096 (4 GB) and 16384 (16 GB) in
increments of 1024 (1 GB)
4096 (4 vCPU) - Available memory
values: Between 8192 (8 GB) and 30720 (30 GB) in
increments of 1024 (1 GB)
Task.Builder memory(String memory)
The amount of memory (in MiB) used by the task as expressed in a task definition. It can be expressed as an
integer using MiB, for example 1024
. It can also be expressed as a string using GB, for example
1GB
or 1 GB
. String values are converted to an integer indicating the MiB when the
task definition is registered.
If you are using the EC2 launch type, this field is optional.
If you are using the Fargate launch type, this field is required and you must use one of the following
values, which determines your range of 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)
memory
- The amount of memory (in MiB) used by the task as expressed in a task definition. It can be expressed
as an integer using MiB, for example 1024
. It can also be expressed as a string using GB,
for example 1GB
or 1 GB
. String values are converted to an integer
indicating the MiB when the task definition is registered.
If you are using the EC2 launch type, this field is optional.
If you are using the Fargate launch type, this field is required and you must use one of the following
values, which determines your range of 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)
Task.Builder containers(Collection<Container> containers)
The containers associated with the task.
containers
- The containers associated with the task.Task.Builder containers(Container... containers)
The containers associated with the task.
containers
- The containers associated with the task.Task.Builder containers(Consumer<Container.Builder>... containers)
The containers associated with the task.
This is a convenience that creates an instance of theList.Builder
avoiding the need to
create one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately and its
result is passed to #containers(List)
.containers
- a consumer that will call methods on List.Builder
#containers(List)
Task.Builder startedBy(String startedBy)
The tag specified when a task is started. If the task is started by an Amazon ECS service, then the
startedBy
parameter contains the deployment ID of the service that starts it.
startedBy
- The tag specified when a task is started. If the task is started by an Amazon ECS service, then the
startedBy
parameter contains the deployment ID of the service that starts it.Task.Builder version(Long version)
The version counter for the task. Every time a task experiences a change that triggers a CloudWatch event,
the version counter is incremented. If you are replicating your Amazon ECS task state with CloudWatch Events,
you can compare the version of a task reported by the Amazon ECS API actionss 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.
version
- The version counter for the task. Every time a task experiences a change that triggers a CloudWatch
event, the version counter is incremented. If you are replicating your Amazon ECS task state with
CloudWatch Events, you can compare the version of a task reported by the Amazon ECS API actionss 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.Task.Builder stoppedReason(String stoppedReason)
The reason that the task was stopped.
stoppedReason
- The reason that the task was stopped.Task.Builder stopCode(String stopCode)
The stop code indicating why a task was stopped. The stoppedReason
may contain additional
details.
stopCode
- The stop code indicating why a task was stopped. The stoppedReason
may contain additional
details.TaskStopCode
,
TaskStopCode
Task.Builder stopCode(TaskStopCode stopCode)
The stop code indicating why a task was stopped. The stoppedReason
may contain additional
details.
stopCode
- The stop code indicating why a task was stopped. The stoppedReason
may contain additional
details.TaskStopCode
,
TaskStopCode
Task.Builder connectivity(String connectivity)
The connectivity status of a task.
connectivity
- The connectivity status of a task.Connectivity
,
Connectivity
Task.Builder connectivity(Connectivity connectivity)
The connectivity status of a task.
connectivity
- The connectivity status of a task.Connectivity
,
Connectivity
Task.Builder connectivityAt(Instant connectivityAt)
The Unix timestamp for when the task last went into CONNECTED
status.
connectivityAt
- The Unix timestamp for when the task last went into CONNECTED
status.Task.Builder pullStartedAt(Instant pullStartedAt)
The Unix timestamp for when the container image pull began.
pullStartedAt
- The Unix timestamp for when the container image pull began.Task.Builder pullStoppedAt(Instant pullStoppedAt)
The Unix timestamp for when the container image pull completed.
pullStoppedAt
- The Unix timestamp for when the container image pull completed.Task.Builder executionStoppedAt(Instant executionStoppedAt)
The Unix timestamp for when the task execution stopped.
executionStoppedAt
- The Unix timestamp for when the task execution stopped.Task.Builder createdAt(Instant createdAt)
The Unix timestamp for when the task was created (the task entered the PENDING
state).
createdAt
- The Unix timestamp for when the task was created (the task entered the PENDING
state).Task.Builder startedAt(Instant startedAt)
The Unix timestamp for when the task started (the task transitioned from the PENDING
state to
the RUNNING
state).
startedAt
- The Unix timestamp for when the task started (the task transitioned from the PENDING
state to the RUNNING
state).Task.Builder stoppingAt(Instant stoppingAt)
The Unix timestamp for when the task stops (transitions from the RUNNING
state to
STOPPED
).
stoppingAt
- The Unix timestamp for when the task stops (transitions from the RUNNING
state to
STOPPED
).Task.Builder stoppedAt(Instant stoppedAt)
The Unix timestamp for when the task was stopped (the task transitioned from the RUNNING
state
to the STOPPED
state).
stoppedAt
- The Unix timestamp for when the task was stopped (the task transitioned from the RUNNING
state to the STOPPED
state).Task.Builder group(String group)
The name of the task group associated with the task.
group
- The name of the task group associated with the task.Task.Builder launchType(String launchType)
The launch type on which your task is running. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
launchType
- The launch type on which your task is running. For more information, see Amazon ECS Launch
Types in the Amazon Elastic Container Service Developer Guide.LaunchType
,
LaunchType
Task.Builder launchType(LaunchType launchType)
The launch type on which your task is running. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
launchType
- The launch type on which your task is running. For more information, see Amazon ECS Launch
Types in the Amazon Elastic Container Service Developer Guide.LaunchType
,
LaunchType
Task.Builder platformVersion(String platformVersion)
The platform version on which your task is running. A platform version is only specified for tasks using the
Fargate launch type. If one is not specified, the LATEST
platform version is used by default.
For more information, see AWS Fargate Platform
Versions in the Amazon Elastic Container Service Developer Guide.
platformVersion
- The platform version on which your task is running. A platform version is only specified for tasks
using the Fargate launch type. If one is not specified, the LATEST
platform version is
used by default. For more information, see AWS Fargate
Platform Versions in the Amazon Elastic Container Service Developer Guide.Task.Builder attachments(Collection<Attachment> attachments)
The Elastic Network Adapter associated with the task if the task uses the awsvpc
network mode.
attachments
- The Elastic Network Adapter associated with the task if the task uses the awsvpc
network
mode.Task.Builder attachments(Attachment... attachments)
The Elastic Network Adapter associated with the task if the task uses the awsvpc
network mode.
attachments
- The Elastic Network Adapter associated with the task if the task uses the awsvpc
network
mode.Task.Builder attachments(Consumer<Attachment.Builder>... attachments)
The Elastic Network Adapter associated with the task if the task uses the awsvpc
network mode.
List.Builder
avoiding the need to
create one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately and its
result is passed to #attachments(List)
.attachments
- a consumer that will call methods on List.Builder
#attachments(List)
Task.Builder healthStatus(String healthStatus)
The health status for the task, which is determined by the health of the essential containers in the task. If
all essential containers in the task are reporting as HEALTHY
, then the task status also reports
as HEALTHY
. If any essential containers in the task are reporting as UNHEALTHY
or
UNKNOWN
, then the task status also reports as UNHEALTHY
or UNKNOWN
,
accordingly.
The Amazon ECS container agent does not monitor or report on Docker health checks that are embedded in a container image (such as those specified in a parent image or from the image's Dockerfile) and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image.
healthStatus
- The health status for the task, which is determined by the health of the essential containers in the
task. If all essential containers in the task are reporting as HEALTHY
, then the task
status also reports as HEALTHY
. If any essential containers in the task are reporting as
UNHEALTHY
or UNKNOWN
, then the task status also reports as
UNHEALTHY
or UNKNOWN
, accordingly. The Amazon ECS container agent does not monitor or report on Docker health checks that are embedded in a container image (such as those specified in a parent image or from the image's Dockerfile) and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image.
HealthStatus
,
HealthStatus
Task.Builder healthStatus(HealthStatus healthStatus)
The health status for the task, which is determined by the health of the essential containers in the task. If
all essential containers in the task are reporting as HEALTHY
, then the task status also reports
as HEALTHY
. If any essential containers in the task are reporting as UNHEALTHY
or
UNKNOWN
, then the task status also reports as UNHEALTHY
or UNKNOWN
,
accordingly.
The Amazon ECS container agent does not monitor or report on Docker health checks that are embedded in a container image (such as those specified in a parent image or from the image's Dockerfile) and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image.
healthStatus
- The health status for the task, which is determined by the health of the essential containers in the
task. If all essential containers in the task are reporting as HEALTHY
, then the task
status also reports as HEALTHY
. If any essential containers in the task are reporting as
UNHEALTHY
or UNKNOWN
, then the task status also reports as
UNHEALTHY
or UNKNOWN
, accordingly. The Amazon ECS container agent does not monitor or report on Docker health checks that are embedded in a container image (such as those specified in a parent image or from the image's Dockerfile) and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image.
HealthStatus
,
HealthStatus
Task.Builder tags(Collection<Tag> tags)
The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
tags
- The metadata that you apply to the task to help you categorize and organize them. Each tag consists of
a key and an optional value, both of which you define. Tag keys can have a maximum character length of
128 characters, and tag values can have a maximum length of 256 characters.Task.Builder tags(Tag... tags)
The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
tags
- The metadata that you apply to the task to help you categorize and organize them. Each tag consists of
a key and an optional value, both of which you define. Tag keys can have a maximum character length of
128 characters, and tag values can have a maximum length of 256 characters.Task.Builder tags(Consumer<Tag.Builder>... tags)
The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
This is a convenience that creates an instance of theList.Builder
avoiding the need to create
one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately and its result
is passed to #tags(List)
.tags
- a consumer that will call methods on List.Builder
#tags(List)
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.