AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Details on a task in a cluster.

Inheritance Hierarchy

System.Object
  Amazon.ECS.Model.Task

Namespace: Amazon.ECS.Model
Assembly: AWSSDK.ECS.dll
Version: 3.x.y.z

Syntax

C#
public class Task

The Task type exposes the following members

Constructors

NameDescription
Public Method Task()

Properties

NameTypeDescription
Public Property Attachments System.Collections.Generic.List<Amazon.ECS.Model.Attachment>

Gets and sets the property Attachments.

The elastic network adapter associated with the task if the task uses the awsvpc network mode.

Public Property ClusterArn System.String

Gets and sets the property ClusterArn.

The ARN of the cluster that hosts the task.

Public Property Connectivity Amazon.ECS.Connectivity

Gets and sets the property Connectivity.

The connectivity status of a task.

Public Property ConnectivityAt System.DateTime

Gets and sets the property ConnectivityAt.

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

Public Property ContainerInstanceArn System.String

Gets and sets the property ContainerInstanceArn.

The ARN of the container instances that host the task.

Public Property Containers System.Collections.Generic.List<Amazon.ECS.Model.Container>

Gets and sets the property Containers.

The containers associated with the task.

Public Property Cpu System.String

Gets and sets the property Cpu.

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. String values are 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)

Public Property CreatedAt System.DateTime

Gets and sets the property CreatedAt.

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

Public Property DesiredStatus System.String

Gets and sets the property DesiredStatus.

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

Public Property ExecutionStoppedAt System.DateTime

Gets and sets the property ExecutionStoppedAt.

The Unix time stamp for when the task execution stopped.

Public Property Group System.String

Gets and sets the property Group.

The name of the task group associated with the task.

Public Property HealthStatus Amazon.ECS.HealthStatus

Gets and sets the property 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.

Public Property LastStatus System.String

Gets and sets the property LastStatus.

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

Public Property LaunchType Amazon.ECS.LaunchType

Gets and sets the property LaunchType.

The launch type on which your task is running.

Public Property Memory System.String

Gets and sets the property Memory.

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. String values are 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)

Public Property Overrides Amazon.ECS.Model.TaskOverride

Gets and sets the property Overrides.

One or more container overrides.

Public Property PlatformVersion System.String

Gets and sets the property PlatformVersion.

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.

Public Property PullStartedAt System.DateTime

Gets and sets the property PullStartedAt.

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

Public Property PullStoppedAt System.DateTime

Gets and sets the property PullStoppedAt.

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

Public Property StartedAt System.DateTime

Gets and sets the property StartedAt.

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

Public Property StartedBy System.String

Gets and sets the property 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 Property StoppedAt System.DateTime

Gets and sets the property StoppedAt.

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

Public Property StoppedReason System.String

Gets and sets the property StoppedReason.

The reason the task was stopped.

Public Property StoppingAt System.DateTime

Gets and sets the property StoppingAt.

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

Public Property TaskArn System.String

Gets and sets the property TaskArn.

The Amazon Resource Name (ARN) of the task.

Public Property TaskDefinitionArn System.String

Gets and sets the property TaskDefinitionArn.

The ARN of the task definition that creates the task.

Public Property Version System.Int64

Gets and sets the property 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 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.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms