Struct aws_sdk_ecs::operation::stop_task::builders::StopTaskFluentBuilder
source · pub struct StopTaskFluentBuilder { /* private fields */ }
Expand description
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§
source§impl StopTaskFluentBuilder
impl StopTaskFluentBuilder
sourcepub fn as_input(&self) -> &StopTaskInputBuilder
pub fn as_input(&self) -> &StopTaskInputBuilder
Access the StopTask as a reference.
sourcepub async fn send(
self
) -> Result<StopTaskOutput, SdkError<StopTaskError, HttpResponse>>
pub async fn send( self ) -> Result<StopTaskOutput, SdkError<StopTaskError, HttpResponse>>
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.
sourcepub async fn customize(
self
) -> Result<CustomizableOperation<StopTaskOutput, StopTaskError>, SdkError<StopTaskError>>
pub async fn customize( self ) -> Result<CustomizableOperation<StopTaskOutput, StopTaskError>, SdkError<StopTaskError>>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn cluster(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_cluster(self, input: Option<String>) -> Self
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.
sourcepub fn get_cluster(&self) -> &Option<String>
pub fn get_cluster(&self) -> &Option<String>
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.
sourcepub fn reason(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_reason(self, input: Option<String>) -> Self
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.
sourcepub fn get_reason(&self) -> &Option<String>
pub fn get_reason(&self) -> &Option<String>
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§
source§impl Clone for StopTaskFluentBuilder
impl Clone for StopTaskFluentBuilder
source§fn clone(&self) -> StopTaskFluentBuilder
fn clone(&self) -> StopTaskFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more