@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.
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. |
List<Attachment> |
attachments()
The resources attached to a cluster.
|
String |
attachmentsStatus()
The status of the capacity providers associated with the cluster.
|
static Cluster.Builder |
builder() |
List<String> |
capacityProviders()
The capacity providers associated with the cluster.
|
String |
clusterArn()
The Amazon Resource Name (ARN) that identifies the cluster.
|
String |
clusterName()
A user-generated string that you use to identify your cluster.
|
List<CapacityProviderStrategyItem> |
defaultCapacityProviderStrategy()
The default capacity provider strategy for the cluster.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasAttachments()
Returns true if the Attachments property was specified by the sender (it may be empty), or false if the sender
did not specify the value (it will be empty).
|
boolean |
hasCapacityProviders()
Returns true if the CapacityProviders property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
boolean |
hasDefaultCapacityProviderStrategy()
Returns true if the DefaultCapacityProviderStrategy property was specified by the sender (it may be empty), or
false if the sender did not specify the value (it will be empty).
|
int |
hashCode() |
boolean |
hasSettings()
Returns true if the Settings property was specified by the sender (it may be empty), or false if the sender did
not specify the value (it will be empty).
|
boolean |
hasStatistics()
Returns true if the Statistics property was specified by the sender (it may be empty), or false if the sender did
not specify the value (it will be empty).
|
boolean |
hasTags()
Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not
specify the value (it will be empty).
|
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()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
copy
public final 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 final String clusterName()
A user-generated string that you use to identify your cluster.
public final String status()
The status of the cluster. The following are the possible states that will be returned.
The cluster is ready to accept tasks and if applicable you can register container instances with the cluster.
The cluster has capacity providers associated with it and the resources needed for the capacity provider are being created.
The cluster has capacity providers associated with it and the resources needed for the capacity provider are being deleted.
The cluster has capacity providers associated with it and the resources needed for the capacity provider have failed to create.
The cluster has been deleted. Clusters with an INACTIVE
status may remain discoverable in your
account for a period of time. However, this behavior is subject to change in the future, so you should not rely
on INACTIVE
clusters persisting.
The cluster is ready to accept tasks and if applicable you can register container instances with the cluster.
The cluster has capacity providers associated with it and the resources needed for the capacity provider are being created.
The cluster has capacity providers associated with it and the resources needed for the capacity provider are being deleted.
The cluster has capacity providers associated with it and the resources needed for the capacity provider have failed to create.
The cluster has been deleted. Clusters with an INACTIVE
status may remain discoverable in
your account for a period of time. However, this behavior is subject to change in the future, so you
should not rely on INACTIVE
clusters persisting.
public final Integer registeredContainerInstancesCount()
The number of container instances registered into the cluster. This includes container instances in both
ACTIVE
and DRAINING
status.
ACTIVE
and DRAINING
status.public final Integer runningTasksCount()
The number of tasks in the cluster that are in the RUNNING
state.
RUNNING
state.public final Integer pendingTasksCount()
The number of tasks in the cluster that are in the PENDING
state.
PENDING
state.public final 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 final boolean hasStatistics()
public final 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.
You can use hasStatistics()
to see if a value was sent in this field.
runningEC2TasksCount
RunningFargateTasksCount
pendingEC2TasksCount
pendingFargateTasksCount
activeEC2ServiceCount
activeFargateServiceCount
drainingEC2ServiceCount
drainingFargateServiceCount
public final boolean hasTags()
public final 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.
You can use hasTags()
to see if a value was sent in this field.
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.
public final boolean hasSettings()
public final 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.
You can use hasSettings()
to see if a value was sent in this field.
public final boolean hasCapacityProviders()
public final List<String> capacityProviders()
The capacity providers associated with the cluster.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasCapacityProviders()
to see if a value was sent in this field.
public final boolean hasDefaultCapacityProviderStrategy()
public final List<CapacityProviderStrategyItem> defaultCapacityProviderStrategy()
The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasDefaultCapacityProviderStrategy()
to see if a value was sent in this field.
public final boolean hasAttachments()
public final List<Attachment> attachments()
The resources attached to a cluster. When using a capacity provider with a cluster, the Auto Scaling plan that is created will be returned as a cluster attachment.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasAttachments()
to see if a value was sent in this field.
public final String attachmentsStatus()
The status of the capacity providers associated with the cluster. The following are the states that will be returned:
The available capacity providers for the cluster are updating. This occurs when the Auto Scaling plan is provisioning or deprovisioning.
The capacity providers have successfully updated.
The capacity provider updates failed.
The available capacity providers for the cluster are updating. This occurs when the Auto Scaling plan is provisioning or deprovisioning.
The capacity providers have successfully updated.
The capacity provider updates failed.
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 final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.