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

The details of a capacity provider.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CapacityProvider.Builder

Method Summary

Modifier and Type	Method and Description
AutoScalingGroupProvider	autoScalingGroupProvider() The Auto Scaling group settings for the capacity provider.
static CapacityProvider.Builder	builder()
String	capacityProviderArn() The Amazon Resource Name (ARN) that identifies the capacity provider.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
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).
String	name() The name of the capacity provider.
List<SdkField<?>>	sdkFields()
static Class<? extends CapacityProvider.Builder>	serializableBuilderClass()
CapacityProviderStatus	status() The current status of the capacity provider.
String	statusAsString() The current status of the capacity provider.
List<Tag>	tags() The metadata that you apply to the capacity provider to help you categorize and organize it.
CapacityProvider.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

capacityProviderArn

public 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 String name()

The name of the capacity provider.

Returns:

The name of the capacity provider.

status

public CapacityProviderStatus status()

The current status of the capacity provider. Only capacity providers in an ACTIVE state can be used in a cluster.

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.

See Also:

CapacityProviderStatus

statusAsString

public String statusAsString()

The current status of the capacity provider. Only capacity providers in an ACTIVE state can be used in a cluster.

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.

See Also:

CapacityProviderStatus

autoScalingGroupProvider

public AutoScalingGroupProvider autoScalingGroupProvider()

The Auto Scaling group settings for the capacity provider.

Returns:

The Auto Scaling group settings for the capacity provider.

hasTags

public 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). For responses returned by the SDK, the sender is the AWS service.

tags

public 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, 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.

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, 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.

toBuilder

public CapacityProvider.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CapacityProvider.Builder,CapacityProvider>

builder

public static CapacityProvider.Builder builder()

serializableBuilderClass

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