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 capacity across the Spot pools specified by the Spot Fleet request.
String	allocationStrategyAsString() Indicates how to allocate the target capacity across the Spot pools specified by the Spot Fleet request.
static SpotOptions.Builder	builder()
boolean	equals(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.
Integer	minTargetCapacity() The minimum target capacity for Spot Instances in the fleet.
List<SdkField<?>>	sdkFields()
static Class<? extends SpotOptions.Builder>	serializableBuilderClass()
Boolean	singleInstanceType() Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet.
SpotOptions.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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 SpotAllocationStrategy allocationStrategy()

Indicates how to allocate the target capacity across the Spot pools specified by the Spot Fleet request. The default is lowest-price.

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 capacity across the Spot pools specified by the Spot Fleet request. The default is lowest-price.

See Also:

SpotAllocationStrategy

allocationStrategyAsString

public String allocationStrategyAsString()

Indicates how to allocate the target capacity across the Spot pools specified by the Spot Fleet request. The default is lowest-price.

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 capacity across the Spot pools specified by the Spot Fleet request. The default is lowest-price.

See Also:

SpotAllocationStrategy

instanceInterruptionBehavior

public 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 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 Integer instancePoolsToUseCount()

The number of Spot pools across which to allocate your target Spot capacity. Valid only when AllocationStrategy is set to lowestPrice. 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 lowestPrice. 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 Boolean singleInstanceType()

Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet.

Returns:

Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet.

minTargetCapacity

public 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.

toBuilder

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

Returns:

a builder for type T

builder

public static SpotOptions.Builder builder()

serializableBuilderClass

public static Class<? extends SpotOptions.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public 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.