Package software.amazon.awssdk.services.ec2.model

Class CapacityReservationOptions

java.lang.Object

software.amazon.awssdk.services.ec2.model.CapacityReservationOptions

All Implemented Interfaces:

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

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

Describes the strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.

This strategy can only be used if the EC2 Fleet is of type instant.

For more information about Capacity Reservations, see On-Demand Capacity Reservations in the Amazon EC2 User Guide. For examples of using Capacity Reservations in an EC2 Fleet, see EC2 Fleet example configurations in the Amazon EC2 User Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CapacityReservationOptions.Builder

Method Summary

Modifier and Type	Method	Description
static CapacityReservationOptions.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends CapacityReservationOptions.Builder>	serializableBuilderClass()
CapacityReservationOptions.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
FleetCapacityReservationUsageStrategy	usageStrategy()	Indicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity.
String	usageStrategyAsString()	Indicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity.

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

usageStrategy

public final FleetCapacityReservationUsageStrategy usageStrategy()

Indicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity.

If you specify use-capacity-reservations-first, the fleet uses unused Capacity Reservations to fulfill On-Demand capacity up to the target On-Demand capacity. If multiple instance pools have unused Capacity Reservations, the On-Demand allocation strategy (lowest-price or prioritized) is applied. If the number of unused Capacity Reservations is less than the On-Demand target capacity, the remaining On-Demand target capacity is launched according to the On-Demand allocation strategy (lowest-price or prioritized).

If you do not specify a value, the fleet fulfils the On-Demand capacity according to the chosen On-Demand allocation strategy.

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

Returns:

Indicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity.

If you specify use-capacity-reservations-first, the fleet uses unused Capacity Reservations to fulfill On-Demand capacity up to the target On-Demand capacity. If multiple instance pools have unused Capacity Reservations, the On-Demand allocation strategy (lowest-price or prioritized) is applied. If the number of unused Capacity Reservations is less than the On-Demand target capacity, the remaining On-Demand target capacity is launched according to the On-Demand allocation strategy (lowest-price or prioritized).

If you do not specify a value, the fleet fulfils the On-Demand capacity according to the chosen On-Demand allocation strategy.

See Also:

FleetCapacityReservationUsageStrategy

usageStrategyAsString

public final String usageStrategyAsString()

Indicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity.

If you specify use-capacity-reservations-first, the fleet uses unused Capacity Reservations to fulfill On-Demand capacity up to the target On-Demand capacity. If multiple instance pools have unused Capacity Reservations, the On-Demand allocation strategy (lowest-price or prioritized) is applied. If the number of unused Capacity Reservations is less than the On-Demand target capacity, the remaining On-Demand target capacity is launched according to the On-Demand allocation strategy (lowest-price or prioritized).

If you do not specify a value, the fleet fulfils the On-Demand capacity according to the chosen On-Demand allocation strategy.

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

Returns:

Indicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity.

If you specify use-capacity-reservations-first, the fleet uses unused Capacity Reservations to fulfill On-Demand capacity up to the target On-Demand capacity. If multiple instance pools have unused Capacity Reservations, the On-Demand allocation strategy (lowest-price or prioritized) is applied. If the number of unused Capacity Reservations is less than the On-Demand target capacity, the remaining On-Demand target capacity is launched according to the On-Demand allocation strategy (lowest-price or prioritized).

If you do not specify a value, the fleet fulfils the On-Demand capacity according to the chosen On-Demand allocation strategy.

See Also:

FleetCapacityReservationUsageStrategy

toBuilder

public CapacityReservationOptions.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CapacityReservationOptions.Builder,CapacityReservationOptions>

builder

public static CapacityReservationOptions.Builder builder()

serializableBuilderClass

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