@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class Service extends Object implements Serializable, Cloneable, StructuredPojo
Details on a service within a cluster
Constructor and Description |
---|
Service() |
Modifier and Type | Method and Description |
---|---|
Service |
clone() |
boolean |
equals(Object obj) |
List<CapacityProviderStrategyItem> |
getCapacityProviderStrategy()
The capacity provider strategy associated with the service.
|
String |
getClusterArn()
The Amazon Resource Name (ARN) of the cluster that hosts the service.
|
Date |
getCreatedAt()
The Unix timestamp for when the service was created.
|
String |
getCreatedBy()
The principal that created the service.
|
DeploymentConfiguration |
getDeploymentConfiguration()
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping
and starting tasks.
|
DeploymentController |
getDeploymentController()
The deployment controller type the service is using.
|
List<Deployment> |
getDeployments()
The current state of deployments for the service.
|
Integer |
getDesiredCount()
The desired number of instantiations of the task definition to keep running on the service.
|
Boolean |
getEnableECSManagedTags()
Specifies whether to enable Amazon ECS managed tags for the tasks in the service.
|
List<ServiceEvent> |
getEvents()
The event stream for your service.
|
Integer |
getHealthCheckGracePeriodSeconds()
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.
|
String |
getLaunchType()
The launch type on which your service is running.
|
List<LoadBalancer> |
getLoadBalancers()
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 |
getNetworkConfiguration()
The VPC subnet and security group configuration for tasks that receive their own elastic network interface by
using the
awsvpc networking mode. |
Integer |
getPendingCount()
The number of tasks in the cluster that are in the
PENDING state. |
List<PlacementConstraint> |
getPlacementConstraints()
The placement constraints for the tasks in the service.
|
List<PlacementStrategy> |
getPlacementStrategy()
The placement strategy that determines how tasks for the service are placed.
|
String |
getPlatformVersion()
The platform version on which to run your service.
|
String |
getPropagateTags()
Specifies whether to propagate the tags from the task definition or the service to the task.
|
String |
getRoleArn()
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 |
getRunningCount()
The number of tasks in the cluster that are in the
RUNNING state. |
String |
getSchedulingStrategy()
The scheduling strategy to use for the service.
|
String |
getServiceArn()
The ARN that identifies the service.
|
String |
getServiceName()
The name of your service.
|
List<ServiceRegistry> |
getServiceRegistries()
The details of the service discovery registries to assign to this service.
|
String |
getStatus()
The status of the service.
|
List<Tag> |
getTags()
The metadata that you apply to the service to help you categorize and organize them.
|
String |
getTaskDefinition()
The task definition to use for tasks in the service.
|
List<TaskSet> |
getTaskSets()
Information about a set of Amazon ECS tasks in either an AWS CodeDeploy or an
EXTERNAL deployment. |
int |
hashCode() |
Boolean |
isEnableECSManagedTags()
Specifies whether to enable Amazon ECS managed tags for the tasks in the service.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setCapacityProviderStrategy(Collection<CapacityProviderStrategyItem> capacityProviderStrategy)
The capacity provider strategy associated with the service.
|
void |
setClusterArn(String clusterArn)
The Amazon Resource Name (ARN) of the cluster that hosts the service.
|
void |
setCreatedAt(Date createdAt)
The Unix timestamp for when the service was created.
|
void |
setCreatedBy(String createdBy)
The principal that created the service.
|
void |
setDeploymentConfiguration(DeploymentConfiguration deploymentConfiguration)
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping
and starting tasks.
|
void |
setDeploymentController(DeploymentController deploymentController)
The deployment controller type the service is using.
|
void |
setDeployments(Collection<Deployment> deployments)
The current state of deployments for the service.
|
void |
setDesiredCount(Integer desiredCount)
The desired number of instantiations of the task definition to keep running on the service.
|
void |
setEnableECSManagedTags(Boolean enableECSManagedTags)
Specifies whether to enable Amazon ECS managed tags for the tasks in the service.
|
void |
setEvents(Collection<ServiceEvent> events)
The event stream for your service.
|
void |
setHealthCheckGracePeriodSeconds(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.
|
void |
setLaunchType(String launchType)
The launch type on which your service is running.
|
void |
setLoadBalancers(Collection<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.
|
void |
setNetworkConfiguration(NetworkConfiguration networkConfiguration)
The VPC subnet and security group configuration for tasks that receive their own elastic network interface by
using the
awsvpc networking mode. |
void |
setPendingCount(Integer pendingCount)
The number of tasks in the cluster that are in the
PENDING state. |
void |
setPlacementConstraints(Collection<PlacementConstraint> placementConstraints)
The placement constraints for the tasks in the service.
|
void |
setPlacementStrategy(Collection<PlacementStrategy> placementStrategy)
The placement strategy that determines how tasks for the service are placed.
|
void |
setPlatformVersion(String platformVersion)
The platform version on which to run your service.
|
void |
setPropagateTags(String propagateTags)
Specifies whether to propagate the tags from the task definition or the service to the task.
|
void |
setRoleArn(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.
|
void |
setRunningCount(Integer runningCount)
The number of tasks in the cluster that are in the
RUNNING state. |
void |
setSchedulingStrategy(String schedulingStrategy)
The scheduling strategy to use for the service.
|
void |
setServiceArn(String serviceArn)
The ARN that identifies the service.
|
void |
setServiceName(String serviceName)
The name of your service.
|
void |
setServiceRegistries(Collection<ServiceRegistry> serviceRegistries)
The details of the service discovery registries to assign to this service.
|
void |
setStatus(String status)
The status of the service.
|
void |
setTags(Collection<Tag> tags)
The metadata that you apply to the service to help you categorize and organize them.
|
void |
setTaskDefinition(String taskDefinition)
The task definition to use for tasks in the service.
|
void |
setTaskSets(Collection<TaskSet> taskSets)
Information about a set of Amazon ECS tasks in either an AWS CodeDeploy or an
EXTERNAL deployment. |
String |
toString()
Returns a string representation of this object.
|
Service |
withCapacityProviderStrategy(CapacityProviderStrategyItem... capacityProviderStrategy)
The capacity provider strategy associated with the service.
|
Service |
withCapacityProviderStrategy(Collection<CapacityProviderStrategyItem> capacityProviderStrategy)
The capacity provider strategy associated with the service.
|
Service |
withClusterArn(String clusterArn)
The Amazon Resource Name (ARN) of the cluster that hosts the service.
|
Service |
withCreatedAt(Date createdAt)
The Unix timestamp for when the service was created.
|
Service |
withCreatedBy(String createdBy)
The principal that created the service.
|
Service |
withDeploymentConfiguration(DeploymentConfiguration deploymentConfiguration)
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping
and starting tasks.
|
Service |
withDeploymentController(DeploymentController deploymentController)
The deployment controller type the service is using.
|
Service |
withDeployments(Collection<Deployment> deployments)
The current state of deployments for the service.
|
Service |
withDeployments(Deployment... deployments)
The current state of deployments for the service.
|
Service |
withDesiredCount(Integer desiredCount)
The desired number of instantiations of the task definition to keep running on the service.
|
Service |
withEnableECSManagedTags(Boolean enableECSManagedTags)
Specifies whether to enable Amazon ECS managed tags for the tasks in the service.
|
Service |
withEvents(Collection<ServiceEvent> events)
The event stream for your service.
|
Service |
withEvents(ServiceEvent... events)
The event stream for your service.
|
Service |
withHealthCheckGracePeriodSeconds(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.
|
Service |
withLaunchType(LaunchType launchType)
The launch type on which your service is running.
|
Service |
withLaunchType(String launchType)
The launch type on which your service is running.
|
Service |
withLoadBalancers(Collection<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.
|
Service |
withLoadBalancers(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.
|
Service |
withNetworkConfiguration(NetworkConfiguration networkConfiguration)
The VPC subnet and security group configuration for tasks that receive their own elastic network interface by
using the
awsvpc networking mode. |
Service |
withPendingCount(Integer pendingCount)
The number of tasks in the cluster that are in the
PENDING state. |
Service |
withPlacementConstraints(Collection<PlacementConstraint> placementConstraints)
The placement constraints for the tasks in the service.
|
Service |
withPlacementConstraints(PlacementConstraint... placementConstraints)
The placement constraints for the tasks in the service.
|
Service |
withPlacementStrategy(Collection<PlacementStrategy> placementStrategy)
The placement strategy that determines how tasks for the service are placed.
|
Service |
withPlacementStrategy(PlacementStrategy... placementStrategy)
The placement strategy that determines how tasks for the service are placed.
|
Service |
withPlatformVersion(String platformVersion)
The platform version on which to run your service.
|
Service |
withPropagateTags(PropagateTags propagateTags)
Specifies whether to propagate the tags from the task definition or the service to the task.
|
Service |
withPropagateTags(String propagateTags)
Specifies whether to propagate the tags from the task definition or the service to the task.
|
Service |
withRoleArn(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.
|
Service |
withRunningCount(Integer runningCount)
The number of tasks in the cluster that are in the
RUNNING state. |
Service |
withSchedulingStrategy(SchedulingStrategy schedulingStrategy)
The scheduling strategy to use for the service.
|
Service |
withSchedulingStrategy(String schedulingStrategy)
The scheduling strategy to use for the service.
|
Service |
withServiceArn(String serviceArn)
The ARN that identifies the service.
|
Service |
withServiceName(String serviceName)
The name of your service.
|
Service |
withServiceRegistries(Collection<ServiceRegistry> serviceRegistries)
The details of the service discovery registries to assign to this service.
|
Service |
withServiceRegistries(ServiceRegistry... serviceRegistries)
The details of the service discovery registries to assign to this service.
|
Service |
withStatus(String status)
The status of the service.
|
Service |
withTags(Collection<Tag> tags)
The metadata that you apply to the service to help you categorize and organize them.
|
Service |
withTags(Tag... tags)
The metadata that you apply to the service to help you categorize and organize them.
|
Service |
withTaskDefinition(String taskDefinition)
The task definition to use for tasks in the service.
|
Service |
withTaskSets(Collection<TaskSet> taskSets)
Information about a set of Amazon ECS tasks in either an AWS CodeDeploy or an
EXTERNAL deployment. |
Service |
withTaskSets(TaskSet... taskSets)
Information about a set of Amazon ECS tasks in either an AWS CodeDeploy or an
EXTERNAL deployment. |
public void setServiceArn(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
.
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
.public String getServiceArn()
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 Service withServiceArn(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
.
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
.public void setServiceName(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.
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 String getServiceName()
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 Service withServiceName(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.
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 void setClusterArn(String clusterArn)
The Amazon Resource Name (ARN) of the cluster that hosts the service.
clusterArn
- The Amazon Resource Name (ARN) of the cluster that hosts the service.public String getClusterArn()
The Amazon Resource Name (ARN) of the cluster that hosts the service.
public Service withClusterArn(String clusterArn)
The Amazon Resource Name (ARN) of the cluster that hosts the service.
clusterArn
- The Amazon Resource Name (ARN) of the cluster that hosts the service.public List<LoadBalancer> getLoadBalancers()
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.
public void setLoadBalancers(Collection<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.
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.public Service withLoadBalancers(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.
NOTE: This method appends the values to the existing list (if any). Use
setLoadBalancers(java.util.Collection)
or withLoadBalancers(java.util.Collection)
if you want
to override the existing values.
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.public Service withLoadBalancers(Collection<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.
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.public List<ServiceRegistry> getServiceRegistries()
The details of the service discovery registries to assign to this service. For more information, see Service Discovery.
public void setServiceRegistries(Collection<ServiceRegistry> serviceRegistries)
The details of the service discovery registries to assign to this service. For more information, see Service Discovery.
serviceRegistries
- The details of the service discovery registries to assign to this service. For more information, see Service
Discovery.public Service withServiceRegistries(ServiceRegistry... serviceRegistries)
The details of the service discovery registries to assign to this service. For more information, see Service Discovery.
NOTE: This method appends the values to the existing list (if any). Use
setServiceRegistries(java.util.Collection)
or withServiceRegistries(java.util.Collection)
if
you want to override the existing values.
serviceRegistries
- The details of the service discovery registries to assign to this service. For more information, see Service
Discovery.public Service withServiceRegistries(Collection<ServiceRegistry> serviceRegistries)
The details of the service discovery registries to assign to this service. For more information, see Service Discovery.
serviceRegistries
- The details of the service discovery registries to assign to this service. For more information, see Service
Discovery.public void setStatus(String status)
The status of the service. The valid values are ACTIVE
, DRAINING
, or
INACTIVE
.
status
- The status of the service. The valid values are ACTIVE
, DRAINING
, or
INACTIVE
.public String getStatus()
The status of the service. The valid values are ACTIVE
, DRAINING
, or
INACTIVE
.
ACTIVE
, DRAINING
, or
INACTIVE
.public Service withStatus(String status)
The status of the service. The valid values are ACTIVE
, DRAINING
, or
INACTIVE
.
status
- The status of the service. The valid values are ACTIVE
, DRAINING
, or
INACTIVE
.public void setDesiredCount(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.
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 Integer getDesiredCount()
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 Service withDesiredCount(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.
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 void setRunningCount(Integer runningCount)
The number of tasks in the cluster that are in the RUNNING
state.
runningCount
- The number of tasks in the cluster that are in the RUNNING
state.public Integer getRunningCount()
The number of tasks in the cluster that are in the RUNNING
state.
RUNNING
state.public Service withRunningCount(Integer runningCount)
The number of tasks in the cluster that are in the RUNNING
state.
runningCount
- The number of tasks in the cluster that are in the RUNNING
state.public void setPendingCount(Integer pendingCount)
The number of tasks in the cluster that are in the PENDING
state.
pendingCount
- The number of tasks in the cluster that are in the PENDING
state.public Integer getPendingCount()
The number of tasks in the cluster that are in the PENDING
state.
PENDING
state.public Service withPendingCount(Integer pendingCount)
The number of tasks in the cluster that are in the PENDING
state.
pendingCount
- The number of tasks in the cluster that are in the PENDING
state.public void setLaunchType(String 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.
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.LaunchType
public String getLaunchType()
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.
EC2
. Valid values include EC2
and FARGATE
. For more information,
see Amazon ECS
Launch Types in the Amazon Elastic Container Service Developer Guide.LaunchType
public Service withLaunchType(String 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.
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.LaunchType
public Service withLaunchType(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.
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.LaunchType
public List<CapacityProviderStrategyItem> getCapacityProviderStrategy()
The capacity provider strategy associated with the service.
public void setCapacityProviderStrategy(Collection<CapacityProviderStrategyItem> capacityProviderStrategy)
The capacity provider strategy associated with the service.
capacityProviderStrategy
- The capacity provider strategy associated with the service.public Service withCapacityProviderStrategy(CapacityProviderStrategyItem... capacityProviderStrategy)
The capacity provider strategy associated with the service.
NOTE: This method appends the values to the existing list (if any). Use
setCapacityProviderStrategy(java.util.Collection)
or
withCapacityProviderStrategy(java.util.Collection)
if you want to override the existing values.
capacityProviderStrategy
- The capacity provider strategy associated with the service.public Service withCapacityProviderStrategy(Collection<CapacityProviderStrategyItem> capacityProviderStrategy)
The capacity provider strategy associated with the service.
capacityProviderStrategy
- The capacity provider strategy associated with the service.public void setPlatformVersion(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.
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.public String getPlatformVersion()
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 Service withPlatformVersion(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.
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.public void setTaskDefinition(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.
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 String getTaskDefinition()
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 Service withTaskDefinition(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.
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 void setDeploymentConfiguration(DeploymentConfiguration deploymentConfiguration)
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
deploymentConfiguration
- Optional deployment parameters that control how many tasks run during the deployment and the ordering of
stopping and starting tasks.public DeploymentConfiguration getDeploymentConfiguration()
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
public Service withDeploymentConfiguration(DeploymentConfiguration deploymentConfiguration)
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
deploymentConfiguration
- Optional deployment parameters that control how many tasks run during the deployment and the ordering of
stopping and starting tasks.public List<TaskSet> getTaskSets()
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.
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 void setTaskSets(Collection<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.
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.public Service withTaskSets(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.
NOTE: This method appends the values to the existing list (if any). Use
setTaskSets(java.util.Collection)
or withTaskSets(java.util.Collection)
if you want to override
the existing values.
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.public Service withTaskSets(Collection<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.
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.public List<Deployment> getDeployments()
The current state of deployments for the service.
public void setDeployments(Collection<Deployment> deployments)
The current state of deployments for the service.
deployments
- The current state of deployments for the service.public Service withDeployments(Deployment... deployments)
The current state of deployments for the service.
NOTE: This method appends the values to the existing list (if any). Use
setDeployments(java.util.Collection)
or withDeployments(java.util.Collection)
if you want to
override the existing values.
deployments
- The current state of deployments for the service.public Service withDeployments(Collection<Deployment> deployments)
The current state of deployments for the service.
deployments
- The current state of deployments for the service.public void setRoleArn(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.
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 String getRoleArn()
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 Service withRoleArn(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.
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 List<ServiceEvent> getEvents()
The event stream for your service. A maximum of 100 of the latest events are displayed.
public void setEvents(Collection<ServiceEvent> events)
The event stream for your service. A maximum of 100 of the latest events are displayed.
events
- The event stream for your service. A maximum of 100 of the latest events are displayed.public Service withEvents(ServiceEvent... events)
The event stream for your service. A maximum of 100 of the latest events are displayed.
NOTE: This method appends the values to the existing list (if any). Use
setEvents(java.util.Collection)
or withEvents(java.util.Collection)
if you want to override the
existing values.
events
- The event stream for your service. A maximum of 100 of the latest events are displayed.public Service withEvents(Collection<ServiceEvent> events)
The event stream for your service. A maximum of 100 of the latest events are displayed.
events
- The event stream for your service. A maximum of 100 of the latest events are displayed.public void setCreatedAt(Date createdAt)
The Unix timestamp for when the service was created.
createdAt
- The Unix timestamp for when the service was created.public Date getCreatedAt()
The Unix timestamp for when the service was created.
public Service withCreatedAt(Date createdAt)
The Unix timestamp for when the service was created.
createdAt
- The Unix timestamp for when the service was created.public List<PlacementConstraint> getPlacementConstraints()
The placement constraints for the tasks in the service.
public void setPlacementConstraints(Collection<PlacementConstraint> placementConstraints)
The placement constraints for the tasks in the service.
placementConstraints
- The placement constraints for the tasks in the service.public Service withPlacementConstraints(PlacementConstraint... placementConstraints)
The placement constraints for the tasks in the service.
NOTE: This method appends the values to the existing list (if any). Use
setPlacementConstraints(java.util.Collection)
or withPlacementConstraints(java.util.Collection)
if you want to override the existing values.
placementConstraints
- The placement constraints for the tasks in the service.public Service withPlacementConstraints(Collection<PlacementConstraint> placementConstraints)
The placement constraints for the tasks in the service.
placementConstraints
- The placement constraints for the tasks in the service.public List<PlacementStrategy> getPlacementStrategy()
The placement strategy that determines how tasks for the service are placed.
public void setPlacementStrategy(Collection<PlacementStrategy> placementStrategy)
The placement strategy that determines how tasks for the service are placed.
placementStrategy
- The placement strategy that determines how tasks for the service are placed.public Service withPlacementStrategy(PlacementStrategy... placementStrategy)
The placement strategy that determines how tasks for the service are placed.
NOTE: This method appends the values to the existing list (if any). Use
setPlacementStrategy(java.util.Collection)
or withPlacementStrategy(java.util.Collection)
if
you want to override the existing values.
placementStrategy
- The placement strategy that determines how tasks for the service are placed.public Service withPlacementStrategy(Collection<PlacementStrategy> placementStrategy)
The placement strategy that determines how tasks for the service are placed.
placementStrategy
- The placement strategy that determines how tasks for the service are placed.public void setNetworkConfiguration(NetworkConfiguration networkConfiguration)
The VPC subnet and security group configuration for tasks that receive their own elastic network interface by
using the awsvpc
networking mode.
networkConfiguration
- The VPC subnet and security group configuration for tasks that receive their own elastic network interface
by using the awsvpc
networking mode.public NetworkConfiguration getNetworkConfiguration()
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 Service withNetworkConfiguration(NetworkConfiguration networkConfiguration)
The VPC subnet and security group configuration for tasks that receive their own elastic network interface by
using the awsvpc
networking mode.
networkConfiguration
- The VPC subnet and security group configuration for tasks that receive their own elastic network interface
by using the awsvpc
networking mode.public void setHealthCheckGracePeriodSeconds(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.
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 Integer getHealthCheckGracePeriodSeconds()
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 Service withHealthCheckGracePeriodSeconds(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.
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 void setSchedulingStrategy(String 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.
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.
SchedulingStrategy
public String getSchedulingStrategy()
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.
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.
SchedulingStrategy
public Service withSchedulingStrategy(String 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.
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.
SchedulingStrategy
public Service withSchedulingStrategy(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.
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.
SchedulingStrategy
public void setDeploymentController(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.
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.public DeploymentController getDeploymentController()
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 Service withDeploymentController(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.
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.public List<Tag> getTags()
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.
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 void setTags(Collection<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.
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.
public Service withTags(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.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
or withTags(java.util.Collection)
if you want to override the
existing values.
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.
public Service withTags(Collection<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.
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.
public void setCreatedBy(String createdBy)
The principal that created the service.
createdBy
- The principal that created the service.public String getCreatedBy()
The principal that created the service.
public Service withCreatedBy(String createdBy)
The principal that created the service.
createdBy
- The principal that created the service.public void setEnableECSManagedTags(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.
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 Boolean getEnableECSManagedTags()
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 Service withEnableECSManagedTags(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.
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 Boolean isEnableECSManagedTags()
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 void setPropagateTags(String 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.
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.PropagateTags
public String getPropagateTags()
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.
PropagateTags
public Service withPropagateTags(String 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.
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.PropagateTags
public Service withPropagateTags(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.
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.PropagateTags
public String toString()
toString
in class Object
Object.toString()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.