SpotOptionsRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.ec2.model.SpotOptionsRequest

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<SpotOptionsRequest.Builder,SpotOptionsRequest>

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

Describes the configuration of Spot Instances in an EC2 Fleet request.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface SpotOptionsRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`SpotOptionsRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SpotAllocationStrategy`	`allocationStrategy()` The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet launch configuration.
`String`	`allocationStrategyAsString()` The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet launch configuration.
`static SpotOptionsRequest.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.
`FleetSpotMaintenanceStrategiesRequest`	`maintenanceStrategies()` The strategies for managing your Spot Instances that are at an elevated risk of being 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 SpotOptionsRequest.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.
`SpotOptionsRequest.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()
```
    The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet launch configuration. For more information, see Allocation strategies for Spot Instances in the Amazon EC2 User Guide.
    
    price-capacity-optimized (recommended)
    
    EC2 Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. EC2 Fleet then requests Spot Instances from the lowest priced of these pools.
    
    capacity-optimized
    
    EC2 Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. To give certain instance types a higher chance of launching first, use capacity-optimized-prioritized. Set a priority for each instance type by using the Priority parameter for LaunchTemplateOverrides. You can assign the same priority to different LaunchTemplateOverrides. EC2 implements the priorities on a best-effort basis, but optimizes for capacity first. capacity-optimized-prioritized is supported only if your EC2 Fleet uses a launch template. Note that if the On-Demand AllocationStrategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity.
    
    diversified
    
    EC2 Fleet requests instances from all of the Spot Instance pools that you specify.
    
    lowest-price
    
    EC2 Fleet requests instances from the lowest priced Spot Instance pool that has available capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances come from the next lowest priced pool that has available capacity. If a pool runs out of capacity before fulfilling your desired capacity, EC2 Fleet will continue to fulfill your request by drawing from the next lowest priced pool. To ensure that your desired capacity is met, you might receive Spot Instances from several pools. Because this strategy only considers instance price and not capacity availability, it might lead to high interruption rates.
    
    Default: 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:
    
    The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet launch configuration. For more information, see Allocation strategies for Spot Instances in the Amazon EC2 User Guide.
    
    price-capacity-optimized (recommended)
    
    EC2 Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. EC2 Fleet then requests Spot Instances from the lowest priced of these pools.
    
    capacity-optimized
    
    EC2 Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. To give certain instance types a higher chance of launching first, use capacity-optimized-prioritized. Set a priority for each instance type by using the Priority parameter for LaunchTemplateOverrides. You can assign the same priority to different LaunchTemplateOverrides. EC2 implements the priorities on a best-effort basis, but optimizes for capacity first. capacity-optimized-prioritized is supported only if your EC2 Fleet uses a launch template. Note that if the On-Demand AllocationStrategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity.
    
    diversified
    
    EC2 Fleet requests instances from all of the Spot Instance pools that you specify.
    
    lowest-price
    
    EC2 Fleet requests instances from the lowest priced Spot Instance pool that has available capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances come from the next lowest priced pool that has available capacity. If a pool runs out of capacity before fulfilling your desired capacity, EC2 Fleet will continue to fulfill your request by drawing from the next lowest priced pool. To ensure that your desired capacity is met, you might receive Spot Instances from several pools. Because this strategy only considers instance price and not capacity availability, it might lead to high interruption rates.
    
    Default: lowest-price
    
    See Also:
    
    SpotAllocationStrategy
  - allocationStrategyAsString
```
public final String allocationStrategyAsString()
```
    The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet launch configuration. For more information, see Allocation strategies for Spot Instances in the Amazon EC2 User Guide.
    
    price-capacity-optimized (recommended)
    
    EC2 Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. EC2 Fleet then requests Spot Instances from the lowest priced of these pools.
    
    capacity-optimized
    
    EC2 Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. To give certain instance types a higher chance of launching first, use capacity-optimized-prioritized. Set a priority for each instance type by using the Priority parameter for LaunchTemplateOverrides. You can assign the same priority to different LaunchTemplateOverrides. EC2 implements the priorities on a best-effort basis, but optimizes for capacity first. capacity-optimized-prioritized is supported only if your EC2 Fleet uses a launch template. Note that if the On-Demand AllocationStrategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity.
    
    diversified
    
    EC2 Fleet requests instances from all of the Spot Instance pools that you specify.
    
    lowest-price
    
    EC2 Fleet requests instances from the lowest priced Spot Instance pool that has available capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances come from the next lowest priced pool that has available capacity. If a pool runs out of capacity before fulfilling your desired capacity, EC2 Fleet will continue to fulfill your request by drawing from the next lowest priced pool. To ensure that your desired capacity is met, you might receive Spot Instances from several pools. Because this strategy only considers instance price and not capacity availability, it might lead to high interruption rates.
    
    Default: 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:
    
    The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet launch configuration. For more information, see Allocation strategies for Spot Instances in the Amazon EC2 User Guide.
    
    price-capacity-optimized (recommended)
    
    EC2 Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. EC2 Fleet then requests Spot Instances from the lowest priced of these pools.
    
    capacity-optimized
    
    EC2 Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. To give certain instance types a higher chance of launching first, use capacity-optimized-prioritized. Set a priority for each instance type by using the Priority parameter for LaunchTemplateOverrides. You can assign the same priority to different LaunchTemplateOverrides. EC2 implements the priorities on a best-effort basis, but optimizes for capacity first. capacity-optimized-prioritized is supported only if your EC2 Fleet uses a launch template. Note that if the On-Demand AllocationStrategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity.
    
    diversified
    
    EC2 Fleet requests instances from all of the Spot Instance pools that you specify.
    
    lowest-price
    
    EC2 Fleet requests instances from the lowest priced Spot Instance pool that has available capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances come from the next lowest priced pool that has available capacity. If a pool runs out of capacity before fulfilling your desired capacity, EC2 Fleet will continue to fulfill your request by drawing from the next lowest priced pool. To ensure that your desired capacity is met, you might receive Spot Instances from several pools. Because this strategy only considers instance price and not capacity availability, it might lead to high interruption rates.
    
    Default: lowest-price
    
    See Also:
    
    SpotAllocationStrategy
  - maintenanceStrategies
```
public final FleetSpotMaintenanceStrategiesRequest maintenanceStrategies()
```
    The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.
    
    Returns:
    
    The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.
  - instanceInterruptionBehavior
```
public final SpotInstanceInterruptionBehavior instanceInterruptionBehavior()
```
    The behavior when a Spot Instance is interrupted.
    
    Default: 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.
    
    Default: terminate
    
    See Also:
    
    SpotInstanceInterruptionBehavior
  - instanceInterruptionBehaviorAsString
```
public final String instanceInterruptionBehaviorAsString()
```
    The behavior when a Spot Instance is interrupted.
    
    Default: 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.
    
    Default: terminate
    
    See Also:
    
    SpotInstanceInterruptionBehavior
  - instancePoolsToUseCount
```
public final Integer instancePoolsToUseCount()
```
    The number of Spot pools across which to allocate your target Spot capacity. Supported only when Spot 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.
    
    Note that EC2 Fleet attempts to draw Spot Instances from the number of pools that you specify on a best effort basis. If a pool runs out of Spot capacity before fulfilling your target capacity, EC2 Fleet will continue to fulfill your request by drawing from the next cheapest pool. To ensure that your target capacity is met, you might receive Spot Instances from more than the number of pools that you specified. Similarly, if most of the pools have no Spot capacity, you might receive your full target capacity from fewer than the number of pools that you specified.
    
    Returns:
    
    The number of Spot pools across which to allocate your target Spot capacity. Supported only when Spot 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.
    
    Note that EC2 Fleet attempts to draw Spot Instances from the number of pools that you specify on a best effort basis. If a pool runs out of Spot capacity before fulfilling your target capacity, EC2 Fleet will continue to fulfill your request by drawing from the next cheapest pool. To ensure that your target capacity is met, you might receive Spot Instances from more than the number of pools that you specified. Similarly, if most of the pools have no Spot capacity, you might receive your full target capacity from fewer than the number of pools that you specified.
  - 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.
    
    Supported only for fleets of type instant.
    
    At least one of the following must be specified: SingleAvailabilityZone | SingleInstanceType
    
    Returns:
    
    The minimum target capacity for Spot Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances.
    
    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 Spot Instances that you're willing to pay. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
    
    If you specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter.
    
    Returns:
    
    The maximum amount per hour for Spot Instances that you're willing to pay. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
    
    If you specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter.
  - toBuilder
```
public SpotOptionsRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<SpotOptionsRequest.Builder,SpotOptionsRequest>
  - builder
```
public static SpotOptionsRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends SpotOptionsRequest.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

Class SpotOptionsRequest

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

allocationStrategy

allocationStrategyAsString

maintenanceStrategies

instanceInterruptionBehavior

instanceInterruptionBehaviorAsString

instancePoolsToUseCount

singleInstanceType

singleAvailabilityZone

minTargetCapacity

maxTotalPrice

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields