Service
Details on a service within a cluster.
Types
Properties
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.
The Amazon Resource Name (ARN) of the cluster that hosts the service.
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
The deployment controller type the service is using.
The current state of deployments for the service.
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.
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.
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.
The event stream for your service. A maximum of 100 of the latest events are displayed.
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.
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.
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.
The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc
networking mode.
The number of tasks in the cluster that are in the PENDING
state.
The placement constraints for the tasks in the service.
The placement strategy that determines how tasks for the service are placed.
The operating system that your tasks in the service run on. A platform family is specified only for tasks using the Fargate launch type.
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.
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.
The number of tasks in the cluster that are in the RUNNING
state.
The scheduling strategy to use for the service. For more information, see Services.
The ARN that identifies the service. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.
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.
The details for the service discovery registries to assign to this service. For more information, see Service Discovery.
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.