Service (AWS Java SDK :: Services :: Amazon EC2 Container Service 2.9.26 API)

java.lang.Object
- software.amazon.awssdk.services.ecs.model.Service

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Service.Builder,Service>

@Generated(value="software.amazon.awssdk:codegen")
public final class Service
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Service.Builder,Service>

Details on a service within a cluster

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Service.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Service.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Service.Builder`	`builder()`
`String`	`clusterArn()` The Amazon Resource Name (ARN) of the cluster that hosts the service.
`Instant`	`createdAt()` The Unix timestamp for when the service was created.
`String`	`createdBy()` The principal that created the service.
`DeploymentConfiguration`	`deploymentConfiguration()` Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
`DeploymentController`	`deploymentController()` The deployment controller type the service is using.
`List<Deployment>`	`deployments()` The current state of deployments for the service.
`Integer`	`desiredCount()` The desired number of instantiations of the task definition to keep running on the service.
`Boolean`	`enableECSManagedTags()` Specifies whether to enable Amazon ECS managed tags for the tasks in the service.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<ServiceEvent>`	`events()` The event stream for your service.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Integer`	`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.
`LaunchType`	`launchType()` The launch type on which your service is running.
`String`	`launchTypeAsString()` The launch type on which your service is running.
`List<LoadBalancer>`	`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.
`NetworkConfiguration`	`networkConfiguration()` The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the `awsvpc` networking mode.
`Integer`	`pendingCount()` The number of tasks in the cluster that are in the `PENDING` state.
`List<PlacementConstraint>`	`placementConstraints()` The placement constraints for the tasks in the service.
`List<PlacementStrategy>`	`placementStrategy()` The placement strategy that determines how tasks for the service are placed.
`String`	`platformVersion()` The platform version on which to run your service.
`PropagateTags`	`propagateTags()` Specifies whether to propagate the tags from the task definition or the service to the task.
`String`	`propagateTagsAsString()` Specifies whether to propagate the tags from the task definition or the service to the task.
`String`	`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.
`Integer`	`runningCount()` The number of tasks in the cluster that are in the `RUNNING` state.
`SchedulingStrategy`	`schedulingStrategy()` The scheduling strategy to use for the service.
`String`	`schedulingStrategyAsString()` The scheduling strategy to use for the service.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Service.Builder>`	`serializableBuilderClass()`
`String`	`serviceArn()` The ARN that identifies the service.
`String`	`serviceName()` The name of your service.
`List<ServiceRegistry>`	`serviceRegistries()` The details of the service discovery registries to assign to this service.
`String`	`status()` The status of the service.
`List<Tag>`	`tags()` The metadata that you apply to the service to help you categorize and organize them.
`String`	`taskDefinition()` The task definition to use for tasks in the service.
`List<TaskSet>`	`taskSets()` Information about a set of Amazon ECS tasks in either an AWS CodeDeploy or an `EXTERNAL` deployment.
`Service.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - serviceArn
```
public String 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.
    
    Returns:
    
    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.
  - serviceName
```
public String serviceName()
```
    The name of your service. Up to 255 letters (uppercase and lowercase), numbers, 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.
    
    Returns:
    
    The name of your service. Up to 255 letters (uppercase and lowercase), numbers, 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.
  - clusterArn
```
public String clusterArn()
```
    The Amazon Resource Name (ARN) of the cluster that hosts the service.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the cluster that hosts the service.
  - loadBalancers
```
public List<LoadBalancer> 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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    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.
  - serviceRegistries
```
public List<ServiceRegistry> serviceRegistries()
```
    The details of the service discovery registries to assign to this service. For more information, see Service Discovery.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The details of the service discovery registries to assign to this service. For more information, see Service Discovery.
  - status
```
public String status()
```
    The status of the service. The valid values are ACTIVE, DRAINING, or INACTIVE.
    
    Returns:
    
    The status of the service. The valid values are ACTIVE, DRAINING, or INACTIVE.
  - desiredCount
```
public Integer 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.
    
    Returns:
    
    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.
  - runningCount
```
public Integer runningCount()
```
    The number of tasks in the cluster that are in the RUNNING state.
    
    Returns:
    
    The number of tasks in the cluster that are in the RUNNING state.
  - pendingCount
```
public Integer pendingCount()
```
    The number of tasks in the cluster that are in the PENDING state.
    
    Returns:
    
    The number of tasks in the cluster that are in the PENDING state.
  - launchType
```
public LaunchType launchType()
```
    The launch type on which your service is running. If no value is specified, it will default to EC2. Valid values include EC2 and FARGATE. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
    
    If the service returns an enum value that is not available in the current SDK version, launchType will return LaunchType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from launchTypeAsString().
    
    Returns:
    
    The launch type on which your service is running. If no value is specified, it will default to EC2. Valid values include EC2 and FARGATE. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
    
    See Also:
    
    LaunchType
  - launchTypeAsString
```
public String launchTypeAsString()
```
    The launch type on which your service is running. If no value is specified, it will default to EC2. Valid values include EC2 and FARGATE. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
    
    If the service returns an enum value that is not available in the current SDK version, launchType will return LaunchType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from launchTypeAsString().
    
    Returns:
    
    The launch type on which your service is running. If no value is specified, it will default to EC2. Valid values include EC2 and FARGATE. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
    
    See Also:
    
    LaunchType
  - platformVersion
```
public String platformVersion()
```
    The platform version on which to run your service. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
    
    Returns:
    
    The platform version on which to run your service. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
  - taskDefinition
```
public String 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.
    
    Returns:
    
    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.
  - deploymentConfiguration
```
public DeploymentConfiguration deploymentConfiguration()
```
    Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
    
    Returns:
    
    Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
  - taskSets
```
public List<TaskSet> taskSets()
```
    Information about a set of Amazon ECS tasks in either an AWS 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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    Information about a set of Amazon ECS tasks in either an AWS 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.
  - deployments
```
public List<Deployment> deployments()
```
    The current state of deployments for the service.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The current state of deployments for the service.
  - roleArn
```
public String 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.
    
    Returns:
    
    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.
  - events
```
public List<ServiceEvent> events()
```
    The event stream for your service. A maximum of 100 of the latest events are displayed.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The event stream for your service. A maximum of 100 of the latest events are displayed.
  - createdAt
```
public Instant createdAt()
```
    The Unix timestamp for when the service was created.
    
    Returns:
    
    The Unix timestamp for when the service was created.
  - placementConstraints
```
public List<PlacementConstraint> placementConstraints()
```
    The placement constraints for the tasks in the service.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The placement constraints for the tasks in the service.
  - placementStrategy
```
public List<PlacementStrategy> placementStrategy()
```
    The placement strategy that determines how tasks for the service are placed.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The placement strategy that determines how tasks for the service are placed.
  - networkConfiguration
```
public NetworkConfiguration networkConfiguration()
```
    The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.
    
    Returns:
    
    The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.
  - healthCheckGracePeriodSeconds
```
public Integer 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.
    
    Returns:
    
    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.
  - schedulingStrategy
```
public SchedulingStrategy 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 you are 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.
    If the service returns an enum value that is not available in the current SDK version, schedulingStrategy will return SchedulingStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from schedulingStrategyAsString().
    Returns:
    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 you are 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.
    See Also:
    
    SchedulingStrategy
  - schedulingStrategyAsString
```
public String schedulingStrategyAsString()
```
    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 you are 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.
    If the service returns an enum value that is not available in the current SDK version, schedulingStrategy will return SchedulingStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from schedulingStrategyAsString().
    Returns:
    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 you are 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.
    See Also:
    
    SchedulingStrategy
  - deploymentController
```
public DeploymentController 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.
    
    Returns:
    
    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.
  - tags
```
public List<Tag> 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 AWS 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.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    Returns:
    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 AWS 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.
  - createdBy
```
public String createdBy()
```
    The principal that created the service.
    
    Returns:
    
    The principal that created the service.
  - enableECSManagedTags
```
public Boolean 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.
    
    Returns:
    
    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.
  - propagateTags
```
public PropagateTags 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.
    
    If the service returns an enum value that is not available in the current SDK version, propagateTags will return PropagateTags.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from propagateTagsAsString().
    
    Returns:
    
    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.
    
    See Also:
    
    PropagateTags
  - propagateTagsAsString
```
public String propagateTagsAsString()
```
    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.
    
    If the service returns an enum value that is not available in the current SDK version, propagateTags will return PropagateTags.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from propagateTagsAsString().
    
    Returns:
    
    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.
    
    See Also:
    
    PropagateTags
  - toBuilder
```
public Service.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Service.Builder,Service>
  - builder
```
public static Service.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Service.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class Service

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

serviceArn

serviceName

clusterArn

loadBalancers

serviceRegistries

status

desiredCount

runningCount

pendingCount

launchType

launchTypeAsString

platformVersion

taskDefinition

deploymentConfiguration

taskSets

deployments

roleArn

events

createdAt

placementConstraints

placementStrategy

networkConfiguration

healthCheckGracePeriodSeconds

schedulingStrategy

schedulingStrategyAsString

deploymentController

tags

createdBy

enableECSManagedTags

propagateTags

propagateTagsAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields