com.amazonaws.services.ecs.model

Class Cluster

java.lang.Object

com.amazonaws.services.ecs.model.Cluster

All Implemented Interfaces:

Serializable, Cloneable

public class Cluster
extends Object
implements Serializable, Cloneable

A regional grouping of one or more container instances on which you can run task requests. Each account receives a default cluster the first time you use the Amazon ECS service, but you may also create other clusters. Clusters may contain more than one instance type simultaneously.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Cluster()

Method Summary

Methods

Modifier and Type	Method and Description
Cluster	clone()
boolean	equals(Object obj)
Integer	getActiveServicesCount() The number of services that are running on the cluster in an ACTIVE state.
String	getClusterArn() The Amazon Resource Name (ARN) that identifies the cluster.
String	getClusterName() A user-generated string that you can use to identify your cluster.
Integer	getPendingTasksCount() The number of tasks in the cluster that are in the PENDING state.
Integer	getRegisteredContainerInstancesCount() The number of container instances registered into the cluster.
Integer	getRunningTasksCount() The number of tasks in the cluster that are in the RUNNING state.
String	getStatus() The status of the cluster.
int	hashCode()
void	setActiveServicesCount(Integer activeServicesCount) The number of services that are running on the cluster in an ACTIVE state.
void	setClusterArn(String clusterArn) The Amazon Resource Name (ARN) that identifies the cluster.
void	setClusterName(String clusterName) A user-generated string that you can use to identify your cluster.
void	setPendingTasksCount(Integer pendingTasksCount) The number of tasks in the cluster that are in the PENDING state.
void	setRegisteredContainerInstancesCount(Integer registeredContainerInstancesCount) The number of container instances registered into the cluster.
void	setRunningTasksCount(Integer runningTasksCount) The number of tasks in the cluster that are in the RUNNING state.
void	setStatus(String status) The status of the cluster.
String	toString() Returns a string representation of this object; useful for testing and debugging.
Cluster	withActiveServicesCount(Integer activeServicesCount) The number of services that are running on the cluster in an ACTIVE state.
Cluster	withClusterArn(String clusterArn) The Amazon Resource Name (ARN) that identifies the cluster.
Cluster	withClusterName(String clusterName) A user-generated string that you can use to identify your cluster.
Cluster	withPendingTasksCount(Integer pendingTasksCount) The number of tasks in the cluster that are in the PENDING state.
Cluster	withRegisteredContainerInstancesCount(Integer registeredContainerInstancesCount) The number of container instances registered into the cluster.
Cluster	withRunningTasksCount(Integer runningTasksCount) The number of tasks in the cluster that are in the RUNNING state.
Cluster	withStatus(String status) The status of the cluster.

Methods inherited from class java.lang.Object

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

Constructor Detail

Cluster

public Cluster()

Method Detail

getClusterArn

public String getClusterArn()

The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the arn:aws:ecs namespace, followed by the region of the cluster, the AWS account ID of the cluster owner, the cluster namespace, and then the cluster name. For example, arn:aws:ecs:region:012345678910:cluster/test.

Returns:

The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the arn:aws:ecs namespace, followed by the region of the cluster, the AWS account ID of the cluster owner, the cluster namespace, and then the cluster name. For example, arn:aws:ecs:region:012345678910:cluster/test.

setClusterArn

public void setClusterArn(String clusterArn)

The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the arn:aws:ecs namespace, followed by the region of the cluster, the AWS account ID of the cluster owner, the cluster namespace, and then the cluster name. For example, arn:aws:ecs:region:012345678910:cluster/test.

Parameters:

clusterArn - The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the arn:aws:ecs namespace, followed by the region of the cluster, the AWS account ID of the cluster owner, the cluster namespace, and then the cluster name. For example, arn:aws:ecs:region:012345678910:cluster/test.

withClusterArn

public Cluster withClusterArn(String clusterArn)

The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the arn:aws:ecs namespace, followed by the region of the cluster, the AWS account ID of the cluster owner, the cluster namespace, and then the cluster name. For example, arn:aws:ecs:region:012345678910:cluster/test.

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

Parameters:

clusterArn - The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the arn:aws:ecs namespace, followed by the region of the cluster, the AWS account ID of the cluster owner, the cluster namespace, and then the cluster name. For example, arn:aws:ecs:region:012345678910:cluster/test.

Returns:

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

getClusterName

public String getClusterName()

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

Returns:

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

setClusterName

public void setClusterName(String clusterName)

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

Parameters:

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

withClusterName

public Cluster withClusterName(String clusterName)

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

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

Parameters:

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

Returns:

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

getStatus

public String getStatus()

The status of the cluster. The valid values are ACTIVE or INACTIVE. ACTIVE indicates that you can register container instances with the cluster and the associated instances can accept tasks.

Returns:

The status of the cluster. The valid values are ACTIVE or INACTIVE. ACTIVE indicates that you can register container instances with the cluster and the associated instances can accept tasks.

setStatus

public void setStatus(String status)

The status of the cluster. The valid values are ACTIVE or INACTIVE. ACTIVE indicates that you can register container instances with the cluster and the associated instances can accept tasks.

Parameters:

status - The status of the cluster. The valid values are ACTIVE or INACTIVE. ACTIVE indicates that you can register container instances with the cluster and the associated instances can accept tasks.

withStatus

public Cluster withStatus(String status)

The status of the cluster. The valid values are ACTIVE or INACTIVE. ACTIVE indicates that you can register container instances with the cluster and the associated instances can accept tasks.

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

Parameters:

status - The status of the cluster. The valid values are ACTIVE or INACTIVE. ACTIVE indicates that you can register container instances with the cluster and the associated instances can accept tasks.

Returns:

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

getRegisteredContainerInstancesCount

public Integer getRegisteredContainerInstancesCount()

The number of container instances registered into the cluster.

Returns:

The number of container instances registered into the cluster.

setRegisteredContainerInstancesCount

public void setRegisteredContainerInstancesCount(Integer registeredContainerInstancesCount)

The number of container instances registered into the cluster.

Parameters:

registeredContainerInstancesCount - The number of container instances registered into the cluster.

withRegisteredContainerInstancesCount

public Cluster withRegisteredContainerInstancesCount(Integer registeredContainerInstancesCount)

The number of container instances registered into the cluster.

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

Parameters:

registeredContainerInstancesCount - The number of container instances registered into the cluster.

Returns:

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

getRunningTasksCount

public Integer getRunningTasksCount()

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.

setRunningTasksCount

public void setRunningTasksCount(Integer runningTasksCount)

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

Parameters:

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

withRunningTasksCount

public Cluster withRunningTasksCount(Integer runningTasksCount)

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:

runningTasksCount - 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.

getPendingTasksCount

public Integer getPendingTasksCount()

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.

setPendingTasksCount

public void setPendingTasksCount(Integer pendingTasksCount)

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

Parameters:

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

withPendingTasksCount

public Cluster withPendingTasksCount(Integer pendingTasksCount)

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:

pendingTasksCount - 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.

getActiveServicesCount

public Integer getActiveServicesCount()

The number of services that are running on the cluster in an ACTIVE state. You can view these services with ListServices.

Returns:

The number of services that are running on the cluster in an ACTIVE state. You can view these services with ListServices.

setActiveServicesCount

public void setActiveServicesCount(Integer activeServicesCount)

The number of services that are running on the cluster in an ACTIVE state. You can view these services with ListServices.

Parameters:

activeServicesCount - The number of services that are running on the cluster in an ACTIVE state. You can view these services with ListServices.

withActiveServicesCount

public Cluster withActiveServicesCount(Integer activeServicesCount)

The number of services that are running on the cluster in an ACTIVE state. You can view these services with ListServices.

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

Parameters:

activeServicesCount - The number of services that are running on the cluster in an ACTIVE state. You can view these services with ListServices.

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

Overrides:

clone in class Object