Class OnDemandCapacityReservationOptions

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

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

See Also:

  • Method Details

    • usageStrategy

      public final OnDemandCapacityReservationUsageStrategy 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) 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).

      If you do not specify a value, the fleet fulfills 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 OnDemandCapacityReservationUsageStrategy.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) 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).

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

      See Also:

    • 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) 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).

      If you do not specify a value, the fleet fulfills 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 OnDemandCapacityReservationUsageStrategy.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) 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).

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

      See Also:

    • capacityReservationPreference

      public final OnDemandCapacityReservationPreference capacityReservationPreference()

      Indicates the instance's Capacity Reservation preferences. Possible preferences include:

      • open - The instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).

      • none - The instance avoids running in a Capacity Reservation even if one is available. The instance runs as an On-Demand Instance.

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

      Returns:
      Indicates the instance's Capacity Reservation preferences. Possible preferences include:

      • open - The instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).

      • none - The instance avoids running in a Capacity Reservation even if one is available. The instance runs as an On-Demand Instance.

      See Also:

    • capacityReservationPreferenceAsString

      public final String capacityReservationPreferenceAsString()

      Indicates the instance's Capacity Reservation preferences. Possible preferences include:

      • open - The instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).

      • none - The instance avoids running in a Capacity Reservation even if one is available. The instance runs as an On-Demand Instance.

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

      Returns:
      Indicates the instance's Capacity Reservation preferences. Possible preferences include:

      • open - The instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).

      • none - The instance avoids running in a Capacity Reservation even if one is available. The instance runs as an On-Demand Instance.

      See Also:

    • capacityReservationResourceGroupArn

      public final String capacityReservationResourceGroupArn()

      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.

    • toBuilder

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

    • builder

      public static OnDemandCapacityReservationOptions.Builder builder()

    • serializableBuilderClass

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