Package software.amazon.awssdk.services.ecs.model

Class CapacityProvider

java.lang.Object

software.amazon.awssdk.services.ecs.model.CapacityProvider

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CapacityProvider.Builder,CapacityProvider>

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

The details for a capacity provider.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CapacityProvider.Builder

Method Summary

Modifier and Type	Method	Description
final AutoScalingGroupProvider	autoScalingGroupProvider()	The Auto Scaling group settings for the capacity provider.
static CapacityProvider.Builder	builder()
final String	capacityProviderArn()	The Amazon Resource Name (ARN) that identifies the capacity provider.
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
final String	name()	The name of the capacity provider.
final List<SdkField<?>>	sdkFields()
static Class<? extends CapacityProvider.Builder>	serializableBuilderClass()
final CapacityProviderStatus	status()	The current status of the capacity provider.
final String	statusAsString()	The current status of the capacity provider.
final List<Tag>	tags()	The metadata that you apply to the capacity provider to help you categorize and organize it.
CapacityProvider.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
final String	toString()	Returns a string representation of this object.
final CapacityProviderUpdateStatus	updateStatus()	The update status of the capacity provider.
final String	updateStatusAsString()	The update status of the capacity provider.
final String	updateStatusReason()	The update status reason.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Details

capacityProviderArn

public final String capacityProviderArn()

The Amazon Resource Name (ARN) that identifies the capacity provider.

Returns:

The Amazon Resource Name (ARN) that identifies the capacity provider.

name

public final String name()

The name of the capacity provider.

Returns:

The name of the capacity provider.

status

public final CapacityProviderStatus status()

The current status of the capacity provider. Only capacity providers in an ACTIVE state can be used in a cluster. When a capacity provider is successfully deleted, it has an INACTIVE status.

If the service returns an enum value that is not available in the current SDK version, status will return CapacityProviderStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The current status of the capacity provider. Only capacity providers in an ACTIVE state can be used in a cluster. When a capacity provider is successfully deleted, it has an INACTIVE status.

See Also:

• CapacityProviderStatus

statusAsString

public final String statusAsString()

The current status of the capacity provider. Only capacity providers in an ACTIVE state can be used in a cluster. When a capacity provider is successfully deleted, it has an INACTIVE status.

If the service returns an enum value that is not available in the current SDK version, status will return CapacityProviderStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The current status of the capacity provider. Only capacity providers in an ACTIVE state can be used in a cluster. When a capacity provider is successfully deleted, it has an INACTIVE status.

See Also:

• CapacityProviderStatus

autoScalingGroupProvider

public final AutoScalingGroupProvider autoScalingGroupProvider()

The Auto Scaling group settings for the capacity provider.

Returns:

The Auto Scaling group settings for the capacity provider.

updateStatus

public final CapacityProviderUpdateStatus updateStatus()

The update status of the capacity provider. The following are the possible states that is returned.

DELETE_IN_PROGRESS

The capacity provider is in the process of being deleted.

DELETE_COMPLETE

The capacity provider was successfully deleted and has an INACTIVE status.

DELETE_FAILED

The capacity provider can't be deleted. The update status reason provides further details about why the delete failed.

If the service returns an enum value that is not available in the current SDK version, updateStatus will return CapacityProviderUpdateStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from updateStatusAsString().

Returns:

The update status of the capacity provider. The following are the possible states that is returned.

DELETE_IN_PROGRESS

The capacity provider is in the process of being deleted.

DELETE_COMPLETE

The capacity provider was successfully deleted and has an INACTIVE status.

DELETE_FAILED

The capacity provider can't be deleted. The update status reason provides further details about why the delete failed.

See Also:

• CapacityProviderUpdateStatus

updateStatusAsString

public final String updateStatusAsString()

The update status of the capacity provider. The following are the possible states that is returned.

DELETE_IN_PROGRESS

The capacity provider is in the process of being deleted.

DELETE_COMPLETE

The capacity provider was successfully deleted and has an INACTIVE status.

DELETE_FAILED

The capacity provider can't be deleted. The update status reason provides further details about why the delete failed.

If the service returns an enum value that is not available in the current SDK version, updateStatus will return CapacityProviderUpdateStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from updateStatusAsString().

Returns:

The update status of the capacity provider. The following are the possible states that is returned.

DELETE_IN_PROGRESS

The capacity provider is in the process of being deleted.

DELETE_COMPLETE

The capacity provider was successfully deleted and has an INACTIVE status.

DELETE_FAILED

The capacity provider can't be deleted. The update status reason provides further details about why the delete failed.

See Also:

• CapacityProviderUpdateStatus

updateStatusReason

public final String updateStatusReason()

The update status reason. This provides further details about the update status for the capacity provider.

Returns:

The update status reason. This provides further details about the update status for the capacity provider.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags 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.

tags

public final List<Tag> tags()

The metadata that you apply to the capacity provider to help you categorize and organize it. 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.

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 hasTags() method.

Returns:

The metadata that you apply to the capacity provider to help you categorize and organize it. 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.

toBuilder

public CapacityProvider.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CapacityProvider.Builder,CapacityProvider>

Returns:

a builder for type T

builder

public static CapacityProvider.Builder builder()

serializableBuilderClass

public static Class<? extends CapacityProvider.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)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an 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.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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

Returns:

List of SdkField in this POJO. May be empty list but should never be null.