software.amazon.awssdk.services.ec2.model

Class SpotOptions

java.lang.Object

software.amazon.awssdk.services.ec2.model.SpotOptions

All Implemented Interfaces:

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

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

Describes the configuration of Spot Instances in an EC2 Fleet.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SpotOptions.Builder

Method Summary

Modifier and Type	Method and Description
SpotAllocationStrategy	allocationStrategy() Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet.
String	allocationStrategyAsString() Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet.
static SpotOptions.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
SpotInstanceInterruptionBehavior	instanceInterruptionBehavior() The behavior when a Spot Instance is interrupted.
String	instanceInterruptionBehaviorAsString() The behavior when a Spot Instance is interrupted.
Integer	instancePoolsToUseCount() The number of Spot pools across which to allocate your target Spot capacity.
FleetSpotMaintenanceStrategies	maintenanceStrategies() The strategies for managing your workloads on your Spot Instances that will be interrupted.
String	maxTotalPrice() The maximum amount per hour for Spot Instances that you're willing to pay.
Integer	minTargetCapacity() The minimum target capacity for Spot Instances in the fleet.
List<SdkField<?>>	sdkFields()
static Class<? extends SpotOptions.Builder>	serializableBuilderClass()
Boolean	singleAvailabilityZone() Indicates that the fleet launches all Spot Instances into a single Availability Zone.
Boolean	singleInstanceType() Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet.
SpotOptions.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

allocationStrategy

public final SpotAllocationStrategy allocationStrategy()

Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet.

If the allocation strategy is lowest-price, EC2 Fleet launches instances from the Spot Instance pools with the lowest price. This is the default allocation strategy.

If the allocation strategy is diversified, EC2 Fleet launches instances from all of the Spot Instance pools that you specify.

If the allocation strategy is capacity-optimized, EC2 Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching.

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

Returns:

Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet.

If the allocation strategy is lowest-price, EC2 Fleet launches instances from the Spot Instance pools with the lowest price. This is the default allocation strategy.

If the allocation strategy is diversified, EC2 Fleet launches instances from all of the Spot Instance pools that you specify.

If the allocation strategy is capacity-optimized, EC2 Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching.

See Also:

SpotAllocationStrategy

allocationStrategyAsString

public final String allocationStrategyAsString()

Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet.

If the allocation strategy is lowest-price, EC2 Fleet launches instances from the Spot Instance pools with the lowest price. This is the default allocation strategy.

If the allocation strategy is diversified, EC2 Fleet launches instances from all of the Spot Instance pools that you specify.

If the allocation strategy is capacity-optimized, EC2 Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching.

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

Returns:

Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet.

If the allocation strategy is lowest-price, EC2 Fleet launches instances from the Spot Instance pools with the lowest price. This is the default allocation strategy.

If the allocation strategy is diversified, EC2 Fleet launches instances from all of the Spot Instance pools that you specify.

If the allocation strategy is capacity-optimized, EC2 Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching.

See Also:

SpotAllocationStrategy

maintenanceStrategies

public final FleetSpotMaintenanceStrategies maintenanceStrategies()

The strategies for managing your workloads on your Spot Instances that will be interrupted. Currently only the capacity rebalance strategy is available.

Returns:

The strategies for managing your workloads on your Spot Instances that will be interrupted. Currently only the capacity rebalance strategy is available.

instanceInterruptionBehavior

public final SpotInstanceInterruptionBehavior instanceInterruptionBehavior()

The behavior when a Spot Instance is interrupted. The default is terminate.

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

Returns:

The behavior when a Spot Instance is interrupted. The default is terminate.

See Also:

SpotInstanceInterruptionBehavior

instanceInterruptionBehaviorAsString

public final String instanceInterruptionBehaviorAsString()

The behavior when a Spot Instance is interrupted. The default is terminate.

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

Returns:

The behavior when a Spot Instance is interrupted. The default is terminate.

See Also:

SpotInstanceInterruptionBehavior

instancePoolsToUseCount

public final Integer instancePoolsToUseCount()

The number of Spot pools across which to allocate your target Spot capacity. Valid only when AllocationStrategy is set to lowest-price. EC2 Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify.

Returns:

The number of Spot pools across which to allocate your target Spot capacity. Valid only when AllocationStrategy is set to lowest-price. EC2 Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify.

singleInstanceType

public final Boolean singleInstanceType()

Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet. Supported only for fleets of type instant.

Returns:

Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet. Supported only for fleets of type instant.

singleAvailabilityZone

public final Boolean singleAvailabilityZone()

Indicates that the fleet launches all Spot Instances into a single Availability Zone. Supported only for fleets of type instant.

Returns:

Indicates that the fleet launches all Spot Instances into a single Availability Zone. Supported only for fleets of type instant.

minTargetCapacity

public final Integer minTargetCapacity()

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

Returns:

The minimum target capacity for Spot 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 Spot Instances that you're willing to pay.

Returns:

The maximum amount per hour for Spot Instances that you're willing to pay.

toBuilder

public SpotOptions.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SpotOptions.Builder,SpotOptions>

builder

public static SpotOptions.Builder builder()

serializableBuilderClass

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