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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb

Overview

Details on a task in a cluster.

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:



5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 5170

class Task < Struct.new(
  :task_arn,
  :cluster_arn,
  :task_definition_arn,
  :container_instance_arn,
  :overrides,
  :last_status,
  :desired_status,
  :cpu,
  :memory,
  :containers,
  :started_by,
  :version,
  :stopped_reason,
  :connectivity,
  :connectivity_at,
  :pull_started_at,
  :pull_stopped_at,
  :execution_stopped_at,
  :created_at,
  :started_at,
  :stopping_at,
  :stopped_at,
  :group,
  :launch_type,
  :platform_version,
  :attachments,
  :health_status)
  include Aws::Structure
end

#cluster_arnString

The ARN of the cluster that hosts the task.

Returns:

  • (String)


5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 5170

class Task < Struct.new(
  :task_arn,
  :cluster_arn,
  :task_definition_arn,
  :container_instance_arn,
  :overrides,
  :last_status,
  :desired_status,
  :cpu,
  :memory,
  :containers,
  :started_by,
  :version,
  :stopped_reason,
  :connectivity,
  :connectivity_at,
  :pull_started_at,
  :pull_stopped_at,
  :execution_stopped_at,
  :created_at,
  :started_at,
  :stopping_at,
  :stopped_at,
  :group,
  :launch_type,
  :platform_version,
  :attachments,
  :health_status)
  include Aws::Structure
end

#connectivityString

The connectivity status of a task.

Returns:

  • (String)


5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 5170

class Task < Struct.new(
  :task_arn,
  :cluster_arn,
  :task_definition_arn,
  :container_instance_arn,
  :overrides,
  :last_status,
  :desired_status,
  :cpu,
  :memory,
  :containers,
  :started_by,
  :version,
  :stopped_reason,
  :connectivity,
  :connectivity_at,
  :pull_started_at,
  :pull_stopped_at,
  :execution_stopped_at,
  :created_at,
  :started_at,
  :stopping_at,
  :stopped_at,
  :group,
  :launch_type,
  :platform_version,
  :attachments,
  :health_status)
  include Aws::Structure
end

#connectivity_atTime

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

Returns:

  • (Time)


5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 5170

class Task < Struct.new(
  :task_arn,
  :cluster_arn,
  :task_definition_arn,
  :container_instance_arn,
  :overrides,
  :last_status,
  :desired_status,
  :cpu,
  :memory,
  :containers,
  :started_by,
  :version,
  :stopped_reason,
  :connectivity,
  :connectivity_at,
  :pull_started_at,
  :pull_stopped_at,
  :execution_stopped_at,
  :created_at,
  :started_at,
  :stopping_at,
  :stopped_at,
  :group,
  :launch_type,
  :platform_version,
  :attachments,
  :health_status)
  include Aws::Structure
end

#container_instance_arnString

The ARN of the container instances that host the task.

Returns:

  • (String)


5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 5170

class Task < Struct.new(
  :task_arn,
  :cluster_arn,
  :task_definition_arn,
  :container_instance_arn,
  :overrides,
  :last_status,
  :desired_status,
  :cpu,
  :memory,
  :containers,
  :started_by,
  :version,
  :stopped_reason,
  :connectivity,
  :connectivity_at,
  :pull_started_at,
  :pull_stopped_at,
  :execution_stopped_at,
  :created_at,
  :started_at,
  :stopping_at,
  :stopped_at,
  :group,
  :launch_type,
  :platform_version,
  :attachments,
  :health_status)
  include Aws::Structure
end

#containersArray<Types::Container>

The containers associated with the task.

Returns:



5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 5170

class Task < Struct.new(
  :task_arn,
  :cluster_arn,
  :task_definition_arn,
  :container_instance_arn,
  :overrides,
  :last_status,
  :desired_status,
  :cpu,
  :memory,
  :containers,
  :started_by,
  :version,
  :stopped_reason,
  :connectivity,
  :connectivity_at,
  :pull_started_at,
  :pull_stopped_at,
  :execution_stopped_at,
  :created_at,
  :started_at,
  :stopping_at,
  :stopped_at,
  :group,
  :launch_type,
  :platform_version,
  :attachments,
  :health_status)
  include Aws::Structure
end

#cpuString

The number of CPU units used by the task. It can be expressed as an integer using CPU units, for example 1024, or as a string using vCPUs, for example 1 vCPU or 1 vcpu, in a task definition but is converted to an integer indicating the CPU units when the task definition is registered.

If 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 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)

Returns:

  • (String)


5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 5170

class Task < Struct.new(
  :task_arn,
  :cluster_arn,
  :task_definition_arn,
  :container_instance_arn,
  :overrides,
  :last_status,
  :desired_status,
  :cpu,
  :memory,
  :containers,
  :started_by,
  :version,
  :stopped_reason,
  :connectivity,
  :connectivity_at,
  :pull_started_at,
  :pull_stopped_at,
  :execution_stopped_at,
  :created_at,
  :started_at,
  :stopping_at,
  :stopped_at,
  :group,
  :launch_type,
  :platform_version,
  :attachments,
  :health_status)
  include Aws::Structure
end

#created_atTime

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

Returns:

  • (Time)


5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 5170

class Task < Struct.new(
  :task_arn,
  :cluster_arn,
  :task_definition_arn,
  :container_instance_arn,
  :overrides,
  :last_status,
  :desired_status,
  :cpu,
  :memory,
  :containers,
  :started_by,
  :version,
  :stopped_reason,
  :connectivity,
  :connectivity_at,
  :pull_started_at,
  :pull_stopped_at,
  :execution_stopped_at,
  :created_at,
  :started_at,
  :stopping_at,
  :stopped_at,
  :group,
  :launch_type,
  :platform_version,
  :attachments,
  :health_status)
  include Aws::Structure
end

#desired_statusString

The desired status of the task.

Returns:

  • (String)


5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 5170

class Task < Struct.new(
  :task_arn,
  :cluster_arn,
  :task_definition_arn,
  :container_instance_arn,
  :overrides,
  :last_status,
  :desired_status,
  :cpu,
  :memory,
  :containers,
  :started_by,
  :version,
  :stopped_reason,
  :connectivity,
  :connectivity_at,
  :pull_started_at,
  :pull_stopped_at,
  :execution_stopped_at,
  :created_at,
  :started_at,
  :stopping_at,
  :stopped_at,
  :group,
  :launch_type,
  :platform_version,
  :attachments,
  :health_status)
  include Aws::Structure
end

#execution_stopped_atTime

The Unix time stamp for when the task execution stopped.

Returns:

  • (Time)


5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 5170

class Task < Struct.new(
  :task_arn,
  :cluster_arn,
  :task_definition_arn,
  :container_instance_arn,
  :overrides,
  :last_status,
  :desired_status,
  :cpu,
  :memory,
  :containers,
  :started_by,
  :version,
  :stopped_reason,
  :connectivity,
  :connectivity_at,
  :pull_started_at,
  :pull_stopped_at,
  :execution_stopped_at,
  :created_at,
  :started_at,
  :stopping_at,
  :stopped_at,
  :group,
  :launch_type,
  :platform_version,
  :attachments,
  :health_status)
  include Aws::Structure
end

#groupString

The name of the task group associated with the task.

Returns:

  • (String)


5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 5170

class Task < Struct.new(
  :task_arn,
  :cluster_arn,
  :task_definition_arn,
  :container_instance_arn,
  :overrides,
  :last_status,
  :desired_status,
  :cpu,
  :memory,
  :containers,
  :started_by,
  :version,
  :stopped_reason,
  :connectivity,
  :connectivity_at,
  :pull_started_at,
  :pull_stopped_at,
  :execution_stopped_at,
  :created_at,
  :started_at,
  :stopping_at,
  :stopped_at,
  :group,
  :launch_type,
  :platform_version,
  :attachments,
  :health_status)
  include Aws::Structure
end

#health_statusString

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.

Returns:

  • (String)


5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 5170

class Task < Struct.new(
  :task_arn,
  :cluster_arn,
  :task_definition_arn,
  :container_instance_arn,
  :overrides,
  :last_status,
  :desired_status,
  :cpu,
  :memory,
  :containers,
  :started_by,
  :version,
  :stopped_reason,
  :connectivity,
  :connectivity_at,
  :pull_started_at,
  :pull_stopped_at,
  :execution_stopped_at,
  :created_at,
  :started_at,
  :stopping_at,
  :stopped_at,
  :group,
  :launch_type,
  :platform_version,
  :attachments,
  :health_status)
  include Aws::Structure
end

#last_statusString

The last known status of the task.

Returns:

  • (String)


5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 5170

class Task < Struct.new(
  :task_arn,
  :cluster_arn,
  :task_definition_arn,
  :container_instance_arn,
  :overrides,
  :last_status,
  :desired_status,
  :cpu,
  :memory,
  :containers,
  :started_by,
  :version,
  :stopped_reason,
  :connectivity,
  :connectivity_at,
  :pull_started_at,
  :pull_stopped_at,
  :execution_stopped_at,
  :created_at,
  :started_at,
  :stopping_at,
  :stopped_at,
  :group,
  :launch_type,
  :platform_version,
  :attachments,
  :health_status)
  include Aws::Structure
end

#launch_typeString

The launch type on which your task is running.

Returns:

  • (String)


5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 5170

class Task < Struct.new(
  :task_arn,
  :cluster_arn,
  :task_definition_arn,
  :container_instance_arn,
  :overrides,
  :last_status,
  :desired_status,
  :cpu,
  :memory,
  :containers,
  :started_by,
  :version,
  :stopped_reason,
  :connectivity,
  :connectivity_at,
  :pull_started_at,
  :pull_stopped_at,
  :execution_stopped_at,
  :created_at,
  :started_at,
  :stopping_at,
  :stopped_at,
  :group,
  :launch_type,
  :platform_version,
  :attachments,
  :health_status)
  include Aws::Structure
end

#memoryString

The amount of memory (in MiB) used by the task. It can be expressed as an integer using MiB, for example 1024, or as a string using GB, for example 1GB or 1 GB, in a task definition but is converted to an integer indicating the MiB when the task definition is registered.

If using the EC2 launch type, this field is optional.

If 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)

Returns:

  • (String)


5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 5170

class Task < Struct.new(
  :task_arn,
  :cluster_arn,
  :task_definition_arn,
  :container_instance_arn,
  :overrides,
  :last_status,
  :desired_status,
  :cpu,
  :memory,
  :containers,
  :started_by,
  :version,
  :stopped_reason,
  :connectivity,
  :connectivity_at,
  :pull_started_at,
  :pull_stopped_at,
  :execution_stopped_at,
  :created_at,
  :started_at,
  :stopping_at,
  :stopped_at,
  :group,
  :launch_type,
  :platform_version,
  :attachments,
  :health_status)
  include Aws::Structure
end

#overridesTypes::TaskOverride

One or more container overrides.

Returns:



5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 5170

class Task < Struct.new(
  :task_arn,
  :cluster_arn,
  :task_definition_arn,
  :container_instance_arn,
  :overrides,
  :last_status,
  :desired_status,
  :cpu,
  :memory,
  :containers,
  :started_by,
  :version,
  :stopped_reason,
  :connectivity,
  :connectivity_at,
  :pull_started_at,
  :pull_stopped_at,
  :execution_stopped_at,
  :created_at,
  :started_at,
  :stopping_at,
  :stopped_at,
  :group,
  :launch_type,
  :platform_version,
  :attachments,
  :health_status)
  include Aws::Structure
end

#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)


5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 5170

class Task < Struct.new(
  :task_arn,
  :cluster_arn,
  :task_definition_arn,
  :container_instance_arn,
  :overrides,
  :last_status,
  :desired_status,
  :cpu,
  :memory,
  :containers,
  :started_by,
  :version,
  :stopped_reason,
  :connectivity,
  :connectivity_at,
  :pull_started_at,
  :pull_stopped_at,
  :execution_stopped_at,
  :created_at,
  :started_at,
  :stopping_at,
  :stopped_at,
  :group,
  :launch_type,
  :platform_version,
  :attachments,
  :health_status)
  include Aws::Structure
end

#pull_started_atTime

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

Returns:

  • (Time)


5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 5170

class Task < Struct.new(
  :task_arn,
  :cluster_arn,
  :task_definition_arn,
  :container_instance_arn,
  :overrides,
  :last_status,
  :desired_status,
  :cpu,
  :memory,
  :containers,
  :started_by,
  :version,
  :stopped_reason,
  :connectivity,
  :connectivity_at,
  :pull_started_at,
  :pull_stopped_at,
  :execution_stopped_at,
  :created_at,
  :started_at,
  :stopping_at,
  :stopped_at,
  :group,
  :launch_type,
  :platform_version,
  :attachments,
  :health_status)
  include Aws::Structure
end

#pull_stopped_atTime

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

Returns:

  • (Time)


5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 5170

class Task < Struct.new(
  :task_arn,
  :cluster_arn,
  :task_definition_arn,
  :container_instance_arn,
  :overrides,
  :last_status,
  :desired_status,
  :cpu,
  :memory,
  :containers,
  :started_by,
  :version,
  :stopped_reason,
  :connectivity,
  :connectivity_at,
  :pull_started_at,
  :pull_stopped_at,
  :execution_stopped_at,
  :created_at,
  :started_at,
  :stopping_at,
  :stopped_at,
  :group,
  :launch_type,
  :platform_version,
  :attachments,
  :health_status)
  include Aws::Structure
end

#started_atTime

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

Returns:

  • (Time)


5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 5170

class Task < Struct.new(
  :task_arn,
  :cluster_arn,
  :task_definition_arn,
  :container_instance_arn,
  :overrides,
  :last_status,
  :desired_status,
  :cpu,
  :memory,
  :containers,
  :started_by,
  :version,
  :stopped_reason,
  :connectivity,
  :connectivity_at,
  :pull_started_at,
  :pull_stopped_at,
  :execution_stopped_at,
  :created_at,
  :started_at,
  :stopping_at,
  :stopped_at,
  :group,
  :launch_type,
  :platform_version,
  :attachments,
  :health_status)
  include Aws::Structure
end

#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)


5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 5170

class Task < Struct.new(
  :task_arn,
  :cluster_arn,
  :task_definition_arn,
  :container_instance_arn,
  :overrides,
  :last_status,
  :desired_status,
  :cpu,
  :memory,
  :containers,
  :started_by,
  :version,
  :stopped_reason,
  :connectivity,
  :connectivity_at,
  :pull_started_at,
  :pull_stopped_at,
  :execution_stopped_at,
  :created_at,
  :started_at,
  :stopping_at,
  :stopped_at,
  :group,
  :launch_type,
  :platform_version,
  :attachments,
  :health_status)
  include Aws::Structure
end

#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)


5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 5170

class Task < Struct.new(
  :task_arn,
  :cluster_arn,
  :task_definition_arn,
  :container_instance_arn,
  :overrides,
  :last_status,
  :desired_status,
  :cpu,
  :memory,
  :containers,
  :started_by,
  :version,
  :stopped_reason,
  :connectivity,
  :connectivity_at,
  :pull_started_at,
  :pull_stopped_at,
  :execution_stopped_at,
  :created_at,
  :started_at,
  :stopping_at,
  :stopped_at,
  :group,
  :launch_type,
  :platform_version,
  :attachments,
  :health_status)
  include Aws::Structure
end

#stopped_reasonString

The reason the task was stopped.

Returns:

  • (String)


5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 5170

class Task < Struct.new(
  :task_arn,
  :cluster_arn,
  :task_definition_arn,
  :container_instance_arn,
  :overrides,
  :last_status,
  :desired_status,
  :cpu,
  :memory,
  :containers,
  :started_by,
  :version,
  :stopped_reason,
  :connectivity,
  :connectivity_at,
  :pull_started_at,
  :pull_stopped_at,
  :execution_stopped_at,
  :created_at,
  :started_at,
  :stopping_at,
  :stopped_at,
  :group,
  :launch_type,
  :platform_version,
  :attachments,
  :health_status)
  include Aws::Structure
end

#stopping_atTime

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

Returns:

  • (Time)


5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 5170

class Task < Struct.new(
  :task_arn,
  :cluster_arn,
  :task_definition_arn,
  :container_instance_arn,
  :overrides,
  :last_status,
  :desired_status,
  :cpu,
  :memory,
  :containers,
  :started_by,
  :version,
  :stopped_reason,
  :connectivity,
  :connectivity_at,
  :pull_started_at,
  :pull_stopped_at,
  :execution_stopped_at,
  :created_at,
  :started_at,
  :stopping_at,
  :stopped_at,
  :group,
  :launch_type,
  :platform_version,
  :attachments,
  :health_status)
  include Aws::Structure
end

#task_arnString

The Amazon Resource Name (ARN) of the task.

Returns:

  • (String)


5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 5170

class Task < Struct.new(
  :task_arn,
  :cluster_arn,
  :task_definition_arn,
  :container_instance_arn,
  :overrides,
  :last_status,
  :desired_status,
  :cpu,
  :memory,
  :containers,
  :started_by,
  :version,
  :stopped_reason,
  :connectivity,
  :connectivity_at,
  :pull_started_at,
  :pull_stopped_at,
  :execution_stopped_at,
  :created_at,
  :started_at,
  :stopping_at,
  :stopped_at,
  :group,
  :launch_type,
  :platform_version,
  :attachments,
  :health_status)
  include Aws::Structure
end

#task_definition_arnString

The ARN of the task definition that creates the task.

Returns:

  • (String)


5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 5170

class Task < Struct.new(
  :task_arn,
  :cluster_arn,
  :task_definition_arn,
  :container_instance_arn,
  :overrides,
  :last_status,
  :desired_status,
  :cpu,
  :memory,
  :containers,
  :started_by,
  :version,
  :stopped_reason,
  :connectivity,
  :connectivity_at,
  :pull_started_at,
  :pull_stopped_at,
  :execution_stopped_at,
  :created_at,
  :started_at,
  :stopping_at,
  :stopped_at,
  :group,
  :launch_type,
  :platform_version,
  :attachments,
  :health_status)
  include Aws::Structure
end

#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)


5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 5170

class Task < Struct.new(
  :task_arn,
  :cluster_arn,
  :task_definition_arn,
  :container_instance_arn,
  :overrides,
  :last_status,
  :desired_status,
  :cpu,
  :memory,
  :containers,
  :started_by,
  :version,
  :stopped_reason,
  :connectivity,
  :connectivity_at,
  :pull_started_at,
  :pull_stopped_at,
  :execution_stopped_at,
  :created_at,
  :started_at,
  :stopping_at,
  :stopped_at,
  :group,
  :launch_type,
  :platform_version,
  :attachments,
  :health_status)
  include Aws::Structure
end