Class OnDemandOptions

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

Describes the configuration of On-Demand Instances in an EC2 Fleet.

See Also:

  • Method Details

    • allocationStrategy

      public final FleetOnDemandAllocationStrategy allocationStrategy()

      The strategy that determines the order of the launch template overrides to use in fulfilling On-Demand capacity.

      lowest-price - EC2 Fleet uses price to determine the order, launching the lowest price first.

      prioritized - EC2 Fleet uses the priority that you assigned to each launch template override, launching the highest priority first.

      Default: lowest-price

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

      Returns:
      The strategy that determines the order of the launch template overrides to use in fulfilling On-Demand capacity.

      lowest-price - EC2 Fleet uses price to determine the order, launching the lowest price first.

      prioritized - EC2 Fleet uses the priority that you assigned to each launch template override, launching the highest priority first.

      Default: lowest-price

      See Also:

    • allocationStrategyAsString

      public final String allocationStrategyAsString()

      The strategy that determines the order of the launch template overrides to use in fulfilling On-Demand capacity.

      lowest-price - EC2 Fleet uses price to determine the order, launching the lowest price first.

      prioritized - EC2 Fleet uses the priority that you assigned to each launch template override, launching the highest priority first.

      Default: lowest-price

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

      Returns:
      The strategy that determines the order of the launch template overrides to use in fulfilling On-Demand capacity.

      lowest-price - EC2 Fleet uses price to determine the order, launching the lowest price first.

      prioritized - EC2 Fleet uses the priority that you assigned to each launch template override, launching the highest priority first.

      Default: lowest-price

      See Also:

    • capacityReservationOptions

      public final CapacityReservationOptions capacityReservationOptions()

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

      Supported only for fleets of type instant.

      Returns:
      The strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.

      Supported only for fleets of type instant.

    • singleInstanceType

      public final Boolean singleInstanceType()

      Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the fleet.

      Supported only for fleets of type instant.

      Returns:
      Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the fleet.

      Supported only for fleets of type instant.

    • singleAvailabilityZone

      public final Boolean singleAvailabilityZone()

      Indicates that the fleet launches all On-Demand Instances into a single Availability Zone.

      Supported only for fleets of type instant.

      Returns:
      Indicates that the fleet launches all On-Demand Instances into a single Availability Zone.

      Supported only for fleets of type instant.

    • minTargetCapacity

      public final Integer minTargetCapacity()

      The minimum target capacity for On-Demand Instances in the fleet. If this minimum capacity isn't reached, no instances are launched.

      Constraints: Maximum value of 1000. Supported only for fleets of type instant.

      At least one of the following must be specified: SingleAvailabilityZone | SingleInstanceType

      Returns:
      The minimum target capacity for On-Demand Instances in the fleet. If this minimum capacity isn't reached, no instances are launched.

      Constraints: Maximum value of 1000. Supported only for fleets of type instant.

      At least one of the following must be specified: SingleAvailabilityZone | SingleInstanceType

    • maxTotalPrice

      public final String maxTotalPrice()

      The maximum amount per hour for On-Demand Instances that you're willing to pay.

      If your fleet includes T instances that are configured as unlimited, and if their average CPU usage exceeds the baseline utilization, you will incur a charge for surplus credits. The maxTotalPrice does not account for surplus credits, and, if you use surplus credits, your final cost might be higher than what you specified for maxTotalPrice. For more information, see Surplus credits can incur charges in the Amazon EC2 User Guide.

      Returns:
      The maximum amount per hour for On-Demand Instances that you're willing to pay.

      If your fleet includes T instances that are configured as unlimited, and if their average CPU usage exceeds the baseline utilization, you will incur a charge for surplus credits. The maxTotalPrice does not account for surplus credits, and, if you use surplus credits, your final cost might be higher than what you specified for maxTotalPrice. For more information, see Surplus credits can incur charges in the Amazon EC2 User Guide.

    • toBuilder

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

    • builder

      public static OnDemandOptions.Builder builder()

    • serializableBuilderClass

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