@Generated(value="software.amazon.awssdk:codegen") public class Cluster extends Object implements StructuredPojo, ToCopyableBuilder<Cluster.Builder,Cluster>
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.
Modifier and Type | Class and Description |
---|---|
static interface |
Cluster.Builder |
Modifier and Type | Method and Description |
---|---|
Integer |
activeServicesCount()
The number of services that are running on the cluster in an
ACTIVE state. |
static Cluster.Builder |
builder() |
String |
clusterArn()
The Amazon Resource Name (ARN) that identifies the cluster.
|
String |
clusterName()
A user-generated string that you use to identify your cluster.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
Integer |
pendingTasksCount()
The number of tasks in the cluster that are in the
PENDING state. |
Integer |
registeredContainerInstancesCount()
The number of container instances registered into the cluster.
|
Integer |
runningTasksCount()
The number of tasks in the cluster that are in the
RUNNING state. |
static Class<? extends Cluster.Builder> |
serializableBuilderClass() |
String |
status()
The status of the cluster.
|
Cluster.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
copy
public 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
..
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
..public String clusterName()
A user-generated string that you use to identify your cluster.
public 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.
ACTIVE
or INACTIVE
.
ACTIVE
indicates that you can register container instances with the cluster and the
associated instances can accept tasks.public Integer registeredContainerInstancesCount()
The number of container instances registered into the cluster.
public Integer runningTasksCount()
The number of tasks in the cluster that are in the RUNNING
state.
RUNNING
state.public Integer pendingTasksCount()
The number of tasks in the cluster that are in the PENDING
state.
PENDING
state.public Integer activeServicesCount()
The number of services that are running on the cluster in an ACTIVE
state. You can view these
services with ListServices.
ACTIVE
state. You can view
these services with ListServices.public Cluster.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<Cluster.Builder,Cluster>
public static Cluster.Builder builder()
public static Class<? extends Cluster.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.