software.amazon.awssdk.services.ec2.model

Class OnDemandOptionsRequest

java.lang.Object

software.amazon.awssdk.services.ec2.model.OnDemandOptionsRequest

All Implemented Interfaces:

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

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

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	OnDemandOptionsRequest.Builder

Method Summary

Modifier and Type	Method and Description
FleetOnDemandAllocationStrategy	allocationStrategy() The order of the launch template overrides to use in fulfilling On-Demand capacity.
String	allocationStrategyAsString() The order of the launch template overrides to use in fulfilling On-Demand capacity.
static OnDemandOptionsRequest.Builder	builder()
CapacityReservationOptionsRequest	capacityReservationOptions() The strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	maxTotalPrice() The maximum amount per hour for On-Demand Instances that you're willing to pay.
Integer	minTargetCapacity() The minimum target capacity for On-Demand Instances in the fleet.
List<SdkField<?>>	sdkFields()
static Class<? extends OnDemandOptionsRequest.Builder>	serializableBuilderClass()
Boolean	singleAvailabilityZone() Indicates that the fleet launches all On-Demand Instances into a single Availability Zone.
Boolean	singleInstanceType() Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the fleet.
OnDemandOptionsRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

allocationStrategy

public final FleetOnDemandAllocationStrategy allocationStrategy()

The order of the launch template overrides to use in fulfilling On-Demand capacity. If you specify lowest-price, EC2 Fleet uses price to determine the order, launching the lowest price first. If you specify prioritized, EC2 Fleet uses the priority that you assigned to each launch template override, launching the highest priority first. If you do not specify a value, EC2 Fleet defaults to 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 order of the launch template overrides to use in fulfilling On-Demand capacity. If you specify lowest-price, EC2 Fleet uses price to determine the order, launching the lowest price first. If you specify prioritized, EC2 Fleet uses the priority that you assigned to each launch template override, launching the highest priority first. If you do not specify a value, EC2 Fleet defaults to lowest-price.

See Also:

FleetOnDemandAllocationStrategy

allocationStrategyAsString

public final String allocationStrategyAsString()

The order of the launch template overrides to use in fulfilling On-Demand capacity. If you specify lowest-price, EC2 Fleet uses price to determine the order, launching the lowest price first. If you specify prioritized, EC2 Fleet uses the priority that you assigned to each launch template override, launching the highest priority first. If you do not specify a value, EC2 Fleet defaults to 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 order of the launch template overrides to use in fulfilling On-Demand capacity. If you specify lowest-price, EC2 Fleet uses price to determine the order, launching the lowest price first. If you specify prioritized, EC2 Fleet uses the priority that you assigned to each launch template override, launching the highest priority first. If you do not specify a value, EC2 Fleet defaults to lowest-price.

See Also:

FleetOnDemandAllocationStrategy

capacityReservationOptions

public final CapacityReservationOptionsRequest 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 the minimum target capacity is not reached, the fleet launches no instances.

Returns:

The minimum target capacity for On-Demand Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances.

maxTotalPrice

public final String maxTotalPrice()

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

Returns:

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

toBuilder

public OnDemandOptionsRequest.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<OnDemandOptionsRequest.Builder,OnDemandOptionsRequest>

Returns:

a builder for type T

builder

public static OnDemandOptionsRequest.Builder builder()

serializableBuilderClass

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