@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
| Modifier and Type | Class and Description |
|---|---|
static interface |
Service.Builder |
| Modifier and Type | Method and Description |
|---|---|
static Service.Builder |
builder() |
List<CapacityProviderStrategyItem> |
capacityProviderStrategy()
The capacity provider strategy associated with the service.
|
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 |
enableExecuteCommand()
Whether or not the execute command functionality is enabled for 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) |
boolean |
hasCapacityProviderStrategy()
Returns true if the CapacityProviderStrategy property was specified by the sender (it may be empty), or false if
the sender did not specify the value (it will be empty).
|
boolean |
hasDeployments()
Returns true if the Deployments property was specified by the sender (it may be empty), or false if the sender
did not specify the value (it will be empty).
|
boolean |
hasEvents()
Returns true if the Events property was specified by the sender (it may be empty), or false if the sender did not
specify the value (it will be empty).
|
int |
hashCode() |
boolean |
hasLoadBalancers()
Returns true if the LoadBalancers property was specified by the sender (it may be empty), or false if the sender
did not specify the value (it will be empty).
|
boolean |
hasPlacementConstraints()
Returns true if the PlacementConstraints property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
boolean |
hasPlacementStrategy()
Returns true if the PlacementStrategy property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
boolean |
hasServiceRegistries()
Returns true if the ServiceRegistries property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
boolean |
hasTags()
Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not
specify the value (it will be empty).
|
boolean |
hasTaskSets()
Returns true if the TaskSets property was specified by the sender (it may be empty), or false if the sender did
not specify the value (it will be empty).
|
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.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final 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.
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.public final 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.
public final String clusterArn()
The Amazon Resource Name (ARN) of the cluster that hosts the service.
public final boolean hasLoadBalancers()
public final 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.
You can use hasLoadBalancers() to see if a value was sent in this field.
public final boolean hasServiceRegistries()
public final 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.
You can use hasServiceRegistries() to see if a value was sent in this field.
public final String status()
The status of the service. The valid values are ACTIVE, DRAINING, or
INACTIVE.
ACTIVE, DRAINING, or
INACTIVE.public final 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.
public final Integer runningCount()
The number of tasks in the cluster that are in the RUNNING state.
RUNNING state.public final Integer pendingCount()
The number of tasks in the cluster that are in the PENDING state.
PENDING state.public final 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().
EC2. Valid values include EC2 and FARGATE. For more information,
see Amazon ECS
Launch Types in the Amazon Elastic Container Service Developer Guide.LaunchTypepublic final 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().
EC2. Valid values include EC2 and FARGATE. For more information,
see Amazon ECS
Launch Types in the Amazon Elastic Container Service Developer Guide.LaunchTypepublic final boolean hasCapacityProviderStrategy()
public final List<CapacityProviderStrategyItem> capacityProviderStrategy()
The capacity provider strategy associated with the service.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasCapacityProviderStrategy() to see if a value was sent in this field.
public final 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.
LATEST platform version is used by
default. For more information, see AWS Fargate
Platform Versions in the Amazon Elastic Container Service Developer Guide.public final 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.
public final DeploymentConfiguration deploymentConfiguration()
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
public final boolean hasTaskSets()
public final 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.
You can use hasTaskSets() to see if a value was sent in this field.
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.public final boolean hasDeployments()
public final 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.
You can use hasDeployments() to see if a value was sent in this field.
public final 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.
public final boolean hasEvents()
public final 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.
You can use hasEvents() to see if a value was sent in this field.
public final Instant createdAt()
The Unix timestamp for when the service was created.
public final boolean hasPlacementConstraints()
public final 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.
You can use hasPlacementConstraints() to see if a value was sent in this field.
public final boolean hasPlacementStrategy()
public final 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.
You can use hasPlacementStrategy() to see if a value was sent in this field.
public final NetworkConfiguration networkConfiguration()
The VPC subnet and security group configuration for tasks that receive their own elastic network interface by
using the awsvpc networking mode.
awsvpc networking mode.public final 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.
public final 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 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.
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().
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.
SchedulingStrategypublic final 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 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.
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().
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.
SchedulingStrategypublic final 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.
ECS deployment controller type.public final boolean hasTags()
public final 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.
You can use hasTags() to see if a value was sent in this field.
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.
public final String createdBy()
The principal that created the service.
public final 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.
public final 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().
PropagateTagspublic final 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().
PropagateTagspublic final Boolean 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.
true, the
execute command functionality is enabled for all containers in tasks as part of the service.public Service.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<Service.Builder,Service>public static Service.Builder builder()
public static Class<? extends Service.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
Copyright © 2021. All rights reserved.