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

Class CapacityReservationRequest

java.lang.Object

software.amazon.awssdk.services.ecs.model.CapacityReservationRequest

All Implemented Interfaces:

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

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

The Capacity Reservation configurations to be used when using the RESERVED capacity option type.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CapacityReservationRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CapacityReservationRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	reservationGroupArn()	The ARN of the Capacity Reservation resource group in which to run the instance.
CapacityReservationPreference	reservationPreference()	The preference on when capacity reservations should be used.
String	reservationPreferenceAsString()	The preference on when capacity reservations should be used.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CapacityReservationRequest.Builder>	serializableBuilderClass()
CapacityReservationRequest.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

reservationGroupArn

public final String reservationGroupArn()

The ARN of the Capacity Reservation resource group in which to run the instance.

Returns:

The ARN of the Capacity Reservation resource group in which to run the instance.

reservationPreference

public final CapacityReservationPreference reservationPreference()

The preference on when capacity reservations should be used.

Valid values are:

• RESERVATIONS_ONLY - Exclusively launch instances into capacity reservations that match the instance requirements configured for the capacity provider. If none exist, instances will fail to provision.

• RESERVATIONS_FIRST - Prefer to launch instances into a capacity reservation if any exist that match the instance requirements configured for the capacity provider. If none exist, fall back to launching instances On-Demand.

• RESERVATIONS_EXCLUDED - Avoid using capacity reservations and launch exclusively On-Demand.

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

Returns:

The preference on when capacity reservations should be used.

Valid values are:

• RESERVATIONS_ONLY - Exclusively launch instances into capacity reservations that match the instance requirements configured for the capacity provider. If none exist, instances will fail to provision.

• RESERVATIONS_FIRST - Prefer to launch instances into a capacity reservation if any exist that match the instance requirements configured for the capacity provider. If none exist, fall back to launching instances On-Demand.

• RESERVATIONS_EXCLUDED - Avoid using capacity reservations and launch exclusively On-Demand.

See Also:

CapacityReservationPreference

reservationPreferenceAsString

public final String reservationPreferenceAsString()

The preference on when capacity reservations should be used.

Valid values are:

• RESERVATIONS_ONLY - Exclusively launch instances into capacity reservations that match the instance requirements configured for the capacity provider. If none exist, instances will fail to provision.

• RESERVATIONS_FIRST - Prefer to launch instances into a capacity reservation if any exist that match the instance requirements configured for the capacity provider. If none exist, fall back to launching instances On-Demand.

• RESERVATIONS_EXCLUDED - Avoid using capacity reservations and launch exclusively On-Demand.

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

Returns:

The preference on when capacity reservations should be used.

Valid values are:

• RESERVATIONS_ONLY - Exclusively launch instances into capacity reservations that match the instance requirements configured for the capacity provider. If none exist, instances will fail to provision.

• RESERVATIONS_FIRST - Prefer to launch instances into a capacity reservation if any exist that match the instance requirements configured for the capacity provider. If none exist, fall back to launching instances On-Demand.

• RESERVATIONS_EXCLUDED - Avoid using capacity reservations and launch exclusively On-Demand.

See Also:

CapacityReservationPreference

toBuilder

public CapacityReservationRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CapacityReservationRequest.Builder,CapacityReservationRequest>

builder

public static CapacityReservationRequest.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo