You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::ECS::Types::Task

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Details on a task in a cluster.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#attachmentsArray<Types::Attachment>

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

Returns:

  • (Array<Types::Attachment>)

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

#cluster_arnString

The ARN of the cluster that hosts the task.

Returns:

  • (String)

    The ARN of the cluster that hosts the task.

#connectivityString

The connectivity status of a task.

Possible values:

  • CONNECTED
  • DISCONNECTED

Returns:

  • (String)

    The connectivity status of a task.

#connectivity_atTime

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

Returns:

  • (Time)

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

#container_instance_arnString

The ARN of the container instances that host the task.

Returns:

  • (String)

    The ARN of the container instances that host the task.

#containersArray<Types::Container>

The containers associated with the task.

Returns:

#cpuString

The number of cpu units used by the task. If using the EC2 launch type, this field is optional and any value can be used. If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the memory parameter:

  • 256 (.25 vCPU) - Available memory values: 0.5GB, 1GB, 2GB

  • 512 (.5 vCPU) - Available memory values: 1GB, 2GB, 3GB, 4GB

  • 1024 (1 vCPU) - Available memory values: 2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB

  • 2048 (2 vCPU) - Available memory values: Between 4GB and 16GB in 1GB increments

  • 4096 (4 vCPU) - Available memory values: Between 8GB and 30GB in 1GB increments

Returns:

  • (String)

    The number of cpu units used by the task.

#created_atTime

The Unix time stamp for when the task was created (the task entered the PENDING state).

Returns:

  • (Time)

    The Unix time stamp for when the task was created (the task entered the PENDING state).

#desired_statusString

The desired status of the task.

Returns:

  • (String)

    The desired status of the task.

#execution_stopped_atTime

The Unix timestamp for when the task execution stopped.

Returns:

  • (Time)

    The Unix timestamp for when the task execution stopped.

#groupString

The name of the task group associated with the task.

Returns:

  • (String)

    The name of the task group associated with the task.

#last_statusString

The last known status of the task.

Returns:

  • (String)

    The last known status of the task.

#launch_typeString

The launch type on which your task is running.

Possible values:

  • EC2
  • FARGATE

Returns:

  • (String)

    The launch type on which your task is running.

#memoryString

The amount (in MiB) of memory used by the task. If using the EC2 launch type, this field is optional and any value can be used. If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the cpu parameter:

  • 0.5GB, 1GB, 2GB - Available cpu values: 256 (.25 vCPU)

  • 1GB, 2GB, 3GB, 4GB - Available cpu values: 512 (.5 vCPU)

  • 2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB - Available cpu values: 1024 (1 vCPU)

  • Between 4GB and 16GB in 1GB increments - Available cpu values: 2048 (2 vCPU)

  • Between 8GB and 30GB in 1GB increments - Available cpu values: 4096 (4 vCPU)

Returns:

  • (String)

    The amount (in MiB) of memory used by the task.

#overridesTypes::TaskOverride

One or more container overrides.

Returns:

#platform_versionString

The platform version on which your task is running. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

Returns:

  • (String)

    The platform version on which your task is running.

#pull_started_atTime

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

Returns:

  • (Time)

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

#pull_stopped_atTime

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

Returns:

  • (Time)

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

#started_atTime

The Unix time stamp for when the task started (the task transitioned from the PENDING state to the RUNNING state).

Returns:

  • (Time)

    The Unix time stamp for when the task started (the task transitioned from the PENDING state to the RUNNING state).

#started_byString

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.

Returns:

  • (String)

    The tag specified when a task is started.

#stopped_atTime

The Unix time stamp for when the task was stopped (the task transitioned from the RUNNING state to the STOPPED state).

Returns:

  • (Time)

    The Unix time stamp for when the task was stopped (the task transitioned from the RUNNING state to the STOPPED state).

#stopped_reasonString

The reason the task was stopped.

Returns:

  • (String)

    The reason the task was stopped.

#stopping_atTime

The Unix time stamp for when the task will stop (the task transitioned from the RUNNING state to the STOPPED state).

Returns:

  • (Time)

    The Unix time stamp for when the task will stop (the task transitioned from the RUNNING state to the STOPPED state).

#task_arnString

The Amazon Resource Name (ARN) of the task.

Returns:

  • (String)

    The Amazon Resource Name (ARN) of the task.

#task_definition_arnString

The ARN of the task definition that creates the task.

Returns:

  • (String)

    The ARN of the task definition that creates the task.

#versionInteger

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 APIs with the version reported in CloudWatch Events for the task (inside the detail object) to verify that the version in your event stream is current.

Returns:

  • (Integer)

    The version counter for the task.