Task

class Task

Details on a task in a cluster.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

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

Link copied to clipboard

The attributes of the task

Link copied to clipboard

The Availability Zone for the task.

Link copied to clipboard

The capacity provider that's associated with the task.

Link copied to clipboard

The ARN of the cluster that hosts the task.

Link copied to clipboard

The connectivity status of a task.

Link copied to clipboard

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

Link copied to clipboard

The ARN of the container instances that host the task.

Link copied to clipboard

The containers that's associated with the task.

Link copied to clipboard
val cpu: String?

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

The ephemeral storage settings for the task.

Link copied to clipboard

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

Link copied to clipboard

The Fargate ephemeral storage settings for the task.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

One or more container overrides.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The reason that the task was stopped.

Link copied to clipboard

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

Link copied to clipboard
val tags: List<Tag>?

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.

Link copied to clipboard

The Amazon Resource Name (ARN) of the task.

Link copied to clipboard

The ARN of the task definition that creates the task.

Link copied to clipboard

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.

Functions

Link copied to clipboard
inline fun copy(block: Task.Builder.() -> Unit = {}): Task
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String