Class ReservedCapacityOptionsRequest

java.lang.Object
software.amazon.awssdk.services.ec2.model.ReservedCapacityOptionsRequest
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ReservedCapacityOptionsRequest.Builder,ReservedCapacityOptionsRequest>
@Generated("software.amazon.awssdk:codegen") public final class ReservedCapacityOptionsRequest extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ReservedCapacityOptionsRequest.Builder,ReservedCapacityOptionsRequest>

Defines EC2 Fleet preferences for utilizing reserved capacity when DefaultTargetCapacityType is set to reserved-capacity. EC2 Fleet can fulfill reserved capacity using On-Demand Capacity Reservations, Capacity Blocks for ML, and interruptible Capacity Reservations.

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

When you specify ReservedCapacityOptions, you must also set DefaultTargetCapacityType to reserved-capacity in the TargetCapacitySpecification.

For more information about interruptible Capacity Reservations, see Launch instances into an interruptible Capacity Reservation in the Amazon EC2 User Guide.

See Also:

  • Method Details

    • allocationStrategy

      public final ReservedCapacityAllocationStrategy allocationStrategy()

      The strategy that determines the order in which EC2 Fleet launches instances across the reservation types that you specify. The only supported value is prioritized, which launches instances in the priority order that you specify in your launch template overrides. If you don't specify an allocation strategy, instances are launched in a random order.

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

      Returns:
      The strategy that determines the order in which EC2 Fleet launches instances across the reservation types that you specify. The only supported value is prioritized, which launches instances in the priority order that you specify in your launch template overrides. If you don't specify an allocation strategy, instances are launched in a random order.
      See Also:

    • allocationStrategyAsString

      public final String allocationStrategyAsString()

      The strategy that determines the order in which EC2 Fleet launches instances across the reservation types that you specify. The only supported value is prioritized, which launches instances in the priority order that you specify in your launch template overrides. If you don't specify an allocation strategy, instances are launched in a random order.

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

      Returns:
      The strategy that determines the order in which EC2 Fleet launches instances across the reservation types that you specify. The only supported value is prioritized, which launches instances in the priority order that you specify in your launch template overrides. If you don't specify an allocation strategy, instances are launched in a random order.
      See Also:

    • reservationTypes

      public final List<FleetReservationType> reservationTypes()

      The types of Capacity Reservations to use for fulfilling the EC2 Fleet request. This is an ordered list: EC2 Fleet attempts to launch instances into each Capacity Reservation type in the order that you specify them before moving on to the next type.

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

      Returns:
      The types of Capacity Reservations to use for fulfilling the EC2 Fleet request. This is an ordered list: EC2 Fleet attempts to launch instances into each Capacity Reservation type in the order that you specify them before moving on to the next type.

    • hasReservationTypes

      public final boolean hasReservationTypes()
      For responses, this returns true if the service returned a value for the ReservationTypes 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.

    • reservationTypesAsStrings

      public final List<String> reservationTypesAsStrings()

      The types of Capacity Reservations to use for fulfilling the EC2 Fleet request. This is an ordered list: EC2 Fleet attempts to launch instances into each Capacity Reservation type in the order that you specify them before moving on to the next type.

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

      Returns:
      The types of Capacity Reservations to use for fulfilling the EC2 Fleet request. This is an ordered list: EC2 Fleet attempts to launch instances into each Capacity Reservation type in the order that you specify them before moving on to the next type.

    • capacityReservationTarget

      public final FleetCapacityReservationTargetRequest capacityReservationTarget()

      The Capacity Reservations or Capacity Reservation Resource Groups to use for fulfilling the EC2 Fleet request. You can specify Capacity Reservation IDs or a Capacity Reservation Resource Group ARN, but not both.

      Returns:
      The Capacity Reservations or Capacity Reservation Resource Groups to use for fulfilling the EC2 Fleet request. You can specify Capacity Reservation IDs or a Capacity Reservation Resource Group ARN, but not both.

    • reservedCapacityFallbackOptions

      public final ReservedCapacityFallbackOptionsRequest reservedCapacityFallbackOptions()

      The fallback behavior for the EC2 Fleet when there is not enough reserved capacity available to meet the target capacity. This member takes a ReservedCapacityFallbackOptionsRequest structure, in which you set MarketTypes to the instance purchasing options to fall back to.

      Returns:
      The fallback behavior for the EC2 Fleet when there is not enough reserved capacity available to meet the target capacity. This member takes a ReservedCapacityFallbackOptionsRequest structure, in which you set MarketTypes to the instance purchasing options to fall back to.

    • toBuilder

      public ReservedCapacityOptionsRequest.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<ReservedCapacityOptionsRequest.Builder,ReservedCapacityOptionsRequest>
      Returns:
      a builder for type T

    • builder

      public static ReservedCapacityOptionsRequest.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.