Service

class Service

Details on a service within a cluster.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The principal that created the service.

Link copied to clipboard

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

Link copied to clipboard

The deployment controller type the service is using.

Link copied to clipboard

The current state of deployments for the service.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The placement constraints for the tasks in the service.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
val tags: List<Tag>?

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Functions

Link copied to clipboard
inline fun copy(block: Service.Builder.() -> Unit = {}): Service
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String