com.amazonaws.services.ecs.model

Class Service

java.lang.Object

com.amazonaws.services.ecs.model.Service

All Implemented Interfaces:

Serializable, Cloneable

public class Service
extends Object
implements Serializable, Cloneable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Service()

Method Summary

Methods

Modifier and Type	Method and Description
Service	clone()
boolean	equals(Object obj)
String	getClusterArn() The Amazon Resource Name (ARN) of the of the cluster that hosts the service.
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.
List<ServiceEvent>	getEvents() The event stream for your service.
List<LoadBalancer>	getLoadBalancers() A list of 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.
Integer	getPendingCount() The number of tasks in the cluster that are in the PENDING state.
String	getRoleArn() The Amazon Resource Name (ARN) of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with a load balancer.
Integer	getRunningCount() The number of tasks in the cluster that are in the RUNNING state.
String	getServiceArn() The Amazon Resource Name (ARN) that identifies the service.
String	getServiceName() A user-generated string that you can use to identify your service.
String	getStatus() The status of the service.
String	getTaskDefinition() The task definition to use for tasks in the service.
int	hashCode()
void	setClusterArn(String clusterArn) The Amazon Resource Name (ARN) of the of the cluster that hosts the service.
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	setEvents(Collection<ServiceEvent> events) The event stream for your service.
void	setLoadBalancers(Collection<LoadBalancer> loadBalancers) A list of 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	setPendingCount(Integer pendingCount) The number of tasks in the cluster that are in the PENDING state.
void	setRoleArn(String roleArn) The Amazon Resource Name (ARN) of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with a load balancer.
void	setRunningCount(Integer runningCount) The number of tasks in the cluster that are in the RUNNING state.
void	setServiceArn(String serviceArn) The Amazon Resource Name (ARN) that identifies the service.
void	setServiceName(String serviceName) A user-generated string that you can use to identify your service.
void	setStatus(String status) The status of the service.
void	setTaskDefinition(String taskDefinition) The task definition to use for tasks in the service.
String	toString() Returns a string representation of this object; useful for testing and debugging.
Service	withClusterArn(String clusterArn) The Amazon Resource Name (ARN) of the of the cluster that hosts the service.
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	withEvents(Collection<ServiceEvent> events) The event stream for your service.
Service	withEvents(ServiceEvent... events) The event stream for your service.
Service	withLoadBalancers(Collection<LoadBalancer> loadBalancers) A list of 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 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	withPendingCount(Integer pendingCount) The number of tasks in the cluster that are in the PENDING state.
Service	withRoleArn(String roleArn) The Amazon Resource Name (ARN) of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with a load balancer.
Service	withRunningCount(Integer runningCount) The number of tasks in the cluster that are in the RUNNING state.
Service	withServiceArn(String serviceArn) The Amazon Resource Name (ARN) that identifies the service.
Service	withServiceName(String serviceName) A user-generated string that you can use to identify your service.
Service	withStatus(String status) The status of the service.
Service	withTaskDefinition(String taskDefinition) The task definition to use for tasks in the service.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Service

public Service()

Method Detail

getServiceArn

public String getServiceArn()

The Amazon Resource Name (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 Amazon Resource Name (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.

setServiceArn

public void setServiceArn(String serviceArn)

The Amazon Resource Name (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.

Parameters:

serviceArn - The Amazon Resource Name (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.

withServiceArn

public Service withServiceArn(String serviceArn)

The Amazon Resource Name (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 a reference to this object so that method calls can be chained together.

Parameters:

serviceArn - The Amazon Resource Name (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:

A reference to this updated object so that method calls can be chained together.

getServiceName

public String getServiceName()

A user-generated string that you can use to identify your service.

Returns:

A user-generated string that you can use to identify your service.

setServiceName

public void setServiceName(String serviceName)

A user-generated string that you can use to identify your service.

Parameters:

serviceName - A user-generated string that you can use to identify your service.

withServiceName

public Service withServiceName(String serviceName)

A user-generated string that you can use to identify your service.

Returns a reference to this object so that method calls can be chained together.

Parameters:

serviceName - A user-generated string that you can use to identify your service.

Returns:

A reference to this updated object so that method calls can be chained together.

getClusterArn

public String getClusterArn()

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

Returns:

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

setClusterArn

public void setClusterArn(String clusterArn)

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

Parameters:

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

withClusterArn

public Service withClusterArn(String clusterArn)

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getLoadBalancers

public List<LoadBalancer> getLoadBalancers()

A list of 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.

Returns:

A list of 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.

setLoadBalancers

public void setLoadBalancers(Collection<LoadBalancer> loadBalancers)

A list of 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.

Parameters:

loadBalancers - A list of 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.

withLoadBalancers

public Service withLoadBalancers(LoadBalancer... loadBalancers)

A list of 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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

loadBalancers - A list of 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.

Returns:

A reference to this updated object so that method calls can be chained together.

withLoadBalancers

public Service withLoadBalancers(Collection<LoadBalancer> loadBalancers)

A list of 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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

loadBalancers - A list of 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.

Returns:

A reference to this updated object so that method calls can be chained together.

getStatus

public String getStatus()

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.

setStatus

public void setStatus(String status)

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

Parameters:

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

withStatus

public Service withStatus(String status)

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getDesiredCount

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.

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.

setDesiredCount

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.

Parameters:

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.

withDesiredCount

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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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:

A reference to this updated object so that method calls can be chained together.

getRunningCount

public Integer getRunningCount()

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.

setRunningCount

public void setRunningCount(Integer runningCount)

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

Parameters:

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

withRunningCount

public Service withRunningCount(Integer runningCount)

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getPendingCount

public Integer getPendingCount()

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.

setPendingCount

public void setPendingCount(Integer pendingCount)

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

Parameters:

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

withPendingCount

public Service withPendingCount(Integer pendingCount)

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getTaskDefinition

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.

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.

setTaskDefinition

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.

Parameters:

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.

withTaskDefinition

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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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:

A reference to this updated object so that method calls can be chained together.

getDeployments

public List<Deployment> getDeployments()

The current state of deployments for the service.

Returns:

The current state of deployments for the service.

setDeployments

public void setDeployments(Collection<Deployment> deployments)

The current state of deployments for the service.

Parameters:

deployments - The current state of deployments for the service.

withDeployments

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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

deployments - The current state of deployments for the service.

Returns:

A reference to this updated object so that method calls can be chained together.

withDeployments

public Service withDeployments(Collection<Deployment> deployments)

The current state of deployments for the service.

Returns a reference to this object so that method calls can be chained together.

Parameters:

deployments - The current state of deployments for the service.

Returns:

A reference to this updated object so that method calls can be chained together.

getRoleArn

public String getRoleArn()

The Amazon Resource Name (ARN) of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with a load balancer.

Returns:

The Amazon Resource Name (ARN) of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with a load balancer.

setRoleArn

public void setRoleArn(String roleArn)

The Amazon Resource Name (ARN) of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with a load balancer.

Parameters:

roleArn - The Amazon Resource Name (ARN) of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with a load balancer.

withRoleArn

public Service withRoleArn(String roleArn)

The Amazon Resource Name (ARN) of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with a load balancer.

Returns a reference to this object so that method calls can be chained together.

Parameters:

roleArn - The Amazon Resource Name (ARN) of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with a load balancer.

Returns:

A reference to this updated object so that method calls can be chained together.

getEvents

public List<ServiceEvent> getEvents()

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

Returns:

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

setEvents

public void setEvents(Collection<ServiceEvent> events)

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

Parameters:

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

withEvents

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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

withEvents

public Service withEvents(Collection<ServiceEvent> events)

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public Service clone()

Overrides:

clone in class Object