Documentation

Details on a service within a cluster

See: newContainerService smart constructor.

Create a value of ContainerService with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:taskSets:ContainerService', containerService_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.

$sel:runningCount:ContainerService', containerService_runningCount - The number of tasks in the cluster that are in the RUNNING state.

$sel:status:ContainerService', containerService_status - The status of the service. The valid values are ACTIVE, DRAINING, or INACTIVE.

$sel:clusterArn:ContainerService', containerService_clusterArn - The Amazon Resource Name (ARN) of the cluster that hosts the service.

$sel:propagateTags:ContainerService', containerService_propagateTags - Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated.

$sel:createdAt:ContainerService', containerService_createdAt - The Unix timestamp for when the service was created.

$sel:platformVersion:ContainerService', containerService_platformVersion - The platform version on which to run your service. A platform version is only specified for tasks hosted on Fargate. If one is not specified, the LATEST platform version is used by default. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

$sel:enableECSManagedTags:ContainerService', containerService_enableECSManagedTags - Specifies whether to enable 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.

$sel:createdBy:ContainerService', containerService_createdBy - The principal that created the service.

$sel:desiredCount:ContainerService', containerService_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.

$sel:loadBalancers:ContainerService', containerService_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.

$sel:pendingCount:ContainerService', containerService_pendingCount - The number of tasks in the cluster that are in the PENDING state.

$sel:placementConstraints:ContainerService', containerService_placementConstraints - The placement constraints for the tasks in the service.

$sel:events:ContainerService', containerService_events - The event stream for your service. A maximum of 100 of the latest events are displayed.

$sel:placementStrategy:ContainerService', containerService_placementStrategy - The placement strategy that determines how tasks for the service are placed.

$sel:deployments:ContainerService', containerService_deployments - The current state of deployments for the service.

$sel:serviceName:ContainerService', containerService_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, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.

$sel:deploymentController:ContainerService', containerService_deploymentController - The deployment controller type the service is using. When using the DescribeServices API, this field is omitted if the service is using the ECS deployment controller type.

$sel:launchType:ContainerService', containerService_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.

$sel:serviceArn:ContainerService', containerService_serviceArn - The ARN that identifies the service. The ARN contains the arn:aws:ecs namespace, followed by the Region of the service, the Amazon Web Services account ID of the service owner, the service namespace, and then the service name. For example, arn:aws:ecs:region:012345678910:service/my-service.

$sel:taskDefinition:ContainerService', containerService_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.

$sel:schedulingStrategy:ContainerService', containerService_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 that 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 and will stop tasks that do not meet the placement constraints.

  Fargate tasks do not support the DAEMON scheduling strategy.

$sel:healthCheckGracePeriodSeconds:ContainerService', containerService_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.

$sel:networkConfiguration:ContainerService', containerService_networkConfiguration - The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

$sel:serviceRegistries:ContainerService', containerService_serviceRegistries - The details of the service discovery registries to assign to this service. For more information, see Service Discovery.

$sel:capacityProviderStrategy:ContainerService', containerService_capacityProviderStrategy - The capacity provider strategy the service is using. When using the DescribeServices API, this field is omitted if the service was created using a launch type.

$sel:enableExecuteCommand:ContainerService', containerService_enableExecuteCommand - Whether or not the execute command functionality is enabled for the service. If true, the execute command functionality is enabled for all containers in tasks as part of the service.

$sel:tags:ContainerService', containerService_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, both of which you define.

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.

$sel:roleArn:ContainerService', containerService_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.

$sel:deploymentConfiguration:ContainerService', containerService_deploymentConfiguration - Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.

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.

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

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

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

Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated.

The Unix timestamp for when the service was created.

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

Specifies whether to enable 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.

The principal that created 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.

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.

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

The placement constraints for the tasks in the service.

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

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

The current state of deployments for the service.

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, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.

The deployment controller type the service is using. When using the DescribeServices API, this field is omitted if the service is using the ECS deployment controller type.

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.

The ARN that identifies the service. The ARN contains the arn:aws:ecs namespace, followed by the Region of the service, the Amazon Web Services account ID of the service owner, the service namespace, and then the service name. For example, arn:aws:ecs:region:012345678910:service/my-service.

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.

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 that 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 and will stop tasks that do not meet the placement constraints.

  Fargate tasks do not support the DAEMON scheduling strategy.

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 VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

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

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

Whether or not the execute command functionality is enabled for the service. If true, the execute command functionality is enabled for all containers in tasks as part of the service.

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, both of which you define.

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.

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.

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