Container for the parameters to the StopTask operation. Stops a running task. Any tags associated with the task will be deleted.
When you call StopTask 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.
For Windows containers, POSIX signals do not work and runtime stops the container
by sending a CTRL_SHUTDOWN_EVENT. For more information, see Unable
to react to graceful shutdown of (Windows) container #25982 on GitHub.
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.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.ECS.AmazonECSRequest
Amazon.ECS.Model.StopTaskRequest
Namespace: Amazon.ECS.Model
Assembly: AWSSDK.ECS.dll
Version: 3.x.y.z
Syntax
public class StopTaskRequest : AmazonECSRequest IAmazonWebServiceRequest
The StopTaskRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
StopTaskRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
Cluster | System.String |
Gets and sets the property Cluster. 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. |
|
|
Reason | System.String |
Gets and sets the property Reason. 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. |
|
|
Task | System.String |
Gets and sets the property Task. Thefull Amazon Resource Name (ARN) of the task. |
Examples
This example stops a task with ID "1dc5c17a-422b-4dc4-b493-371970c6c4d6" in cluster "MyCluster".
To stop a task
var client = new AmazonECSClient();
var response = client.StopTask(new StopTaskRequest
{
Cluster = "MyCluster",
Reason = "testing stop task.",
Task = "1dc5c17a-422b-4dc4-b493-371970c6c4d6"
});
Task task = response.Task;
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5