Service

Gets and sets the property CapacityProviderStrategy.

The capacity provider strategy the service uses. When using the DescribeServices API, this field is omitted if the service was created using a launch type.

Gets and sets the property ClusterArn.

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

Gets and sets the property CreatedAt.

The Unix timestamp for the time when the service was created.

Gets and sets the property CreatedBy.

The principal that created the service.

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.

Gets and sets the property DeploymentController.

The deployment controller type the service is using.

Gets and sets the property Deployments.

The current state of deployments for the service.

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.

Gets and sets the property EnableECSManagedTags.

Determines whether to use Amazon ECS managed tags for the tasks in the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

Gets and sets the property EnableExecuteCommand.

Determines whether the execute command functionality is turned on for the service. If true, the execute command functionality is turned on for all containers in tasks as part of the service.

Gets and sets the property Events.

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

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.

Gets and sets the property LaunchType.

The launch type the service is using. When using the DescribeServices API, this field is omitted if the service was created using a capacity provider strategy.

Gets and sets the property LoadBalancers.

A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the container name, and the container port to access from the load balancer. The container name is as it appears in a container definition.

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.

Gets and sets the property PendingCount.

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

Gets and sets the property PlacementConstraints.

The placement constraints for the tasks in the service.

Gets and sets the property PlacementStrategy.

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

Gets and sets the property PlatformFamily.

The operating system that your tasks in the service run on. A platform family is specified only for tasks using the Fargate launch type.

All tasks that run as part of this service must use the same platformFamily value as the service (for example, LINUX).

Gets and sets the property PlatformVersion.

The platform version to run your service on. A platform version is only specified for tasks that are hosted on Fargate. If one isn't specified, the LATEST platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

Gets and sets the property PropagateTags.

Determines whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags aren't propagated.

Gets and sets the property RoleArn.

The ARN of the IAM role that's associated with the service. It allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.

Gets and sets the property RunningCount.

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

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 active container instance. This task meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks. It stop tasks that don't meet the placement constraints.

  Fargate tasks don't support the DAEMON scheduling strategy.

Gets and sets the property ServiceArn.

The ARN that identifies the service. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.

Gets and sets the property ServiceName.

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

Gets and sets the property ServiceRegistries.

The details for the service discovery registries to assign to this service. For more information, see Service Discovery.

Gets and sets the property Status.

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

Gets and sets the property Tags.

The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value. You define bot the key and value.

The following basic restrictions apply to tags:

• Maximum number of tags per resource - 50

• For each resource, each tag key must be unique, and each tag key can have only one value.

• Maximum key length - 128 Unicode characters in UTF-8

• Maximum value length - 256 Unicode characters in UTF-8

• If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

• Tag keys and values are case-sensitive.

• Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

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.

Gets and sets the property TaskSets.

Information about a set of Amazon ECS tasks in either an CodeDeploy or an EXTERNAL deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic.