Cluster (AWS Java SDK :: Services :: Amazon EC2 Container Service 2.7.36 API)

java.lang.Object
- software.amazon.awssdk.services.ecs.model.Cluster

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Cluster.Builder,Cluster>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class Cluster
extends Object
implements SdkPojo, Serializable, 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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Cluster.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Cluster.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`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.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Cluster.Builder>`	`serializableBuilderClass()`
`List<ClusterSetting>`	`settings()` The settings for the cluster.
`List<KeyValuePair>`	`statistics()` Additional information about your clusters that are separated by launch type, including:
`String`	`status()` The status of the cluster.
`List<Tag>`	`tags()` The metadata that you apply to the cluster to help you categorize and organize them.
`Cluster.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - clusterArn
```
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.
    
    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.
  - clusterName
```
public String clusterName()
```
    A user-generated string that you use to identify your cluster.
    
    Returns:
    
    A user-generated string that you use to identify your cluster.
  - status
```
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.
    
    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.
  - registeredContainerInstancesCount
```
public Integer registeredContainerInstancesCount()
```
    The number of container instances registered into the cluster. This includes container instances in both ACTIVE and DRAINING status.
    
    Returns:
    
    The number of container instances registered into the cluster. This includes container instances in both ACTIVE and DRAINING status.
  - runningTasksCount
```
public Integer runningTasksCount()
```
    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.
  - pendingTasksCount
```
public Integer pendingTasksCount()
```
    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.
  - activeServicesCount
```
public Integer activeServicesCount()
```
    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.
  - statistics
```
public List<KeyValuePair> statistics()
```
    Additional information about your clusters that are separated by launch type, including:
    - runningEC2TasksCount
    - RunningFargateTasksCount
    - pendingEC2TasksCount
    - pendingFargateTasksCount
    - activeEC2ServiceCount
    - activeFargateServiceCount
    - drainingEC2ServiceCount
    - drainingFargateServiceCount
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    Returns:
    Additional information about your clusters that are separated by launch type, including:
    
    runningEC2TasksCount
    
    RunningFargateTasksCount
    
    pendingEC2TasksCount
    
    pendingFargateTasksCount
    
    activeEC2ServiceCount
    
    activeFargateServiceCount
    
    drainingEC2ServiceCount
    
    drainingFargateServiceCount
  - tags
```
public List<Tag> tags()
```
    The metadata that you apply to the cluster 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.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    Returns:
    The metadata that you apply to the cluster 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.
  - settings
```
public List<ClusterSetting> settings()
```
    The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is enabled or disabled for a cluster.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is enabled or disabled for a cluster.
  - toBuilder
```
public Cluster.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Cluster.Builder,Cluster>
  - builder
```
public static Cluster.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Cluster.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class Cluster

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

clusterArn

clusterName

status

registeredContainerInstancesCount

runningTasksCount

pendingTasksCount

activeServicesCount

statistics

tags

settings

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields