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 capacity across the Spot pools specified by the Spot Fleet request.
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.
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 capacity across the Spot pools specified by the Spot Fleet request.
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	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 capacity across the Spot pools specified by the Spot Fleet request.
SpotOptionsRequest	withAllocationStrategy(String allocationStrategy) Indicates how to allocate the target capacity across the Spot pools specified by the Spot Fleet request.
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	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 capacity across the Spot pools specified by the Spot Fleet request. The default is lowestPrice.

Parameters:

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

See Also:

SpotAllocationStrategy

getAllocationStrategy

public String getAllocationStrategy()

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

Returns:

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

See Also:

SpotAllocationStrategy

withAllocationStrategy

public SpotOptionsRequest withAllocationStrategy(String allocationStrategy)

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

Parameters:

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

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

Parameters:

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

Returns:

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

See Also:

SpotAllocationStrategy

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.

Parameters:

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

getSingleInstanceType

public Boolean getSingleInstanceType()

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.

withSingleInstanceType

public SpotOptionsRequest withSingleInstanceType(Boolean singleInstanceType)

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

Parameters:

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

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.

Returns:

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

setSingleAvailabilityZone

public void setSingleAvailabilityZone(Boolean singleAvailabilityZone)

Indicates that the fleet launches all Spot Instances into a single Availability Zone.

Parameters:

singleAvailabilityZone - Indicates that the fleet launches all Spot Instances into a single Availability Zone.

getSingleAvailabilityZone

public Boolean getSingleAvailabilityZone()

Indicates that the fleet launches all Spot Instances into a single Availability Zone.

Returns:

Indicates that the fleet launches all Spot Instances into a single Availability Zone.

withSingleAvailabilityZone

public SpotOptionsRequest withSingleAvailabilityZone(Boolean singleAvailabilityZone)

Indicates that the fleet launches all Spot Instances into a single Availability Zone.

Parameters:

singleAvailabilityZone - Indicates that the fleet launches all Spot Instances into a single Availability Zone.

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.

Returns:

Indicates that the fleet launches all Spot Instances into a single Availability Zone.

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.

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