AwsEcsClusterDetails (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.securityhub.model.AwsEcsClusterDetails

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<AwsEcsClusterDetails.Builder,AwsEcsClusterDetails>

@Generated(value="software.amazon.awssdk:codegen")
public final class AwsEcsClusterDetails
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AwsEcsClusterDetails.Builder,AwsEcsClusterDetails>

Provides details about an Amazon ECS cluster.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface AwsEcsClusterDetails.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`AwsEcsClusterDetails.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 AwsEcsClusterDetails.Builder`	`builder()`
`List<String>`	`capacityProviders()` The short name of one or more capacity providers to associate with the cluster.
`String`	`clusterArn()` The Amazon Resource Name (ARN) that identifies the cluster.
`String`	`clusterName()` A name that you use to identify your cluster.
`List<AwsEcsClusterClusterSettingsDetails>`	`clusterSettings()` The setting to use to create the cluster.
`AwsEcsClusterConfigurationDetails`	`configuration()` The run command configuration for the cluster.
`List<AwsEcsClusterDefaultCapacityProviderStrategyDetails>`	`defaultCapacityProviderStrategy()` The default capacity provider strategy for the cluster.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasCapacityProviders()` For responses, this returns true if the service returned a value for the CapacityProviders property.
`boolean`	`hasClusterSettings()` For responses, this returns true if the service returned a value for the ClusterSettings property.
`boolean`	`hasDefaultCapacityProviderStrategy()` For responses, this returns true if the service returned a value for the DefaultCapacityProviderStrategy property.
`int`	`hashCode()`
`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 AwsEcsClusterDetails.Builder>`	`serializableBuilderClass()`
`String`	`status()` The status of the cluster.
`AwsEcsClusterDetails.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 final String clusterArn()
```
    The Amazon Resource Name (ARN) that identifies the cluster.
    
    Returns:
    
    The Amazon Resource Name (ARN) that identifies the cluster.
  - activeServicesCount
```
public final Integer activeServicesCount()
```
    The number of services that are running on the cluster in an ACTIVE state. You can view these services with the Amazon ECS ListServices API operation.
    
    Returns:
    
    The number of services that are running on the cluster in an ACTIVE state. You can view these services with the Amazon ECS ListServices API operation.
  - hasCapacityProviders
```
public final boolean hasCapacityProviders()
```
    For responses, this returns true if the service returned a value for the CapacityProviders property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - capacityProviders
```
public final List<String> capacityProviders()
```
    The short name of one or more capacity providers to associate with the cluster.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCapacityProviders() method.
    
    Returns:
    
    The short name of one or more capacity providers to associate with the cluster.
  - hasClusterSettings
```
public final boolean hasClusterSettings()
```
    For responses, this returns true if the service returned a value for the ClusterSettings property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - clusterSettings
```
public final List<AwsEcsClusterClusterSettingsDetails> clusterSettings()
```
    The setting to use to create the cluster. Specifically used to configure whether to enable CloudWatch Container Insights for the cluster.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasClusterSettings() method.
    
    Returns:
    
    The setting to use to create the cluster. Specifically used to configure whether to enable CloudWatch Container Insights for the cluster.
  - configuration
```
public final AwsEcsClusterConfigurationDetails configuration()
```
    The run command configuration for the cluster.
    
    Returns:
    
    The run command configuration for the cluster.
  - hasDefaultCapacityProviderStrategy
```
public final boolean hasDefaultCapacityProviderStrategy()
```
    For responses, this returns true if the service returned a value for the DefaultCapacityProviderStrategy property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - defaultCapacityProviderStrategy
```
public final List<AwsEcsClusterDefaultCapacityProviderStrategyDetails> defaultCapacityProviderStrategy()
```
    The default capacity provider strategy for the cluster. The default capacity provider strategy is used when services or tasks are run without a specified launch type or capacity provider strategy.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDefaultCapacityProviderStrategy() method.
    
    Returns:
    
    The default capacity provider strategy for the cluster. The default capacity provider strategy is used when services or tasks are run without a specified launch type or capacity provider strategy.
  - clusterName
```
public final String clusterName()
```
    A name that you use to identify your cluster.
    
    Returns:
    
    A name that you use to identify your cluster.
  - registeredContainerInstancesCount
```
public final 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 final 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.
  - status
```
public final String status()
```
    The status of the cluster.
    
    Returns:
    
    The status of the cluster.
  - toBuilder
```
public AwsEcsClusterDetails.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AwsEcsClusterDetails.Builder,AwsEcsClusterDetails>
  - builder
```
public static AwsEcsClusterDetails.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AwsEcsClusterDetails.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class AwsEcsClusterDetails

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

activeServicesCount

hasCapacityProviders

capacityProviders

hasClusterSettings

clusterSettings

configuration

hasDefaultCapacityProviderStrategy

defaultCapacityProviderStrategy

clusterName

registeredContainerInstancesCount

runningTasksCount

status

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields