Cluster (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.ecs.model.Cluster

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Cluster
extends Object
implements Serializable, Cloneable, StructuredPojo
```
A regional grouping of one or more container instances where 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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Cluster()

Constructors
Constructor and Description
`Cluster()`

Method Summary

All Methods Instance Methods Concrete 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.
`List<Attachment>`	`getAttachments()` The resources attached to a cluster.
`String`	`getAttachmentsStatus()` The status of the capacity providers associated with the cluster.
`List<String>`	`getCapacityProviders()` The capacity providers associated with the cluster.
`String`	`getClusterArn()` The Amazon Resource Name (ARN) that identifies the cluster.
`String`	`getClusterName()` A user-generated string that you use to identify your cluster.
`ClusterConfiguration`	`getConfiguration()` The execute command configuration for the cluster.
`List<CapacityProviderStrategyItem>`	`getDefaultCapacityProviderStrategy()` The default capacity provider strategy for the 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.
`List<ClusterSetting>`	`getSettings()` The settings for the cluster.
`List<KeyValuePair>`	`getStatistics()` Additional information about your clusters that are separated by launch type.
`String`	`getStatus()` The status of the cluster.
`List<Tag>`	`getTags()` The metadata that you apply to the cluster to help you categorize and organize them.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setActiveServicesCount(Integer activeServicesCount)` The number of services that are running on the cluster in an `ACTIVE` state.
`void`	`setAttachments(Collection<Attachment> attachments)` The resources attached to a cluster.
`void`	`setAttachmentsStatus(String attachmentsStatus)` The status of the capacity providers associated with the cluster.
`void`	`setCapacityProviders(Collection<String> capacityProviders)` The capacity providers associated with the cluster.
`void`	`setClusterArn(String clusterArn)` The Amazon Resource Name (ARN) that identifies the cluster.
`void`	`setClusterName(String clusterName)` A user-generated string that you use to identify your cluster.
`void`	`setConfiguration(ClusterConfiguration configuration)` The execute command configuration for the cluster.
`void`	`setDefaultCapacityProviderStrategy(Collection<CapacityProviderStrategyItem> defaultCapacityProviderStrategy)` The default capacity provider strategy for the 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`	`setSettings(Collection<ClusterSetting> settings)` The settings for the cluster.
`void`	`setStatistics(Collection<KeyValuePair> statistics)` Additional information about your clusters that are separated by launch type.
`void`	`setStatus(String status)` The status of the cluster.
`void`	`setTags(Collection<Tag> tags)` The metadata that you apply to the cluster to help you categorize and organize them.
`String`	`toString()` Returns a string representation of this object.
`Cluster`	`withActiveServicesCount(Integer activeServicesCount)` The number of services that are running on the cluster in an `ACTIVE` state.
`Cluster`	`withAttachments(Attachment... attachments)` The resources attached to a cluster.
`Cluster`	`withAttachments(Collection<Attachment> attachments)` The resources attached to a cluster.
`Cluster`	`withAttachmentsStatus(String attachmentsStatus)` The status of the capacity providers associated with the cluster.
`Cluster`	`withCapacityProviders(Collection<String> capacityProviders)` The capacity providers associated with the cluster.
`Cluster`	`withCapacityProviders(String... capacityProviders)` The capacity providers associated with the cluster.
`Cluster`	`withClusterArn(String clusterArn)` The Amazon Resource Name (ARN) that identifies the cluster.
`Cluster`	`withClusterName(String clusterName)` A user-generated string that you use to identify your cluster.
`Cluster`	`withConfiguration(ClusterConfiguration configuration)` The execute command configuration for the cluster.
`Cluster`	`withDefaultCapacityProviderStrategy(CapacityProviderStrategyItem... defaultCapacityProviderStrategy)` The default capacity provider strategy for the cluster.
`Cluster`	`withDefaultCapacityProviderStrategy(Collection<CapacityProviderStrategyItem> defaultCapacityProviderStrategy)` The default capacity provider strategy for the 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`	`withSettings(ClusterSetting... settings)` The settings for the cluster.
`Cluster`	`withSettings(Collection<ClusterSetting> settings)` The settings for the cluster.
`Cluster`	`withStatistics(Collection<KeyValuePair> statistics)` Additional information about your clusters that are separated by launch type.
`Cluster`	`withStatistics(KeyValuePair... statistics)` Additional information about your clusters that are separated by launch type.
`Cluster`	`withStatus(String status)` The status of the cluster.
`Cluster`	`withTags(Collection<Tag> tags)` The metadata that you apply to the cluster to help you categorize and organize them.
`Cluster`	`withTags(Tag... tags)` The metadata that you apply to the cluster to help you categorize and organize them.

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

- Constructor Detail
  - Cluster
```
public Cluster()
```
- Method Detail
  - setClusterArn
```
public void setClusterArn(String clusterArn)
```
    The Amazon Resource Name (ARN) that identifies the cluster. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.
    
    Parameters:
    
    clusterArn - The Amazon Resource Name (ARN) that identifies the cluster. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.
  - getClusterArn
```
public String getClusterArn()
```
    The Amazon Resource Name (ARN) that identifies the cluster. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.
    
    Returns:
    
    The Amazon Resource Name (ARN) that identifies the cluster. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.
  - withClusterArn
```
public Cluster withClusterArn(String clusterArn)
```
    The Amazon Resource Name (ARN) that identifies the cluster. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.
    
    Parameters:
    
    clusterArn - The Amazon Resource Name (ARN) that identifies the cluster. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setClusterName
```
public void setClusterName(String clusterName)
```
    A user-generated string that you use to identify your cluster.
    
    Parameters:
    
    clusterName - A user-generated string that you use to identify your cluster.
  - getClusterName
```
public String getClusterName()
```
    A user-generated string that you use to identify your cluster.
    
    Returns:
    
    A user-generated string that you use to identify your cluster.
  - withClusterName
```
public Cluster withClusterName(String clusterName)
```
    A user-generated string that you use to identify your cluster.
    
    Parameters:
    
    clusterName - A user-generated string that you use to identify your cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setConfiguration
```
public void setConfiguration(ClusterConfiguration configuration)
```
    The execute command configuration for the cluster.
    
    Parameters:
    
    configuration - The execute command configuration for the cluster.
  - getConfiguration
```
public ClusterConfiguration getConfiguration()
```
    The execute command configuration for the cluster.
    
    Returns:
    
    The execute command configuration for the cluster.
  - withConfiguration
```
public Cluster withConfiguration(ClusterConfiguration configuration)
```
    The execute command configuration for the cluster.
    
    Parameters:
    
    configuration - The execute command configuration for the cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The status of the cluster. The following are the possible states that are returned.
    
    ACTIVE
    
    The cluster is ready to accept tasks and if applicable you can register container instances with the cluster.
    
    PROVISIONING
    
    The cluster has capacity providers that are associated with it and the resources needed for the capacity provider are being created.
    
    DEPROVISIONING
    
    The cluster has capacity providers that are associated with it and the resources needed for the capacity provider are being deleted.
    
    FAILED
    
    The cluster has capacity providers that are associated with it and the resources needed for the capacity provider have failed to create.
    
    INACTIVE
    
    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. We don't recommend that you rely on INACTIVE clusters persisting.
    
    Parameters:
    
    status - The status of the cluster. The following are the possible states that are returned.
    
    ACTIVE
    
    The cluster is ready to accept tasks and if applicable you can register container instances with the cluster.
    
    PROVISIONING
    
    The cluster has capacity providers that are associated with it and the resources needed for the capacity provider are being created.
    
    DEPROVISIONING
    
    The cluster has capacity providers that are associated with it and the resources needed for the capacity provider are being deleted.
    
    FAILED
    
    The cluster has capacity providers that are associated with it and the resources needed for the capacity provider have failed to create.
    
    INACTIVE
    
    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. We don't recommend that you rely on INACTIVE clusters persisting.
  - getStatus
```
public String getStatus()
```
    The status of the cluster. The following are the possible states that are returned.
    
    ACTIVE
    
    The cluster is ready to accept tasks and if applicable you can register container instances with the cluster.
    
    PROVISIONING
    
    The cluster has capacity providers that are associated with it and the resources needed for the capacity provider are being created.
    
    DEPROVISIONING
    
    The cluster has capacity providers that are associated with it and the resources needed for the capacity provider are being deleted.
    
    FAILED
    
    The cluster has capacity providers that are associated with it and the resources needed for the capacity provider have failed to create.
    
    INACTIVE
    
    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. We don't recommend that you rely on INACTIVE clusters persisting.
    
    Returns:
    
    The status of the cluster. The following are the possible states that are returned.
    
    ACTIVE
    
    The cluster is ready to accept tasks and if applicable you can register container instances with the cluster.
    
    PROVISIONING
    
    The cluster has capacity providers that are associated with it and the resources needed for the capacity provider are being created.
    
    DEPROVISIONING
    
    The cluster has capacity providers that are associated with it and the resources needed for the capacity provider are being deleted.
    
    FAILED
    
    The cluster has capacity providers that are associated with it and the resources needed for the capacity provider have failed to create.
    
    INACTIVE
    
    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. We don't recommend that you rely on INACTIVE clusters persisting.
  - withStatus
```
public Cluster withStatus(String status)
```
    The status of the cluster. The following are the possible states that are returned.
    
    ACTIVE
    
    The cluster is ready to accept tasks and if applicable you can register container instances with the cluster.
    
    PROVISIONING
    
    The cluster has capacity providers that are associated with it and the resources needed for the capacity provider are being created.
    
    DEPROVISIONING
    
    The cluster has capacity providers that are associated with it and the resources needed for the capacity provider are being deleted.
    
    FAILED
    
    The cluster has capacity providers that are associated with it and the resources needed for the capacity provider have failed to create.
    
    INACTIVE
    
    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. We don't recommend that you rely on INACTIVE clusters persisting.
    
    Parameters:
    
    status - The status of the cluster. The following are the possible states that are returned.
    
    ACTIVE
    
    The cluster is ready to accept tasks and if applicable you can register container instances with the cluster.
    
    PROVISIONING
    
    The cluster has capacity providers that are associated with it and the resources needed for the capacity provider are being created.
    
    DEPROVISIONING
    
    The cluster has capacity providers that are associated with it and the resources needed for the capacity provider are being deleted.
    
    FAILED
    
    The cluster has capacity providers that are associated with it and the resources needed for the capacity provider have failed to create.
    
    INACTIVE
    
    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. We don't recommend that you rely on INACTIVE clusters persisting.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRegisteredContainerInstancesCount
```
public void setRegisteredContainerInstancesCount(Integer registeredContainerInstancesCount)
```
    The number of container instances registered into the cluster. This includes container instances in both ACTIVE and DRAINING status.
    
    Parameters:
    
    registeredContainerInstancesCount - The number of container instances registered into the cluster. This includes container instances in both ACTIVE and DRAINING status.
  - getRegisteredContainerInstancesCount
```
public Integer getRegisteredContainerInstancesCount()
```
    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.
  - withRegisteredContainerInstancesCount
```
public Cluster withRegisteredContainerInstancesCount(Integer registeredContainerInstancesCount)
```
    The number of container instances registered into the cluster. This includes container instances in both ACTIVE and DRAINING status.
    
    Parameters:
    
    registeredContainerInstancesCount - The number of container instances registered into the cluster. This includes container instances in both ACTIVE and DRAINING status.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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.
  - 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.
  - withRunningTasksCount
```
public Cluster withRunningTasksCount(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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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.
  - 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.
  - withPendingTasksCount
```
public Cluster withPendingTasksCount(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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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.
  - 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.
  - 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.
    
    Parameters:
    
    activeServicesCount - The number of services that are running on the cluster in an ACTIVE state. You can view these services with ListServices.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getStatistics
```
public List<KeyValuePair> getStatistics()
```
    Additional information about your clusters that are separated by launch type. They include the following:
    - runningEC2TasksCount
    - RunningFargateTasksCount
    - pendingEC2TasksCount
    - pendingFargateTasksCount
    - activeEC2ServiceCount
    - activeFargateServiceCount
    - drainingEC2ServiceCount
    - drainingFargateServiceCount
    Returns:
    Additional information about your clusters that are separated by launch type. They include the following:
    
    runningEC2TasksCount
    
    RunningFargateTasksCount
    
    pendingEC2TasksCount
    
    pendingFargateTasksCount
    
    activeEC2ServiceCount
    
    activeFargateServiceCount
    
    drainingEC2ServiceCount
    
    drainingFargateServiceCount
  - setStatistics
```
public void setStatistics(Collection<KeyValuePair> statistics)
```
    Additional information about your clusters that are separated by launch type. They include the following:
    - runningEC2TasksCount
    - RunningFargateTasksCount
    - pendingEC2TasksCount
    - pendingFargateTasksCount
    - activeEC2ServiceCount
    - activeFargateServiceCount
    - drainingEC2ServiceCount
    - drainingFargateServiceCount
    Parameters:
    statistics - Additional information about your clusters that are separated by launch type. They include the following:
    
    runningEC2TasksCount
    
    RunningFargateTasksCount
    
    pendingEC2TasksCount
    
    pendingFargateTasksCount
    
    activeEC2ServiceCount
    
    activeFargateServiceCount
    
    drainingEC2ServiceCount
    
    drainingFargateServiceCount
  - withStatistics
```
public Cluster withStatistics(KeyValuePair... statistics)
```
    Additional information about your clusters that are separated by launch type. They include the following:
    - runningEC2TasksCount
    - RunningFargateTasksCount
    - pendingEC2TasksCount
    - pendingFargateTasksCount
    - activeEC2ServiceCount
    - activeFargateServiceCount
    - drainingEC2ServiceCount
    - drainingFargateServiceCount
    NOTE: This method appends the values to the existing list (if any). Use setStatistics(java.util.Collection) or withStatistics(java.util.Collection) if you want to override the existing values.
    Parameters:
    statistics - Additional information about your clusters that are separated by launch type. They include the following:
    
    runningEC2TasksCount
    
    RunningFargateTasksCount
    
    pendingEC2TasksCount
    
    pendingFargateTasksCount
    
    activeEC2ServiceCount
    
    activeFargateServiceCount
    
    drainingEC2ServiceCount
    
    drainingFargateServiceCount
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withStatistics
```
public Cluster withStatistics(Collection<KeyValuePair> statistics)
```
    Additional information about your clusters that are separated by launch type. They include the following:
    - runningEC2TasksCount
    - RunningFargateTasksCount
    - pendingEC2TasksCount
    - pendingFargateTasksCount
    - activeEC2ServiceCount
    - activeFargateServiceCount
    - drainingEC2ServiceCount
    - drainingFargateServiceCount
    Parameters:
    statistics - Additional information about your clusters that are separated by launch type. They include the following:
    
    runningEC2TasksCount
    
    RunningFargateTasksCount
    
    pendingEC2TasksCount
    
    pendingFargateTasksCount
    
    activeEC2ServiceCount
    
    activeFargateServiceCount
    
    drainingEC2ServiceCount
    
    drainingFargateServiceCount
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public List<Tag> getTags()
```
    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. You define both.
    
    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 Amazon Web Services 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.
    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. You define both.
    
    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 Amazon Web Services 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.
  - setTags
```
public void setTags(Collection<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. You define both.
    
    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 Amazon Web Services 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.
    Parameters:
    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. You define both.
    
    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 Amazon Web Services 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.
  - withTags
```
public Cluster withTags(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. You define both.
    
    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 Amazon Web Services 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.
    NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.
    Parameters:
    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. You define both.
    
    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 Amazon Web Services 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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public Cluster withTags(Collection<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. You define both.
    
    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 Amazon Web Services 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.
    Parameters:
    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. You define both.
    
    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 Amazon Web Services 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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSettings
```
public List<ClusterSetting> getSettings()
```
    The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is enabled or disabled for a cluster.
    
    Returns:
    
    The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is enabled or disabled for a cluster.
  - setSettings
```
public void setSettings(Collection<ClusterSetting> settings)
```
    The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is enabled or disabled for a cluster.
    
    Parameters:
    
    settings - The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is enabled or disabled for a cluster.
  - withSettings
```
public Cluster withSettings(ClusterSetting... settings)
```
    The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is enabled or disabled for a cluster.
    
    NOTE: This method appends the values to the existing list (if any). Use setSettings(java.util.Collection) or withSettings(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    settings - The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is enabled or disabled for a cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSettings
```
public Cluster withSettings(Collection<ClusterSetting> settings)
```
    The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is enabled or disabled for a cluster.
    
    Parameters:
    
    settings - The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is enabled or disabled for a cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getCapacityProviders
```
public List<String> getCapacityProviders()
```
    The capacity providers associated with the cluster.
    
    Returns:
    
    The capacity providers associated with the cluster.
  - setCapacityProviders
```
public void setCapacityProviders(Collection<String> capacityProviders)
```
    The capacity providers associated with the cluster.
    
    Parameters:
    
    capacityProviders - The capacity providers associated with the cluster.
  - withCapacityProviders
```
public Cluster withCapacityProviders(String... capacityProviders)
```
    The capacity providers associated with the cluster.
    
    NOTE: This method appends the values to the existing list (if any). Use setCapacityProviders(java.util.Collection) or withCapacityProviders(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    capacityProviders - The capacity providers associated with the cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withCapacityProviders
```
public Cluster withCapacityProviders(Collection<String> capacityProviders)
```
    The capacity providers associated with the cluster.
    
    Parameters:
    
    capacityProviders - The capacity providers associated with the cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getDefaultCapacityProviderStrategy
```
public List<CapacityProviderStrategyItem> getDefaultCapacityProviderStrategy()
```
    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.
    
    Returns:
    
    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.
  - setDefaultCapacityProviderStrategy
```
public void setDefaultCapacityProviderStrategy(Collection<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.
    
    Parameters:
    
    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.
  - withDefaultCapacityProviderStrategy
```
public Cluster withDefaultCapacityProviderStrategy(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setDefaultCapacityProviderStrategy(java.util.Collection) or withDefaultCapacityProviderStrategy(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withDefaultCapacityProviderStrategy
```
public Cluster withDefaultCapacityProviderStrategy(Collection<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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAttachments
```
public List<Attachment> getAttachments()
```
    The resources attached to a cluster. When using a capacity provider with a cluster, the capacity provider and associated resources are returned as cluster attachments.
    
    Returns:
    
    The resources attached to a cluster. When using a capacity provider with a cluster, the capacity provider and associated resources are returned as cluster attachments.
  - setAttachments
```
public void setAttachments(Collection<Attachment> attachments)
```
    The resources attached to a cluster. When using a capacity provider with a cluster, the capacity provider and associated resources are returned as cluster attachments.
    
    Parameters:
    
    attachments - The resources attached to a cluster. When using a capacity provider with a cluster, the capacity provider and associated resources are returned as cluster attachments.
  - withAttachments
```
public Cluster withAttachments(Attachment... attachments)
```
    The resources attached to a cluster. When using a capacity provider with a cluster, the capacity provider and associated resources are returned as cluster attachments.
    
    NOTE: This method appends the values to the existing list (if any). Use setAttachments(java.util.Collection) or withAttachments(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    attachments - The resources attached to a cluster. When using a capacity provider with a cluster, the capacity provider and associated resources are returned as cluster attachments.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAttachments
```
public Cluster withAttachments(Collection<Attachment> attachments)
```
    The resources attached to a cluster. When using a capacity provider with a cluster, the capacity provider and associated resources are returned as cluster attachments.
    
    Parameters:
    
    attachments - The resources attached to a cluster. When using a capacity provider with a cluster, the capacity provider and associated resources are returned as cluster attachments.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAttachmentsStatus
```
public void setAttachmentsStatus(String attachmentsStatus)
```
    The status of the capacity providers associated with the cluster. The following are the states that are returned.
    
    UPDATE_IN_PROGRESS
    
    The available capacity providers for the cluster are updating.
    
    UPDATE_COMPLETE
    
    The capacity providers have successfully updated.
    
    UPDATE_FAILED
    
    The capacity provider updates failed.
    
    Parameters:
    
    attachmentsStatus - The status of the capacity providers associated with the cluster. The following are the states that are returned.
    
    UPDATE_IN_PROGRESS
    
    The available capacity providers for the cluster are updating.
    
    UPDATE_COMPLETE
    
    The capacity providers have successfully updated.
    
    UPDATE_FAILED
    
    The capacity provider updates failed.
  - getAttachmentsStatus
```
public String getAttachmentsStatus()
```
    The status of the capacity providers associated with the cluster. The following are the states that are returned.
    
    UPDATE_IN_PROGRESS
    
    The available capacity providers for the cluster are updating.
    
    UPDATE_COMPLETE
    
    The capacity providers have successfully updated.
    
    UPDATE_FAILED
    
    The capacity provider updates failed.
    
    Returns:
    
    The status of the capacity providers associated with the cluster. The following are the states that are returned.
    
    UPDATE_IN_PROGRESS
    
    The available capacity providers for the cluster are updating.
    
    UPDATE_COMPLETE
    
    The capacity providers have successfully updated.
    
    UPDATE_FAILED
    
    The capacity provider updates failed.
  - withAttachmentsStatus
```
public Cluster withAttachmentsStatus(String attachmentsStatus)
```
    The status of the capacity providers associated with the cluster. The following are the states that are returned.
    
    UPDATE_IN_PROGRESS
    
    The available capacity providers for the cluster are updating.
    
    UPDATE_COMPLETE
    
    The capacity providers have successfully updated.
    
    UPDATE_FAILED
    
    The capacity provider updates failed.
    
    Parameters:
    
    attachmentsStatus - The status of the capacity providers associated with the cluster. The following are the states that are returned.
    
    UPDATE_IN_PROGRESS
    
    The available capacity providers for the cluster are updating.
    
    UPDATE_COMPLETE
    
    The capacity providers have successfully updated.
    
    UPDATE_FAILED
    
    The capacity provider updates failed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Cluster clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class Cluster

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Cluster

Method Detail

setClusterArn

getClusterArn

withClusterArn

setClusterName

getClusterName

withClusterName

setConfiguration

getConfiguration

withConfiguration

setStatus

getStatus

withStatus

setRegisteredContainerInstancesCount

getRegisteredContainerInstancesCount

withRegisteredContainerInstancesCount

setRunningTasksCount

getRunningTasksCount

withRunningTasksCount

setPendingTasksCount

getPendingTasksCount

withPendingTasksCount

setActiveServicesCount

getActiveServicesCount

withActiveServicesCount

getStatistics

setStatistics

withStatistics

withStatistics

getTags

setTags

withTags

withTags

getSettings

setSettings

withSettings

withSettings

getCapacityProviders

setCapacityProviders

withCapacityProviders

withCapacityProviders

getDefaultCapacityProviderStrategy

setDefaultCapacityProviderStrategy

withDefaultCapacityProviderStrategy

withDefaultCapacityProviderStrategy

getAttachments

setAttachments

withAttachments

withAttachments

setAttachmentsStatus

getAttachmentsStatus

withAttachmentsStatus

toString

equals

hashCode

clone

marshall