AWS SDK Version 2 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.

.NET Framework 4.5
 
Details on a service within a cluster

Inheritance Hierarchy

System.Object
  Amazon.ECS.Model.Service

Namespace: Amazon.ECS.Model
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

C#
public class Service : Object

The Service type exposes the following members

Constructors

NameDescription
Public Method Service()

Properties

NameTypeDescription
Public Property ClusterArn System.String Gets and sets the property ClusterArn.

The Amazon Resource Name (ARN) of the of the cluster that hosts the service.

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 Deployments System.Collections.Generic.List<Amazon.ECS.Model.Deployment> Gets and sets the property Deployments.

The current state of deployments for the service.

Public Property DesiredCount System.Int32 Gets and sets the property DesiredCount.

The desired number of instantiations of the task definition to keep running on the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.

Public Property Events System.Collections.Generic.List<Amazon.ECS.Model.ServiceEvent> Gets and sets the property Events.

The event stream for your service. A maximum of 100 of the latest events are displayed.

Public Property LoadBalancers System.Collections.Generic.List<Amazon.ECS.Model.LoadBalancer> Gets and sets the property LoadBalancers.

A list of load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.

Public Property PendingCount System.Int32 Gets and sets the property PendingCount.

The number of tasks in the cluster that are in the PENDING state.

Public Property RoleArn System.String Gets and sets the property RoleArn.

The Amazon Resource Name (ARN) of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with a load balancer.

Public Property RunningCount System.Int32 Gets and sets the property RunningCount.

The number of tasks in the cluster that are in the RUNNING state.

Public Property ServiceArn System.String Gets and sets the property ServiceArn.

The Amazon Resource Name (ARN) that identifies the service. The ARN contains the arn:aws:ecs namespace, followed by the region of the service, the AWS account ID of the service owner, the service namespace, and then the service name. For example, arn:aws:ecs:region:012345678910:service/my-service.

Public Property ServiceName System.String Gets and sets the property ServiceName.

The name of your service. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a region or across multiple regions.

Public Property Status System.String Gets and sets the property Status.

The status of the service. The valid values are ACTIVE, DRAINING, or INACTIVE.

Public Property TaskDefinition System.String Gets and sets the property TaskDefinition.

The task definition to use for tasks in the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

.NET for Windows Store apps:
Supported in: Windows 8