com.amazonaws.services.ecs.model

Class UpdateServiceRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ecs.model.UpdateServiceRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class UpdateServiceRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the UpdateService operation.

Modify the desired count or task definition used in a service.

You can add to or subtract from the number of instantiations of a task definition in a service by specifying the cluster that the service is running in and a new desiredCount parameter.

You can use UpdateService to modify your task definition and deploy a new version of your service, one task at a time. If you modify the task definition with UpdateService , Amazon ECS spawns a task with the new version of the task definition and then stops an old task after the new version is running. Because UpdateService starts a new version of the task before stopping an old version, your cluster must have capacity to support one more instantiation of the task when UpdateService is run. If your cluster cannot support another instantiation of the task used in your service, you can reduce the desired count of your service by one before modifying the task definition.

See Also:

AmazonECS.updateService(UpdateServiceRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateServiceRequest()

Method Summary

Methods

Modifier and Type	Method and Description
UpdateServiceRequest	clone()
boolean	equals(Object obj)
String	getCluster() The short name or full Amazon Resource Name (ARN) of the cluster that your service is running on.
Integer	getDesiredCount() The number of instantiations of the task that you would like to place and keep running in your service.
String	getService() The name of the service that you want to update.
String	getTaskDefinition() The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition that you want to run in your service.
int	hashCode()
void	setCluster(String cluster) The short name or full Amazon Resource Name (ARN) of the cluster that your service is running on.
void	setDesiredCount(Integer desiredCount) The number of instantiations of the task that you would like to place and keep running in your service.
void	setService(String service) The name of the service that you want to update.
void	setTaskDefinition(String taskDefinition) The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition that you want to run in your service.
String	toString() Returns a string representation of this object; useful for testing and debugging.
UpdateServiceRequest	withCluster(String cluster) The short name or full Amazon Resource Name (ARN) of the cluster that your service is running on.
UpdateServiceRequest	withDesiredCount(Integer desiredCount) The number of instantiations of the task that you would like to place and keep running in your service.
UpdateServiceRequest	withService(String service) The name of the service that you want to update.
UpdateServiceRequest	withTaskDefinition(String taskDefinition) The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition that you want to run in your service.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

UpdateServiceRequest

public UpdateServiceRequest()

Method Detail

getCluster

public String getCluster()

The short name or full Amazon Resource Name (ARN) of the cluster that your service is running on. If you do not specify a cluster, the default cluster is assumed.

Returns:

The short name or full Amazon Resource Name (ARN) of the cluster that your service is running on. If you do not specify a cluster, the default cluster is assumed.

setCluster

public void setCluster(String cluster)

The short name or full Amazon Resource Name (ARN) of the cluster that your service is running on. If you do not specify a cluster, the default cluster is assumed.

Parameters:

cluster - The short name or full Amazon Resource Name (ARN) of the cluster that your service is running on. If you do not specify a cluster, the default cluster is assumed.

withCluster

public UpdateServiceRequest withCluster(String cluster)

The short name or full Amazon Resource Name (ARN) of the cluster that your service is running on. If you do not specify a cluster, the default cluster is assumed.

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

Parameters:

cluster - The short name or full Amazon Resource Name (ARN) of the cluster that your service is running on. If you do not specify a cluster, the default cluster is assumed.

Returns:

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

getService

public String getService()

The name of the service that you want to update.

Returns:

The name of the service that you want to update.

setService

public void setService(String service)

The name of the service that you want to update.

Parameters:

service - The name of the service that you want to update.

withService

public UpdateServiceRequest withService(String service)

The name of the service that you want to update.

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

Parameters:

service - The name of the service that you want to update.

Returns:

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

getDesiredCount

public Integer getDesiredCount()

The number of instantiations of the task that you would like to place and keep running in your service.

Returns:

The number of instantiations of the task that you would like to place and keep running in your service.

setDesiredCount

public void setDesiredCount(Integer desiredCount)

The number of instantiations of the task that you would like to place and keep running in your service.

Parameters:

desiredCount - The number of instantiations of the task that you would like to place and keep running in your service.

withDesiredCount

public UpdateServiceRequest withDesiredCount(Integer desiredCount)

The number of instantiations of the task that you would like to place and keep running in your service.

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

Parameters:

desiredCount - The number of instantiations of the task that you would like to place and keep running in your service.

Returns:

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

getTaskDefinition

public String getTaskDefinition()

The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition that you want to run in your service. If a revision is not specified, the latest ACTIVE revision is used. If you modify the task definition with UpdateService, Amazon ECS spawns a task with the new version of the task definition and then stops an old task after the new version is running.

Returns:

The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition that you want to run in your service. If a revision is not specified, the latest ACTIVE revision is used. If you modify the task definition with UpdateService, Amazon ECS spawns a task with the new version of the task definition and then stops an old task after the new version is running.

setTaskDefinition

public void setTaskDefinition(String taskDefinition)

The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition that you want to run in your service. If a revision is not specified, the latest ACTIVE revision is used. If you modify the task definition with UpdateService, Amazon ECS spawns a task with the new version of the task definition and then stops an old task after the new version is running.

Parameters:

taskDefinition - The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition that you want to run in your service. If a revision is not specified, the latest ACTIVE revision is used. If you modify the task definition with UpdateService, Amazon ECS spawns a task with the new version of the task definition and then stops an old task after the new version is running.

withTaskDefinition

public UpdateServiceRequest withTaskDefinition(String taskDefinition)

The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition that you want to run in your service. If a revision is not specified, the latest ACTIVE revision is used. If you modify the task definition with UpdateService, Amazon ECS spawns a task with the new version of the task definition and then stops an old task after the new version is running.

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

Parameters:

taskDefinition - The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition that you want to run in your service. If a revision is not specified, the latest ACTIVE revision is used. If you modify the task definition with UpdateService, Amazon ECS spawns a task with the new version of the task definition and then stops an old task after the new version is running.

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 UpdateServiceRequest clone()

Overrides:

clone in class AmazonWebServiceRequest