Interface Task.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<Task.Builder,
,Task> SdkBuilder<Task.Builder,
,Task> SdkPojo
- Enclosing class:
Task
-
Method Summary
Modifier and TypeMethodDescriptionattachments
(Collection<Attachment> attachments) The Elastic Network Adapter that's associated with the task if the task uses theawsvpc
network mode.attachments
(Consumer<Attachment.Builder>... attachments) The Elastic Network Adapter that's associated with the task if the task uses theawsvpc
network mode.attachments
(Attachment... attachments) The Elastic Network Adapter that's associated with the task if the task uses theawsvpc
network mode.attributes
(Collection<Attribute> attributes) The attributes of the taskattributes
(Consumer<Attribute.Builder>... attributes) The attributes of the taskattributes
(Attribute... attributes) The attributes of the taskavailabilityZone
(String availabilityZone) The Availability Zone for the task.capacityProviderName
(String capacityProviderName) The capacity provider that's associated with the task.clusterArn
(String clusterArn) The ARN of the cluster that hosts the task.connectivity
(String connectivity) The connectivity status of a task.connectivity
(Connectivity connectivity) The connectivity status of a task.connectivityAt
(Instant connectivityAt) The Unix timestamp for the time when the task last went intoCONNECTED
status.containerInstanceArn
(String containerInstanceArn) The ARN of the container instances that host the task.containers
(Collection<Container> containers) The containers that's associated with the task.containers
(Consumer<Container.Builder>... containers) The containers that's associated with the task.containers
(Container... containers) The containers that's associated with the task.The number of CPU units used by the task as expressed in a task definition.The Unix timestamp for the time when the task was created.desiredStatus
(String desiredStatus) The desired status of the task.enableExecuteCommand
(Boolean enableExecuteCommand) Determines whether execute command functionality is turned on for this task.default Task.Builder
ephemeralStorage
(Consumer<EphemeralStorage.Builder> ephemeralStorage) The ephemeral storage settings for the task.ephemeralStorage
(EphemeralStorage ephemeralStorage) The ephemeral storage settings for the task.executionStoppedAt
(Instant executionStoppedAt) The Unix timestamp for the time when the task execution stopped.The name of the task group that's associated with the task.healthStatus
(String healthStatus) The health status for the task.healthStatus
(HealthStatus healthStatus) The health status for the task.inferenceAccelerators
(Collection<InferenceAccelerator> inferenceAccelerators) The Elastic Inference accelerator that's associated with the task.inferenceAccelerators
(Consumer<InferenceAccelerator.Builder>... inferenceAccelerators) The Elastic Inference accelerator that's associated with the task.inferenceAccelerators
(InferenceAccelerator... inferenceAccelerators) The Elastic Inference accelerator that's associated with the task.lastStatus
(String lastStatus) The last known status for the task.launchType
(String launchType) The infrastructure where your task runs on.launchType
(LaunchType launchType) The infrastructure where your task runs on.The amount of memory (in MiB) that the task uses as expressed in a task definition.default Task.Builder
overrides
(Consumer<TaskOverride.Builder> overrides) One or more container overrides.overrides
(TaskOverride overrides) One or more container overrides.platformFamily
(String platformFamily) The operating system that your tasks are running on.platformVersion
(String platformVersion) The platform version where your task runs on.pullStartedAt
(Instant pullStartedAt) The Unix timestamp for the time when the container image pull began.pullStoppedAt
(Instant pullStoppedAt) The Unix timestamp for the time when the container image pull completed.The Unix timestamp for the time when the task started.The tag specified when a task is started.The stop code indicating why a task was stopped.stopCode
(TaskStopCode stopCode) The stop code indicating why a task was stopped.The Unix timestamp for the time when the task was stopped.stoppedReason
(String stoppedReason) The reason that the task was stopped.stoppingAt
(Instant stoppingAt) The Unix timestamp for the time when the task stops.tags
(Collection<Tag> tags) The metadata that you apply to the task to help you categorize and organize the task.tags
(Consumer<Tag.Builder>... tags) The metadata that you apply to the task to help you categorize and organize the task.The metadata that you apply to the task to help you categorize and organize the task.The Amazon Resource Name (ARN) of the task.taskDefinitionArn
(String taskDefinitionArn) The ARN of the task definition that creates the task.The version counter for the task.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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 theawsvpc
network mode.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 theawsvpc
network mode.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
attachments
The Elastic Network Adapter that's associated with the task if the task uses the
This is a convenience method that creates an instance of theawsvpc
network mode.Attachment.Builder
avoiding the need to create one manually viaAttachment.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toattachments(List<Attachment>)
.- Parameters:
attachments
- a consumer that will call methods onAttachment.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
The attributes of the task
This is a convenience method that creates an instance of theAttribute.Builder
avoiding the need to create one manually viaAttribute.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toattributes(List<Attribute>)
.- Parameters:
attributes
- a consumer that will call methods onAttribute.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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
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
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
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 intoCONNECTED
status.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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
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
The containers that's associated with the task.
This is a convenience method that creates an instance of theContainer.Builder
avoiding the need to create one manually viaContainer.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocontainers(List<Container>)
.- Parameters:
containers
- a consumer that will call methods onContainer.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
or1 vcpu
). String values are converted to an integer that indicates the CPU units when the task definition is registered.If you use the EC2 launch type, this field is optional. Supported values are between
128
CPU units (0.125
vCPUs) and10240
CPU units (10
vCPUs).If you use the Fargate launch type, this field is required. You must use one of the following values. These values determine the range of supported 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 incrementsThis option requires Linux platform
1.4.0
or later. -
16384 (16vCPU) - Available
memory
values: 32GB and 120 GB in 8 GB incrementsThis option requires Linux platform
1.4.0
or later.
- 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
or1 vcpu
). String values are converted to an integer that indicates the CPU units when the task definition is registered.If you use the EC2 launch type, this field is optional. Supported values are between
128
CPU units (0.125
vCPUs) and10240
CPU units (10
vCPUs).If you use the Fargate launch type, this field is required. You must use one of the following values. These values determine the range of supported 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 incrementsThis option requires Linux platform
1.4.0
or later. -
16384 (16vCPU) - Available
memory
values: 32GB and 120 GB in 8 GB incrementsThis option requires Linux platform
1.4.0
or later.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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 thePENDING
state.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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. Iftrue
, 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
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
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
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 asHEALTHY
. If any essential containers in the task are reporting asUNHEALTHY
orUNKNOWN
, the task status also reports asUNHEALTHY
orUNKNOWN
.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 asHEALTHY
, the task status also reports asHEALTHY
. If any essential containers in the task are reporting asUNHEALTHY
orUNKNOWN
, the task status also reports asUNHEALTHY
orUNKNOWN
.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
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 asHEALTHY
. If any essential containers in the task are reporting asUNHEALTHY
orUNKNOWN
, the task status also reports asUNHEALTHY
orUNKNOWN
.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 asHEALTHY
, the task status also reports asHEALTHY
. If any essential containers in the task are reporting asUNHEALTHY
orUNKNOWN
, the task status also reports asUNHEALTHY
orUNKNOWN
.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
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
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
The Elastic Inference accelerator that's associated with the task.
This is a convenience method that creates an instance of theInferenceAccelerator.Builder
avoiding the need to create one manually viaInferenceAccelerator.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toinferenceAccelerators(List<InferenceAccelerator>)
.- Parameters:
inferenceAccelerators
- a consumer that will call methods onInferenceAccelerator.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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
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
or1 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
or1 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
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
One or more container overrides.
This is a convenience method that creates an instance of theTaskOverride.Builder
avoiding the need to create one manually viaTaskOverride.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tooverrides(TaskOverride)
.- Parameters:
overrides
- a consumer that will call methods onTaskOverride.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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, theLATEST
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
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
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
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
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 theRUNNING
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 thePENDING
state to theRUNNING
state.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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, thestartedBy
parameter contains the deployment ID of that service.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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. ThestoppedReason
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
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. ThestoppedReason
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
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 theSTOPPED
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 theRUNNING
state to theSTOPPED
state.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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 toSTOPPING
.- Parameters:
stoppingAt
- The Unix timestamp for the time when the task stops. More specifically, it's for the time when the task transitions from theRUNNING
state toSTOPPING
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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
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.
Tag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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
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
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 thedetail
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
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
The ephemeral storage settings for the task.
This is a convenience method that creates an instance of theEphemeralStorage.Builder
avoiding the need to create one manually viaEphemeralStorage.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toephemeralStorage(EphemeralStorage)
.- Parameters:
ephemeralStorage
- a consumer that will call methods onEphemeralStorage.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-