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.

Details on a service within a cluster

Inheritance Hierarchy

System.Object
  Amazon.ECS.Model.Service

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

Syntax

C#
public class Service

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 cluster that hosts the service.

Public Property CreatedAt System.DateTime

Gets and sets the property CreatedAt.

The Unix time stamp for when the service was created.

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 HealthCheckGracePeriodSeconds System.Int32

Gets and sets the property HealthCheckGracePeriodSeconds.

The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started.

Public Property LaunchType Amazon.ECS.LaunchType

Gets and sets the property LaunchType.

The launch type on which your service is running.

Public Property LoadBalancers System.Collections.Generic.List<Amazon.ECS.Model.LoadBalancer>

Gets and sets the property LoadBalancers.

A list of Elastic Load Balancing 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.

Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers; Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ip as the target type, not instance, because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.

Public Property NetworkConfiguration Amazon.ECS.Model.NetworkConfiguration

Gets and sets the property NetworkConfiguration.

The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

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 PlacementConstraints System.Collections.Generic.List<Amazon.ECS.Model.PlacementConstraint>

Gets and sets the property PlacementConstraints.

The placement constraints for the tasks in the service.

Public Property PlacementStrategy System.Collections.Generic.List<Amazon.ECS.Model.PlacementStrategy>

Gets and sets the property PlacementStrategy.

The placement strategy that determines how tasks for the service are placed.

Public Property PlatformVersion System.String

Gets and sets the property PlatformVersion.

The platform version on which your task is running. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

Public Property RoleArn System.String

Gets and sets the property RoleArn.

The ARN of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing 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 SchedulingStrategy Amazon.ECS.SchedulingStrategy

Gets and sets the property SchedulingStrategy.

The scheduling strategy to use for the service. For more information, see Services.

There are two service scheduler strategies available:

  • REPLICA-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions.

  • DAEMON-The daemon scheduling strategy deploys exactly one task on each container instance in your cluster. When using this strategy, do not specify a desired number of tasks or any task placement strategies.

    Fargate tasks do not support the DAEMON scheduling strategy.

Public Property ServiceArn System.String

Gets and sets the property ServiceArn.

The 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 ServiceRegistries System.Collections.Generic.List<Amazon.ECS.Model.ServiceRegistry>

Gets and sets the property ServiceRegistries.

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 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