@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class Task extends Object implements Serializable, Cloneable, StructuredPojo
Details on a task in a cluster.
Constructor and Description |
---|
Task() |
Modifier and Type | Method and Description |
---|---|
Task |
clone() |
boolean |
equals(Object obj) |
List<Attachment> |
getAttachments()
The Elastic Network Adapter associated with the task if the task uses the
awsvpc network mode. |
List<Attribute> |
getAttributes()
The attributes of the task
|
String |
getAvailabilityZone()
The availability zone of the task.
|
String |
getCapacityProviderName()
The capacity provider associated with the task.
|
String |
getClusterArn()
The ARN of the cluster that hosts the task.
|
String |
getConnectivity()
The connectivity status of a task.
|
Date |
getConnectivityAt()
The Unix timestamp for when the task last went into
CONNECTED status. |
String |
getContainerInstanceArn()
The ARN of the container instances that host the task.
|
List<Container> |
getContainers()
The containers associated with the task.
|
String |
getCpu()
The number of CPU units used by the task as expressed in a task definition.
|
Date |
getCreatedAt()
The Unix timestamp for when the task was created (the task entered the
PENDING state). |
String |
getDesiredStatus()
The desired status of the task.
|
Date |
getExecutionStoppedAt()
The Unix timestamp for when the task execution stopped.
|
String |
getGroup()
The name of the task group associated with the task.
|
String |
getHealthStatus()
The health status for the task, which is determined by the health of the essential containers in the task.
|
List<InferenceAccelerator> |
getInferenceAccelerators()
The Elastic Inference accelerator associated with the task.
|
String |
getLastStatus()
The last known status of the task.
|
String |
getLaunchType()
The launch type on which your task is running.
|
String |
getMemory()
The amount of memory (in MiB) used by the task as expressed in a task definition.
|
TaskOverride |
getOverrides()
One or more container overrides.
|
String |
getPlatformVersion()
The platform version on which your task is running.
|
Date |
getPullStartedAt()
The Unix timestamp for when the container image pull began.
|
Date |
getPullStoppedAt()
The Unix timestamp for when the container image pull completed.
|
Date |
getStartedAt()
The Unix timestamp for when the task started (the task transitioned from the
PENDING state to the
RUNNING state). |
String |
getStartedBy()
The tag specified when a task is started.
|
String |
getStopCode()
The stop code indicating why a task was stopped.
|
Date |
getStoppedAt()
The Unix timestamp for when the task was stopped (the task transitioned from the
RUNNING state to
the STOPPED state). |
String |
getStoppedReason()
The reason that the task was stopped.
|
Date |
getStoppingAt()
The Unix timestamp for when the task stops (transitions from the
RUNNING state to
STOPPED ). |
List<Tag> |
getTags()
The metadata that you apply to the task to help you categorize and organize them.
|
String |
getTaskArn()
The Amazon Resource Name (ARN) of the task.
|
String |
getTaskDefinitionArn()
The ARN of the task definition that creates the task.
|
Long |
getVersion()
The version counter for the task.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAttachments(Collection<Attachment> attachments)
The Elastic Network Adapter associated with the task if the task uses the
awsvpc network mode. |
void |
setAttributes(Collection<Attribute> attributes)
The attributes of the task
|
void |
setAvailabilityZone(String availabilityZone)
The availability zone of the task.
|
void |
setCapacityProviderName(String capacityProviderName)
The capacity provider associated with the task.
|
void |
setClusterArn(String clusterArn)
The ARN of the cluster that hosts the task.
|
void |
setConnectivity(String connectivity)
The connectivity status of a task.
|
void |
setConnectivityAt(Date connectivityAt)
The Unix timestamp for when the task last went into
CONNECTED status. |
void |
setContainerInstanceArn(String containerInstanceArn)
The ARN of the container instances that host the task.
|
void |
setContainers(Collection<Container> containers)
The containers associated with the task.
|
void |
setCpu(String cpu)
The number of CPU units used by the task as expressed in a task definition.
|
void |
setCreatedAt(Date createdAt)
The Unix timestamp for when the task was created (the task entered the
PENDING state). |
void |
setDesiredStatus(String desiredStatus)
The desired status of the task.
|
void |
setExecutionStoppedAt(Date executionStoppedAt)
The Unix timestamp for when the task execution stopped.
|
void |
setGroup(String group)
The name of the task group associated with the task.
|
void |
setHealthStatus(String healthStatus)
The health status for the task, which is determined by the health of the essential containers in the task.
|
void |
setInferenceAccelerators(Collection<InferenceAccelerator> inferenceAccelerators)
The Elastic Inference accelerator associated with the task.
|
void |
setLastStatus(String lastStatus)
The last known status of the task.
|
void |
setLaunchType(String launchType)
The launch type on which your task is running.
|
void |
setMemory(String memory)
The amount of memory (in MiB) used by the task as expressed in a task definition.
|
void |
setOverrides(TaskOverride overrides)
One or more container overrides.
|
void |
setPlatformVersion(String platformVersion)
The platform version on which your task is running.
|
void |
setPullStartedAt(Date pullStartedAt)
The Unix timestamp for when the container image pull began.
|
void |
setPullStoppedAt(Date pullStoppedAt)
The Unix timestamp for when the container image pull completed.
|
void |
setStartedAt(Date startedAt)
The Unix timestamp for when the task started (the task transitioned from the
PENDING state to the
RUNNING state). |
void |
setStartedBy(String startedBy)
The tag specified when a task is started.
|
void |
setStopCode(String stopCode)
The stop code indicating why a task was stopped.
|
void |
setStoppedAt(Date stoppedAt)
The Unix timestamp for when the task was stopped (the task transitioned from the
RUNNING state to
the STOPPED state). |
void |
setStoppedReason(String stoppedReason)
The reason that the task was stopped.
|
void |
setStoppingAt(Date stoppingAt)
The Unix timestamp for when the task stops (transitions from the
RUNNING state to
STOPPED ). |
void |
setTags(Collection<Tag> tags)
The metadata that you apply to the task to help you categorize and organize them.
|
void |
setTaskArn(String taskArn)
The Amazon Resource Name (ARN) of the task.
|
void |
setTaskDefinitionArn(String taskDefinitionArn)
The ARN of the task definition that creates the task.
|
void |
setVersion(Long version)
The version counter for the task.
|
String |
toString()
Returns a string representation of this object.
|
Task |
withAttachments(Attachment... attachments)
The Elastic Network Adapter associated with the task if the task uses the
awsvpc network mode. |
Task |
withAttachments(Collection<Attachment> attachments)
The Elastic Network Adapter associated with the task if the task uses the
awsvpc network mode. |
Task |
withAttributes(Attribute... attributes)
The attributes of the task
|
Task |
withAttributes(Collection<Attribute> attributes)
The attributes of the task
|
Task |
withAvailabilityZone(String availabilityZone)
The availability zone of the task.
|
Task |
withCapacityProviderName(String capacityProviderName)
The capacity provider associated with the task.
|
Task |
withClusterArn(String clusterArn)
The ARN of the cluster that hosts the task.
|
Task |
withConnectivity(Connectivity connectivity)
The connectivity status of a task.
|
Task |
withConnectivity(String connectivity)
The connectivity status of a task.
|
Task |
withConnectivityAt(Date connectivityAt)
The Unix timestamp for when the task last went into
CONNECTED status. |
Task |
withContainerInstanceArn(String containerInstanceArn)
The ARN of the container instances that host the task.
|
Task |
withContainers(Collection<Container> containers)
The containers associated with the task.
|
Task |
withContainers(Container... containers)
The containers associated with the task.
|
Task |
withCpu(String cpu)
The number of CPU units used by the task as expressed in a task definition.
|
Task |
withCreatedAt(Date createdAt)
The Unix timestamp for when the task was created (the task entered the
PENDING state). |
Task |
withDesiredStatus(String desiredStatus)
The desired status of the task.
|
Task |
withExecutionStoppedAt(Date executionStoppedAt)
The Unix timestamp for when the task execution stopped.
|
Task |
withGroup(String group)
The name of the task group associated with the task.
|
Task |
withHealthStatus(HealthStatus healthStatus)
The health status for the task, which is determined by the health of the essential containers in the task.
|
Task |
withHealthStatus(String healthStatus)
The health status for the task, which is determined by the health of the essential containers in the task.
|
Task |
withInferenceAccelerators(Collection<InferenceAccelerator> inferenceAccelerators)
The Elastic Inference accelerator associated with the task.
|
Task |
withInferenceAccelerators(InferenceAccelerator... inferenceAccelerators)
The Elastic Inference accelerator associated with the task.
|
Task |
withLastStatus(String lastStatus)
The last known status of the task.
|
Task |
withLaunchType(LaunchType launchType)
The launch type on which your task is running.
|
Task |
withLaunchType(String launchType)
The launch type on which your task is running.
|
Task |
withMemory(String memory)
The amount of memory (in MiB) used by the task as expressed in a task definition.
|
Task |
withOverrides(TaskOverride overrides)
One or more container overrides.
|
Task |
withPlatformVersion(String platformVersion)
The platform version on which your task is running.
|
Task |
withPullStartedAt(Date pullStartedAt)
The Unix timestamp for when the container image pull began.
|
Task |
withPullStoppedAt(Date pullStoppedAt)
The Unix timestamp for when the container image pull completed.
|
Task |
withStartedAt(Date startedAt)
The Unix timestamp for when the task started (the task transitioned from the
PENDING state to the
RUNNING state). |
Task |
withStartedBy(String startedBy)
The tag specified when a task is started.
|
Task |
withStopCode(String stopCode)
The stop code indicating why a task was stopped.
|
Task |
withStopCode(TaskStopCode stopCode)
The stop code indicating why a task was stopped.
|
Task |
withStoppedAt(Date stoppedAt)
The Unix timestamp for when the task was stopped (the task transitioned from the
RUNNING state to
the STOPPED state). |
Task |
withStoppedReason(String stoppedReason)
The reason that the task was stopped.
|
Task |
withStoppingAt(Date stoppingAt)
The Unix timestamp for when the task stops (transitions from the
RUNNING state to
STOPPED ). |
Task |
withTags(Collection<Tag> tags)
The metadata that you apply to the task to help you categorize and organize them.
|
Task |
withTags(Tag... tags)
The metadata that you apply to the task to help you categorize and organize them.
|
Task |
withTaskArn(String taskArn)
The Amazon Resource Name (ARN) of the task.
|
Task |
withTaskDefinitionArn(String taskDefinitionArn)
The ARN of the task definition that creates the task.
|
Task |
withVersion(Long version)
The version counter for the task.
|
public List<Attachment> getAttachments()
The Elastic Network Adapter associated with the task if the task uses the awsvpc
network mode.
awsvpc
network
mode.public void setAttachments(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.public Task withAttachments(Attachment... attachments)
The Elastic Network Adapter associated with the task if the task uses the awsvpc
network mode.
NOTE: This method appends the values to the existing list (if any). Use
setAttachments(java.util.Collection)
or withAttachments(java.util.Collection)
if you want to
override the existing values.
attachments
- The Elastic Network Adapter associated with the task if the task uses the awsvpc
network
mode.public Task withAttachments(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.public List<Attribute> getAttributes()
The attributes of the task
public void setAttributes(Collection<Attribute> attributes)
The attributes of the task
attributes
- The attributes of the taskpublic Task withAttributes(Attribute... attributes)
The attributes of the task
NOTE: This method appends the values to the existing list (if any). Use
setAttributes(java.util.Collection)
or withAttributes(java.util.Collection)
if you want to
override the existing values.
attributes
- The attributes of the taskpublic Task withAttributes(Collection<Attribute> attributes)
The attributes of the task
attributes
- The attributes of the taskpublic void setAvailabilityZone(String availabilityZone)
The availability zone of the task.
availabilityZone
- The availability zone of the task.public String getAvailabilityZone()
The availability zone of the task.
public Task withAvailabilityZone(String availabilityZone)
The availability zone of the task.
availabilityZone
- The availability zone of the task.public void setCapacityProviderName(String capacityProviderName)
The capacity provider associated with the task.
capacityProviderName
- The capacity provider associated with the task.public String getCapacityProviderName()
The capacity provider associated with the task.
public Task withCapacityProviderName(String capacityProviderName)
The capacity provider associated with the task.
capacityProviderName
- The capacity provider associated with the task.public void setClusterArn(String clusterArn)
The ARN of the cluster that hosts the task.
clusterArn
- The ARN of the cluster that hosts the task.public String getClusterArn()
The ARN of the cluster that hosts the task.
public Task withClusterArn(String clusterArn)
The ARN of the cluster that hosts the task.
clusterArn
- The ARN of the cluster that hosts the task.public void setConnectivity(String connectivity)
The connectivity status of a task.
connectivity
- The connectivity status of a task.Connectivity
public String getConnectivity()
The connectivity status of a task.
Connectivity
public Task withConnectivity(String connectivity)
The connectivity status of a task.
connectivity
- The connectivity status of a task.Connectivity
public Task withConnectivity(Connectivity connectivity)
The connectivity status of a task.
connectivity
- The connectivity status of a task.Connectivity
public void setConnectivityAt(Date 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.public Date getConnectivityAt()
The Unix timestamp for when the task last went into CONNECTED
status.
CONNECTED
status.public Task withConnectivityAt(Date 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.public void setContainerInstanceArn(String containerInstanceArn)
The ARN of the container instances that host the task.
containerInstanceArn
- The ARN of the container instances that host the task.public String getContainerInstanceArn()
The ARN of the container instances that host the task.
public Task withContainerInstanceArn(String containerInstanceArn)
The ARN of the container instances that host the task.
containerInstanceArn
- The ARN of the container instances that host the task.public List<Container> getContainers()
The containers associated with the task.
public void setContainers(Collection<Container> containers)
The containers associated with the task.
containers
- The containers associated with the task.public Task withContainers(Container... containers)
The containers associated with the task.
NOTE: This method appends the values to the existing list (if any). Use
setContainers(java.util.Collection)
or withContainers(java.util.Collection)
if you want to
override the existing values.
containers
- The containers associated with the task.public Task withContainers(Collection<Container> containers)
The containers associated with the task.
containers
- The containers associated with the task.public void setCpu(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)
public String getCpu()
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)
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)
public Task withCpu(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)
public void setCreatedAt(Date 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).public Date getCreatedAt()
The Unix timestamp for when the task was created (the task entered the PENDING
state).
PENDING
state).public Task withCreatedAt(Date 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).public void setDesiredStatus(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.public String getDesiredStatus()
The desired status of the task. For more information, see Task Lifecycle.
public Task withDesiredStatus(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.public void setExecutionStoppedAt(Date executionStoppedAt)
The Unix timestamp for when the task execution stopped.
executionStoppedAt
- The Unix timestamp for when the task execution stopped.public Date getExecutionStoppedAt()
The Unix timestamp for when the task execution stopped.
public Task withExecutionStoppedAt(Date executionStoppedAt)
The Unix timestamp for when the task execution stopped.
executionStoppedAt
- The Unix timestamp for when the task execution stopped.public void setGroup(String group)
The name of the task group associated with the task.
group
- The name of the task group associated with the task.public String getGroup()
The name of the task group associated with the task.
public Task withGroup(String group)
The name of the task group associated with the task.
group
- The name of the task group associated with the task.public void setHealthStatus(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
public String getHealthStatus()
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.
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
public Task withHealthStatus(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
public Task withHealthStatus(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
public List<InferenceAccelerator> getInferenceAccelerators()
The Elastic Inference accelerator associated with the task.
public void setInferenceAccelerators(Collection<InferenceAccelerator> inferenceAccelerators)
The Elastic Inference accelerator associated with the task.
inferenceAccelerators
- The Elastic Inference accelerator associated with the task.public Task withInferenceAccelerators(InferenceAccelerator... inferenceAccelerators)
The Elastic Inference accelerator associated with the task.
NOTE: This method appends the values to the existing list (if any). Use
setInferenceAccelerators(java.util.Collection)
or
withInferenceAccelerators(java.util.Collection)
if you want to override the existing values.
inferenceAccelerators
- The Elastic Inference accelerator associated with the task.public Task withInferenceAccelerators(Collection<InferenceAccelerator> inferenceAccelerators)
The Elastic Inference accelerator associated with the task.
inferenceAccelerators
- The Elastic Inference accelerator associated with the task.public void setLastStatus(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.public String getLastStatus()
The last known status of the task. For more information, see Task Lifecycle.
public Task withLastStatus(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.public void setLaunchType(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
public String getLaunchType()
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
public Task withLaunchType(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
public Task withLaunchType(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
public void setMemory(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)
public String getMemory()
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)
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)
public Task withMemory(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)
public void setOverrides(TaskOverride overrides)
One or more container overrides.
overrides
- One or more container overrides.public TaskOverride getOverrides()
One or more container overrides.
public Task withOverrides(TaskOverride overrides)
One or more container overrides.
overrides
- One or more container overrides.public void setPlatformVersion(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.public String getPlatformVersion()
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.
LATEST
platform version is used by
default. For more information, see AWS Fargate
Platform Versions in the Amazon Elastic Container Service Developer Guide.public Task withPlatformVersion(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.public void setPullStartedAt(Date pullStartedAt)
The Unix timestamp for when the container image pull began.
pullStartedAt
- The Unix timestamp for when the container image pull began.public Date getPullStartedAt()
The Unix timestamp for when the container image pull began.
public Task withPullStartedAt(Date pullStartedAt)
The Unix timestamp for when the container image pull began.
pullStartedAt
- The Unix timestamp for when the container image pull began.public void setPullStoppedAt(Date pullStoppedAt)
The Unix timestamp for when the container image pull completed.
pullStoppedAt
- The Unix timestamp for when the container image pull completed.public Date getPullStoppedAt()
The Unix timestamp for when the container image pull completed.
public Task withPullStoppedAt(Date pullStoppedAt)
The Unix timestamp for when the container image pull completed.
pullStoppedAt
- The Unix timestamp for when the container image pull completed.public void setStartedAt(Date 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).public Date getStartedAt()
The Unix timestamp for when the task started (the task transitioned from the PENDING
state to the
RUNNING
state).
PENDING
state
to the RUNNING
state).public Task withStartedAt(Date 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).public void setStartedBy(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.public String getStartedBy()
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
parameter contains the deployment ID of the service that starts it.public Task withStartedBy(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.public void setStopCode(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
public String getStopCode()
The stop code indicating why a task was stopped. The stoppedReason
may contain additional details.
stoppedReason
may contain additional
details.TaskStopCode
public Task withStopCode(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
public Task withStopCode(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
public void setStoppedAt(Date 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).public Date getStoppedAt()
The Unix timestamp for when the task was stopped (the task transitioned from the RUNNING
state to
the STOPPED
state).
RUNNING
state to the STOPPED
state).public Task withStoppedAt(Date 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).public void setStoppedReason(String stoppedReason)
The reason that the task was stopped.
stoppedReason
- The reason that the task was stopped.public String getStoppedReason()
The reason that the task was stopped.
public Task withStoppedReason(String stoppedReason)
The reason that the task was stopped.
stoppedReason
- The reason that the task was stopped.public void setStoppingAt(Date 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
).public Date getStoppingAt()
The Unix timestamp for when the task stops (transitions from the RUNNING
state to
STOPPED
).
RUNNING
state to
STOPPED
).public Task withStoppingAt(Date 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
).public List<Tag> getTags()
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.
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 AWS 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.
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 AWS 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.
public void setTags(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.
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 AWS 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.
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.
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 AWS 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.
public Task withTags(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.
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 AWS 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.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
or withTags(java.util.Collection)
if you want to override the
existing values.
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.
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 AWS 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.
public Task withTags(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.
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 AWS 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.
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.
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 AWS 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.
public void setTaskArn(String taskArn)
The Amazon Resource Name (ARN) of the task.
taskArn
- The Amazon Resource Name (ARN) of the task.public String getTaskArn()
The Amazon Resource Name (ARN) of the task.
public Task withTaskArn(String taskArn)
The Amazon Resource Name (ARN) of the task.
taskArn
- The Amazon Resource Name (ARN) of the task.public void setTaskDefinitionArn(String taskDefinitionArn)
The ARN of the task definition that creates the task.
taskDefinitionArn
- The ARN of the task definition that creates the task.public String getTaskDefinitionArn()
The ARN of the task definition that creates the task.
public Task withTaskDefinitionArn(String taskDefinitionArn)
The ARN of the task definition that creates the task.
taskDefinitionArn
- The ARN of the task definition that creates the task.public void setVersion(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 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.
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 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.public Long getVersion()
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 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.
detail
object) to verify that
the version in your event stream is current.public Task withVersion(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 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.
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 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.public String toString()
toString
in class Object
Object.toString()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.