com.amazonaws.services.ec2.model

Class SpotOptionsRequest

java.lang.Object

com.amazonaws.services.ec2.model.SpotOptionsRequest

All Implemented Interfaces:

Serializable, Cloneable

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
SpotOptionsRequest()

Method Summary

Modifier and Type	Method and Description
SpotOptionsRequest	clone()
boolean	equals(Object obj)
String	getAllocationStrategy() Indicates 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) Indicates 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) Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet.
SpotOptionsRequest	withAllocationStrategy(String allocationStrategy) Indicates 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.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SpotOptionsRequest

public SpotOptionsRequest()

Method Detail

setAllocationStrategy

public void setAllocationStrategy(String 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 (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.

Parameters:

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

See Also:

SpotAllocationStrategy

getAllocationStrategy

public String getAllocationStrategy()

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

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

See Also:

SpotAllocationStrategy

withAllocationStrategy

public SpotOptionsRequest withAllocationStrategy(String 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 (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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SpotAllocationStrategy

withAllocationStrategy

public SpotOptionsRequest withAllocationStrategy(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 (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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SpotAllocationStrategy

setMaintenanceStrategies

public void setMaintenanceStrategies(FleetSpotMaintenanceStrategiesRequest maintenanceStrategies)

The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.

Parameters:

maintenanceStrategies - The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.

getMaintenanceStrategies

public FleetSpotMaintenanceStrategiesRequest getMaintenanceStrategies()

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.

withMaintenanceStrategies

public SpotOptionsRequest withMaintenanceStrategies(FleetSpotMaintenanceStrategiesRequest maintenanceStrategies)

The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.

Parameters:

maintenanceStrategies - The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.

Returns:

Returns a reference to this object so that method calls can be chained together.

setInstanceInterruptionBehavior

public void setInstanceInterruptionBehavior(String instanceInterruptionBehavior)

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

Parameters:

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

See Also:

SpotInstanceInterruptionBehavior

getInstanceInterruptionBehavior

public String getInstanceInterruptionBehavior()

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

Returns:

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

See Also:

SpotInstanceInterruptionBehavior

withInstanceInterruptionBehavior

public SpotOptionsRequest withInstanceInterruptionBehavior(String instanceInterruptionBehavior)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SpotInstanceInterruptionBehavior

withInstanceInterruptionBehavior

public SpotOptionsRequest withInstanceInterruptionBehavior(SpotInstanceInterruptionBehavior instanceInterruptionBehavior)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SpotInstanceInterruptionBehavior

setInstancePoolsToUseCount

public void setInstancePoolsToUseCount(Integer instancePoolsToUseCount)

The number of Spot pools across which to allocate your target Spot capacity. Valid 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.

Parameters:

instancePoolsToUseCount - The number of Spot pools across which to allocate your target Spot capacity. Valid 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.

getInstancePoolsToUseCount

public Integer getInstancePoolsToUseCount()

The number of Spot pools across which to allocate your target Spot capacity. Valid 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.

Returns:

The number of Spot pools across which to allocate your target Spot capacity. Valid 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.

withInstancePoolsToUseCount

public SpotOptionsRequest withInstancePoolsToUseCount(Integer instancePoolsToUseCount)

The number of Spot pools across which to allocate your target Spot capacity. Valid 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.

Parameters:

instancePoolsToUseCount - The number of Spot pools across which to allocate your target Spot capacity. Valid 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setSingleInstanceType

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.

Parameters:

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.

getSingleInstanceType

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.

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.

withSingleInstanceType

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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

isSingleInstanceType

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.

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.

setSingleAvailabilityZone

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.

Parameters:

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

getSingleAvailabilityZone

public Boolean getSingleAvailabilityZone()

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.

withSingleAvailabilityZone

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

isSingleAvailabilityZone

public Boolean isSingleAvailabilityZone()

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.

setMinTargetCapacity

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.

Parameters:

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

getMinTargetCapacity

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.

Returns:

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

withMinTargetCapacity

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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setMaxTotalPrice

public void setMaxTotalPrice(String maxTotalPrice)

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

Parameters:

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

getMaxTotalPrice

public String getMaxTotalPrice()

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.

withMaxTotalPrice

public SpotOptionsRequest withMaxTotalPrice(String maxTotalPrice)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public SpotOptionsRequest clone()

Overrides:

clone in class Object