@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class SpotOptionsRequest extends Object implements Serializable, Cloneable
Describes the configuration of Spot Instances in an EC2 Fleet request.
Constructor and Description |
---|
SpotOptionsRequest() |
Modifier and Type | Method and Description |
---|---|
SpotOptionsRequest |
clone() |
boolean |
equals(Object obj) |
String |
getAllocationStrategy()
The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools
specified by the EC2 Fleet.
|
String |
getInstanceInterruptionBehavior()
The behavior when a Spot Instance is interrupted.
|
Integer |
getInstancePoolsToUseCount()
The number of Spot pools across which to allocate your target Spot capacity.
|
FleetSpotMaintenanceStrategiesRequest |
getMaintenanceStrategies()
The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.
|
String |
getMaxTotalPrice()
The maximum amount per hour for Spot Instances that you're willing to pay.
|
Integer |
getMinTargetCapacity()
The minimum target capacity for Spot Instances in the fleet.
|
Boolean |
getSingleAvailabilityZone()
Indicates that the fleet launches all Spot Instances into a single Availability Zone.
|
Boolean |
getSingleInstanceType()
Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet.
|
int |
hashCode() |
Boolean |
isSingleAvailabilityZone()
Indicates that the fleet launches all Spot Instances into a single Availability Zone.
|
Boolean |
isSingleInstanceType()
Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet.
|
void |
setAllocationStrategy(String allocationStrategy)
The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools
specified by the EC2 Fleet.
|
void |
setInstanceInterruptionBehavior(String instanceInterruptionBehavior)
The behavior when a Spot Instance is interrupted.
|
void |
setInstancePoolsToUseCount(Integer instancePoolsToUseCount)
The number of Spot pools across which to allocate your target Spot capacity.
|
void |
setMaintenanceStrategies(FleetSpotMaintenanceStrategiesRequest maintenanceStrategies)
The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.
|
void |
setMaxTotalPrice(String maxTotalPrice)
The maximum amount per hour for Spot Instances that you're willing to pay.
|
void |
setMinTargetCapacity(Integer minTargetCapacity)
The minimum target capacity for Spot Instances in the fleet.
|
void |
setSingleAvailabilityZone(Boolean singleAvailabilityZone)
Indicates that the fleet launches all Spot Instances into a single Availability Zone.
|
void |
setSingleInstanceType(Boolean singleInstanceType)
Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet.
|
String |
toString()
Returns a string representation of this object.
|
SpotOptionsRequest |
withAllocationStrategy(SpotAllocationStrategy allocationStrategy)
The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools
specified by the EC2 Fleet.
|
SpotOptionsRequest |
withAllocationStrategy(String allocationStrategy)
The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools
specified by the EC2 Fleet.
|
SpotOptionsRequest |
withInstanceInterruptionBehavior(SpotInstanceInterruptionBehavior instanceInterruptionBehavior)
The behavior when a Spot Instance is interrupted.
|
SpotOptionsRequest |
withInstanceInterruptionBehavior(String instanceInterruptionBehavior)
The behavior when a Spot Instance is interrupted.
|
SpotOptionsRequest |
withInstancePoolsToUseCount(Integer instancePoolsToUseCount)
The number of Spot pools across which to allocate your target Spot capacity.
|
SpotOptionsRequest |
withMaintenanceStrategies(FleetSpotMaintenanceStrategiesRequest maintenanceStrategies)
The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.
|
SpotOptionsRequest |
withMaxTotalPrice(String maxTotalPrice)
The maximum amount per hour for Spot Instances that you're willing to pay.
|
SpotOptionsRequest |
withMinTargetCapacity(Integer minTargetCapacity)
The minimum target capacity for Spot Instances in the fleet.
|
SpotOptionsRequest |
withSingleAvailabilityZone(Boolean singleAvailabilityZone)
Indicates that the fleet launches all Spot Instances into a single Availability Zone.
|
SpotOptionsRequest |
withSingleInstanceType(Boolean singleInstanceType)
Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet.
|
public void setAllocationStrategy(String allocationStrategy)
The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet.
lowest-price
- EC2 Fleet launches instances from the Spot Instance pools with the lowest price.
diversified
- EC2 Fleet launches instances from all of the Spot Instance pools that you specify.
capacity-optimized
(recommended) - EC2 Fleet launches instances from Spot Instance pools with
optimal capacity for the number of instances that are launching. 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 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.
Default: lowest-price
allocationStrategy
- The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance
pools specified by the EC2 Fleet.
lowest-price
- EC2 Fleet launches instances from the Spot Instance pools with the lowest
price.
diversified
- EC2 Fleet launches instances from all of the Spot Instance pools that you
specify.
capacity-optimized
(recommended) - EC2 Fleet launches instances from Spot Instance pools with
optimal capacity for the number of instances that are launching. 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 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.
Default: lowest-price
SpotAllocationStrategy
public String getAllocationStrategy()
The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet.
lowest-price
- EC2 Fleet launches instances from the Spot Instance pools with the lowest price.
diversified
- EC2 Fleet launches instances from all of the Spot Instance pools that you specify.
capacity-optimized
(recommended) - EC2 Fleet launches instances from Spot Instance pools with
optimal capacity for the number of instances that are launching. 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 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.
Default: lowest-price
lowest-price
- EC2 Fleet launches instances from the Spot Instance pools with the lowest
price.
diversified
- EC2 Fleet launches instances from all of the Spot Instance pools that you
specify.
capacity-optimized
(recommended) - EC2 Fleet launches instances from Spot Instance pools
with optimal capacity for the number of instances that are launching. 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 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.
Default: lowest-price
SpotAllocationStrategy
public SpotOptionsRequest withAllocationStrategy(String allocationStrategy)
The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet.
lowest-price
- EC2 Fleet launches instances from the Spot Instance pools with the lowest price.
diversified
- EC2 Fleet launches instances from all of the Spot Instance pools that you specify.
capacity-optimized
(recommended) - EC2 Fleet launches instances from Spot Instance pools with
optimal capacity for the number of instances that are launching. 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 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.
Default: lowest-price
allocationStrategy
- The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance
pools specified by the EC2 Fleet.
lowest-price
- EC2 Fleet launches instances from the Spot Instance pools with the lowest
price.
diversified
- EC2 Fleet launches instances from all of the Spot Instance pools that you
specify.
capacity-optimized
(recommended) - EC2 Fleet launches instances from Spot Instance pools with
optimal capacity for the number of instances that are launching. 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 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.
Default: lowest-price
SpotAllocationStrategy
public SpotOptionsRequest withAllocationStrategy(SpotAllocationStrategy allocationStrategy)
The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet.
lowest-price
- EC2 Fleet launches instances from the Spot Instance pools with the lowest price.
diversified
- EC2 Fleet launches instances from all of the Spot Instance pools that you specify.
capacity-optimized
(recommended) - EC2 Fleet launches instances from Spot Instance pools with
optimal capacity for the number of instances that are launching. 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 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.
Default: lowest-price
allocationStrategy
- The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance
pools specified by the EC2 Fleet.
lowest-price
- EC2 Fleet launches instances from the Spot Instance pools with the lowest
price.
diversified
- EC2 Fleet launches instances from all of the Spot Instance pools that you
specify.
capacity-optimized
(recommended) - EC2 Fleet launches instances from Spot Instance pools with
optimal capacity for the number of instances that are launching. 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 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.
Default: lowest-price
SpotAllocationStrategy
public void setMaintenanceStrategies(FleetSpotMaintenanceStrategiesRequest maintenanceStrategies)
The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.
maintenanceStrategies
- The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.public FleetSpotMaintenanceStrategiesRequest getMaintenanceStrategies()
The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.
public SpotOptionsRequest withMaintenanceStrategies(FleetSpotMaintenanceStrategiesRequest maintenanceStrategies)
The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.
maintenanceStrategies
- The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.public void setInstanceInterruptionBehavior(String instanceInterruptionBehavior)
The behavior when a Spot Instance is interrupted.
Default: terminate
instanceInterruptionBehavior
- The behavior when a Spot Instance is interrupted.
Default: terminate
SpotInstanceInterruptionBehavior
public String getInstanceInterruptionBehavior()
The behavior when a Spot Instance is interrupted.
Default: terminate
Default: terminate
SpotInstanceInterruptionBehavior
public SpotOptionsRequest withInstanceInterruptionBehavior(String instanceInterruptionBehavior)
The behavior when a Spot Instance is interrupted.
Default: terminate
instanceInterruptionBehavior
- The behavior when a Spot Instance is interrupted.
Default: terminate
SpotInstanceInterruptionBehavior
public SpotOptionsRequest withInstanceInterruptionBehavior(SpotInstanceInterruptionBehavior instanceInterruptionBehavior)
The behavior when a Spot Instance is interrupted.
Default: terminate
instanceInterruptionBehavior
- The behavior when a Spot Instance is interrupted.
Default: terminate
SpotInstanceInterruptionBehavior
public void setInstancePoolsToUseCount(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.
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.
public Integer getInstancePoolsToUseCount()
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.
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.
public SpotOptionsRequest withInstancePoolsToUseCount(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.
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.
public void setSingleInstanceType(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
.
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
.
public Boolean getSingleInstanceType()
Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet.
Supported only for fleets of type instant
.
Supported only for fleets of type instant
.
public SpotOptionsRequest withSingleInstanceType(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
.
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
.
public Boolean isSingleInstanceType()
Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet.
Supported only for fleets of type instant
.
Supported only for fleets of type instant
.
public void setSingleAvailabilityZone(Boolean singleAvailabilityZone)
Indicates that the fleet launches all Spot Instances into a single Availability Zone.
Supported only for fleets of type instant
.
singleAvailabilityZone
- Indicates that the fleet launches all Spot Instances into a single Availability Zone.
Supported only for fleets of type instant
.
public Boolean getSingleAvailabilityZone()
Indicates that the fleet launches all Spot Instances into a single Availability Zone.
Supported only for fleets of type instant
.
Supported only for fleets of type instant
.
public SpotOptionsRequest withSingleAvailabilityZone(Boolean singleAvailabilityZone)
Indicates that the fleet launches all Spot Instances into a single Availability Zone.
Supported only for fleets of type instant
.
singleAvailabilityZone
- Indicates that the fleet launches all Spot Instances into a single Availability Zone.
Supported only for fleets of type instant
.
public Boolean isSingleAvailabilityZone()
Indicates that the fleet launches all Spot Instances into a single Availability Zone.
Supported only for fleets of type instant
.
Supported only for fleets of type instant
.
public void setMinTargetCapacity(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
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
public Integer getMinTargetCapacity()
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
Supported only for fleets of type instant
.
At least one of the following must be specified: SingleAvailabilityZone
|
SingleInstanceType
public SpotOptionsRequest withMinTargetCapacity(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
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
public void setMaxTotalPrice(String maxTotalPrice)
The maximum amount per hour for Spot Instances that you're willing to pay.
maxTotalPrice
- The maximum amount per hour for Spot Instances that you're willing to pay.public String getMaxTotalPrice()
The maximum amount per hour for Spot Instances that you're willing to pay.
public SpotOptionsRequest withMaxTotalPrice(String maxTotalPrice)
The maximum amount per hour for Spot Instances that you're willing to pay.
maxTotalPrice
- The maximum amount per hour for Spot Instances that you're willing to pay.public String toString()
toString
in class Object
Object.toString()
public SpotOptionsRequest clone()