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.

Container for the parameters to the UpdateService operation. Modifies the desired count, deployment configuration, or task definition used in a service.

You can add to or subtract from the number of instantiations of a task definition in a service by specifying the cluster that the service is running in and a new desiredCount parameter.

You can use UpdateService to modify your task definition and deploy a new version of your service.

You can also update the deployment configuration of a service. When a deployment is triggered by updating the task definition of a service, the service scheduler uses the deployment configuration parameters, minimumHealthyPercent and maximumPercent, to determine the deployment strategy.

When UpdateService stops a task during a deployment, the equivalent of

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

When the service scheduler launches new tasks, it determines task placement in your cluster with the following logic:

When the service scheduler stops running tasks, it attempts to maintain balance across the Availability Zones in your cluster using the following logic:

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.ECS.AmazonECSRequest
      Amazon.ECS.Model.UpdateServiceRequest

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

Syntax

C#
public class UpdateServiceRequest : AmazonECSRequest
         IAmazonWebServiceRequest

The UpdateServiceRequest type exposes the following members

Constructors

NameDescription
Public Method UpdateServiceRequest()

Properties

NameTypeDescription
Public Property Cluster System.String

Gets and sets the property Cluster.

The short name or full Amazon Resource Name (ARN) of the cluster that your service is running on. If you do not specify a cluster, the default cluster is assumed.

Public Property DeploymentConfiguration Amazon.ECS.Model.DeploymentConfiguration

Gets and sets the property DeploymentConfiguration.

Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.

Public Property DesiredCount System.Int32

Gets and sets the property DesiredCount.

The number of instantiations of the task to place and keep running in your service.

Public Property Service System.String

Gets and sets the property Service.

The name of the service to update.

Public Property TaskDefinition System.String

Gets and sets the property TaskDefinition.

The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition to run in your service. If a revision is not specified, the latest ACTIVE revision is used. If you modify the task definition with UpdateService, Amazon ECS spawns a task with the new version of the task definition and then stops an old task after the new version is running.

Examples

This example updates the my-http-service service to use the amazon-ecs-sample task definition.

To change the task definition used in a service


var response = client.UpdateService(new UpdateServiceRequest 
{
    Service = "my-http-service",
    TaskDefinition = "amazon-ecs-sample"
});


            

This example updates the desired count of the my-http-service service to 10.

To change the number of tasks in a service


var response = client.UpdateService(new UpdateServiceRequest 
{
    DesiredCount = 10,
    Service = "my-http-service"
});


            

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