Struct aws_sdk_ecs::client::fluent_builders::StopTask

pub struct StopTask { /* private fields */ }

Fluent builder constructing a request to StopTask.

Stops a running task. Any tags associated with the task will be deleted.

When StopTask is called on a task, the equivalent of docker stop is issued to the containers running in the task. This results in a SIGTERM value and a default 30-second timeout, after which the SIGKILL value is sent and the containers are forcibly stopped. If the container handles the SIGTERM value gracefully and exits within 30 seconds from receiving it, no SIGKILL value is sent.

The default 30-second timeout can be configured on the Amazon ECS container agent with the ECS_CONTAINER_STOP_TIMEOUT variable. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.

Implementations

impl StopTask

pub async fn send(self) -> Result<StopTaskOutput, SdkError<StopTaskError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn cluster(self, input: impl Into<String>) -> Self

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to stop. If you do not specify a cluster, the default cluster is assumed.

pub fn set_cluster(self, input: Option<String>) -> Self

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to stop. If you do not specify a cluster, the default cluster is assumed.

pub fn task(self, input: impl Into<String>) -> Self

The task ID or full Amazon Resource Name (ARN) of the task to stop.

pub fn set_task(self, input: Option<String>) -> Self

The task ID or full Amazon Resource Name (ARN) of the task to stop.

pub fn reason(self, input: impl Into<String>) -> Self

An optional message specified when a task is stopped. For example, if you're using a custom scheduler, you can use this parameter to specify the reason for stopping the task here, and the message appears in subsequent DescribeTasks API operations on this task. Up to 255 characters are allowed in this message.

pub fn set_reason(self, input: Option<String>) -> Self

An optional message specified when a task is stopped. For example, if you're using a custom scheduler, you can use this parameter to specify the reason for stopping the task here, and the message appears in subsequent DescribeTasks API operations on this task. Up to 255 characters are allowed in this message.

Trait Implementations

impl Clone for StopTask

fn clone(&self) -> StopTask

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StopTask

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

Formats the value using the given formatter.