Struct aws_sdk_ecs::model::Task

source · [−]

#[non_exhaustive]
pub struct Task {Show 36 fields
    pub attachments: Option<Vec<Attachment>>,
    pub attributes: Option<Vec<Attribute>>,
    pub availability_zone: Option<String>,
    pub capacity_provider_name: Option<String>,
    pub cluster_arn: Option<String>,
    pub connectivity: Option<Connectivity>,
    pub connectivity_at: Option<DateTime>,
    pub container_instance_arn: Option<String>,
    pub containers: Option<Vec<Container>>,
    pub cpu: Option<String>,
    pub created_at: Option<DateTime>,
    pub desired_status: Option<String>,
    pub enable_execute_command: bool,
    pub execution_stopped_at: Option<DateTime>,
    pub group: Option<String>,
    pub health_status: Option<HealthStatus>,
    pub inference_accelerators: Option<Vec<InferenceAccelerator>>,
    pub last_status: Option<String>,
    pub launch_type: Option<LaunchType>,
    pub memory: Option<String>,
    pub overrides: Option<TaskOverride>,
    pub platform_version: Option<String>,
    pub platform_family: Option<String>,
    pub pull_started_at: Option<DateTime>,
    pub pull_stopped_at: Option<DateTime>,
    pub started_at: Option<DateTime>,
    pub started_by: Option<String>,
    pub stop_code: Option<TaskStopCode>,
    pub stopped_at: Option<DateTime>,
    pub stopped_reason: Option<String>,
    pub stopping_at: Option<DateTime>,
    pub tags: Option<Vec<Tag>>,
    pub task_arn: Option<String>,
    pub task_definition_arn: Option<String>,
    pub version: i64,
    pub ephemeral_storage: Option<EphemeralStorage>,
}

Expand description

Details on a task in a cluster.

Fields (Non-exhaustive)

This struct is marked as non-exhaustive

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

attachments: Option<Vec<Attachment>>

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

attributes: Option<Vec<Attribute>>

The attributes of the task

availability_zone: Option<String>

The Availability Zone for the task.

capacity_provider_name: Option<String>

The capacity provider that's associated with the task.

cluster_arn: Option<String>

The ARN of the cluster that hosts the task.

connectivity: Option<Connectivity>

The connectivity status of a task.

connectivity_at: Option<DateTime>

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

container_instance_arn: Option<String>

The ARN of the container instances that host the task.

containers: Option<Vec<Container>>

The containers that's associated with the task.

cpu: Option<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.

If you use 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 use the Fargate launch type, this field is required. You must use one of the following values. These values determine the range of supported values for the memory parameter:

The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.

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)

created_at: Option<DateTime>

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.

desired_status: Option<String>

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

enable_execute_command: bool

Determines whether execute command functionality is enabled for this task. If true, execute command functionality is enabled on all the containers in the task.

execution_stopped_at: Option<DateTime>

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

group: Option<String>

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

health_status: Option<HealthStatus>

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.

The Amazon ECS container agent doesn't monitor or report on Docker health checks that are embedded in a container image and not specified in the container definition. For example, this includes those specified in a parent image or from the image's Dockerfile. Health check parameters that are specified in a container definition override any Docker health checks that are found in the container image.

inference_accelerators: Option<Vec<InferenceAccelerator>>

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

last_status: Option<String>

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

launch_type: Option<LaunchType>

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

memory: Option<String>

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.

If you use the EC2 launch type, this field is optional.

If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines the 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)

overrides: Option<TaskOverride>

One or more container overrides.

platform_version: Option<String>

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.

platform_family: Option<String>

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

All tasks that run as part of this service must use the same platformFamily value as the service (for example, LINUX.).

pull_started_at: Option<DateTime>

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

pull_stopped_at: Option<DateTime>

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

started_at: Option<DateTime>

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.

started_by: Option<String>

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.

stop_code: Option<TaskStopCode>

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

The following are valid values:

TaskFailedToStart
EssentialContainerExited
UserInitiated
TerminationNotice
ServiceSchedulerInitiated
SpotInterruption

stopped_at: Option<DateTime>

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.

stopped_reason: Option<String>

The reason that the task was stopped.

stopping_at: Option<DateTime>

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 STOPPED.

tags: Option<Vec<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.

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 Amazon Web Services 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.

task_arn: Option<String>

The Amazon Resource Name (ARN) of the task.

task_definition_arn: Option<String>

The ARN of the task definition that creates the task.

version: i64

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.

ephemeral_storage: Option<EphemeralStorage>

The ephemeral storage settings for the task.

Struct aws_sdk_ecs::model::Task

Fields (Non-exhaustive)

Implementations

impl Task

pub fn attachments(&self) -> Option<&[Attachment]>

pub fn attributes(&self) -> Option<&[Attribute]>

pub fn availability_zone(&self) -> Option<&str>

pub fn capacity_provider_name(&self) -> Option<&str>

pub fn cluster_arn(&self) -> Option<&str>

pub fn connectivity(&self) -> Option<&Connectivity>

pub fn connectivity_at(&self) -> Option<&DateTime>

pub fn container_instance_arn(&self) -> Option<&str>

pub fn containers(&self) -> Option<&[Container]>

pub fn cpu(&self) -> Option<&str>

pub fn created_at(&self) -> Option<&DateTime>

pub fn desired_status(&self) -> Option<&str>

pub fn enable_execute_command(&self) -> bool

pub fn execution_stopped_at(&self) -> Option<&DateTime>

pub fn group(&self) -> Option<&str>

pub fn health_status(&self) -> Option<&HealthStatus>

pub fn inference_accelerators(&self) -> Option<&[InferenceAccelerator]>

pub fn last_status(&self) -> Option<&str>

pub fn launch_type(&self) -> Option<&LaunchType>

pub fn memory(&self) -> Option<&str>

pub fn overrides(&self) -> Option<&TaskOverride>

pub fn platform_version(&self) -> Option<&str>

pub fn platform_family(&self) -> Option<&str>

pub fn pull_started_at(&self) -> Option<&DateTime>

pub fn pull_stopped_at(&self) -> Option<&DateTime>

pub fn started_at(&self) -> Option<&DateTime>

pub fn started_by(&self) -> Option<&str>

pub fn stop_code(&self) -> Option<&TaskStopCode>

pub fn stopped_at(&self) -> Option<&DateTime>

pub fn stopped_reason(&self) -> Option<&str>

pub fn stopping_at(&self) -> Option<&DateTime>

pub fn tags(&self) -> Option<&[Tag]>

pub fn task_arn(&self) -> Option<&str>

pub fn task_definition_arn(&self) -> Option<&str>

pub fn version(&self) -> i64

pub fn ephemeral_storage(&self) -> Option<&EphemeralStorage>

impl Task

pub fn builder() -> Builder

Trait Implementations

impl Clone for Task

fn clone(&self) -> Task

fn clone_from(&mut self, source: &Self)

impl Debug for Task

fn fmt(&self, f: &mut Formatter<'_>) -> Result

impl PartialEq<Task> for Task

fn eq(&self, other: &Task) -> bool

fn ne(&self, other: &Task) -> bool

impl StructuralPartialEq for Task

Auto Trait Implementations

impl RefUnwindSafe for Task

impl Send for Task

impl Sync for Task

impl Unpin for Task

impl UnwindSafe for Task

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

pub fn attachments(&self) -> Option<&[Attachment ]>

pub fn attributes(&self) -> Option<&[Attribute ]>

pub fn containers(&self) -> Option<&[Container ]>

pub fn inference_accelerators(&self) -> Option<&[InferenceAccelerator ]>

pub fn tags(&self) -> Option<&[Tag ]>

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,