com.amazonaws.services.autoscaling.model

Class InstancesDistribution

java.lang.Object

com.amazonaws.services.autoscaling.model.InstancesDistribution

All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class InstancesDistribution
extends Object
implements Serializable, Cloneable

Describes an instances distribution for an Auto Scaling group with MixedInstancesPolicy.

The instances distribution specifies the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances, and how the Auto Scaling group allocates instance types.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
InstancesDistribution()

Method Summary

Modifier and Type	Method and Description
InstancesDistribution	clone()
boolean	equals(Object obj)
String	getOnDemandAllocationStrategy() Indicates how to allocate instance types to fulfill On-Demand capacity.
Integer	getOnDemandBaseCapacity() The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances.
Integer	getOnDemandPercentageAboveBaseCapacity() Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond OnDemandBaseCapacity.
String	getSpotAllocationStrategy() Indicates how to allocate Spot capacity across Spot pools.
Integer	getSpotInstancePools() The number of Spot pools to use to allocate your Spot capacity.
String	getSpotMaxPrice() The maximum price per unit hour that you are willing to pay for a Spot Instance.
int	hashCode()
void	setOnDemandAllocationStrategy(String onDemandAllocationStrategy) Indicates how to allocate instance types to fulfill On-Demand capacity.
void	setOnDemandBaseCapacity(Integer onDemandBaseCapacity) The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances.
void	setOnDemandPercentageAboveBaseCapacity(Integer onDemandPercentageAboveBaseCapacity) Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond OnDemandBaseCapacity.
void	setSpotAllocationStrategy(String spotAllocationStrategy) Indicates how to allocate Spot capacity across Spot pools.
void	setSpotInstancePools(Integer spotInstancePools) The number of Spot pools to use to allocate your Spot capacity.
void	setSpotMaxPrice(String spotMaxPrice) The maximum price per unit hour that you are willing to pay for a Spot Instance.
String	toString() Returns a string representation of this object.
InstancesDistribution	withOnDemandAllocationStrategy(String onDemandAllocationStrategy) Indicates how to allocate instance types to fulfill On-Demand capacity.
InstancesDistribution	withOnDemandBaseCapacity(Integer onDemandBaseCapacity) The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances.
InstancesDistribution	withOnDemandPercentageAboveBaseCapacity(Integer onDemandPercentageAboveBaseCapacity) Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond OnDemandBaseCapacity.
InstancesDistribution	withSpotAllocationStrategy(String spotAllocationStrategy) Indicates how to allocate Spot capacity across Spot pools.
InstancesDistribution	withSpotInstancePools(Integer spotInstancePools) The number of Spot pools to use to allocate your Spot capacity.
InstancesDistribution	withSpotMaxPrice(String spotMaxPrice) The maximum price per unit hour that you are willing to pay for a Spot Instance.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

InstancesDistribution

public InstancesDistribution()

Method Detail

setOnDemandAllocationStrategy

public void setOnDemandAllocationStrategy(String onDemandAllocationStrategy)

Indicates how to allocate instance types to fulfill On-Demand capacity.

The only valid value is prioritized, which is also the default value. This strategy uses the order of instance type overrides for the LaunchTemplate to define the launch priority of each instance type. The first instance type in the array is prioritized higher than the last. If all your On-Demand capacity cannot be fulfilled using your highest priority instance, then the Auto Scaling groups launches the remaining capacity using the second priority instance type, and so on.

Parameters:

onDemandAllocationStrategy - Indicates how to allocate instance types to fulfill On-Demand capacity.

The only valid value is prioritized, which is also the default value. This strategy uses the order of instance type overrides for the LaunchTemplate to define the launch priority of each instance type. The first instance type in the array is prioritized higher than the last. If all your On-Demand capacity cannot be fulfilled using your highest priority instance, then the Auto Scaling groups launches the remaining capacity using the second priority instance type, and so on.

getOnDemandAllocationStrategy

public String getOnDemandAllocationStrategy()

Indicates how to allocate instance types to fulfill On-Demand capacity.

The only valid value is prioritized, which is also the default value. This strategy uses the order of instance type overrides for the LaunchTemplate to define the launch priority of each instance type. The first instance type in the array is prioritized higher than the last. If all your On-Demand capacity cannot be fulfilled using your highest priority instance, then the Auto Scaling groups launches the remaining capacity using the second priority instance type, and so on.

Returns:

Indicates how to allocate instance types to fulfill On-Demand capacity.

The only valid value is prioritized, which is also the default value. This strategy uses the order of instance type overrides for the LaunchTemplate to define the launch priority of each instance type. The first instance type in the array is prioritized higher than the last. If all your On-Demand capacity cannot be fulfilled using your highest priority instance, then the Auto Scaling groups launches the remaining capacity using the second priority instance type, and so on.

withOnDemandAllocationStrategy

public InstancesDistribution withOnDemandAllocationStrategy(String onDemandAllocationStrategy)

Indicates how to allocate instance types to fulfill On-Demand capacity.

The only valid value is prioritized, which is also the default value. This strategy uses the order of instance type overrides for the LaunchTemplate to define the launch priority of each instance type. The first instance type in the array is prioritized higher than the last. If all your On-Demand capacity cannot be fulfilled using your highest priority instance, then the Auto Scaling groups launches the remaining capacity using the second priority instance type, and so on.

Parameters:

onDemandAllocationStrategy - Indicates how to allocate instance types to fulfill On-Demand capacity.

The only valid value is prioritized, which is also the default value. This strategy uses the order of instance type overrides for the LaunchTemplate to define the launch priority of each instance type. The first instance type in the array is prioritized higher than the last. If all your On-Demand capacity cannot be fulfilled using your highest priority instance, then the Auto Scaling groups launches the remaining capacity using the second priority instance type, and so on.

Returns:

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

setOnDemandBaseCapacity

public void setOnDemandBaseCapacity(Integer onDemandBaseCapacity)

The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances. This base portion is provisioned first as your group scales.

The default value is 0. If you leave this parameter set to 0, On-Demand Instances are launched as a percentage of the Auto Scaling group's desired capacity, per the OnDemandPercentageAboveBaseCapacity setting.

Parameters:

onDemandBaseCapacity - The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances. This base portion is provisioned first as your group scales.

The default value is 0. If you leave this parameter set to 0, On-Demand Instances are launched as a percentage of the Auto Scaling group's desired capacity, per the OnDemandPercentageAboveBaseCapacity setting.

getOnDemandBaseCapacity

public Integer getOnDemandBaseCapacity()

The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances. This base portion is provisioned first as your group scales.

The default value is 0. If you leave this parameter set to 0, On-Demand Instances are launched as a percentage of the Auto Scaling group's desired capacity, per the OnDemandPercentageAboveBaseCapacity setting.

Returns:

The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances. This base portion is provisioned first as your group scales.

The default value is 0. If you leave this parameter set to 0, On-Demand Instances are launched as a percentage of the Auto Scaling group's desired capacity, per the OnDemandPercentageAboveBaseCapacity setting.

withOnDemandBaseCapacity

public InstancesDistribution withOnDemandBaseCapacity(Integer onDemandBaseCapacity)

The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances. This base portion is provisioned first as your group scales.

The default value is 0. If you leave this parameter set to 0, On-Demand Instances are launched as a percentage of the Auto Scaling group's desired capacity, per the OnDemandPercentageAboveBaseCapacity setting.

Parameters:

onDemandBaseCapacity - The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances. This base portion is provisioned first as your group scales.

The default value is 0. If you leave this parameter set to 0, On-Demand Instances are launched as a percentage of the Auto Scaling group's desired capacity, per the OnDemandPercentageAboveBaseCapacity setting.

Returns:

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

setOnDemandPercentageAboveBaseCapacity

public void setOnDemandPercentageAboveBaseCapacity(Integer onDemandPercentageAboveBaseCapacity)

Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond OnDemandBaseCapacity.

The range is 0–100. The default value is 100. If you leave this parameter set to 100, the percentages are 100% for On-Demand Instances and 0% for Spot Instances.

Parameters:

onDemandPercentageAboveBaseCapacity - Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond OnDemandBaseCapacity.

The range is 0–100. The default value is 100. If you leave this parameter set to 100, the percentages are 100% for On-Demand Instances and 0% for Spot Instances.

getOnDemandPercentageAboveBaseCapacity

public Integer getOnDemandPercentageAboveBaseCapacity()

Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond OnDemandBaseCapacity.

The range is 0–100. The default value is 100. If you leave this parameter set to 100, the percentages are 100% for On-Demand Instances and 0% for Spot Instances.

Returns:

Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond OnDemandBaseCapacity.

The range is 0–100. The default value is 100. If you leave this parameter set to 100, the percentages are 100% for On-Demand Instances and 0% for Spot Instances.

withOnDemandPercentageAboveBaseCapacity

public InstancesDistribution withOnDemandPercentageAboveBaseCapacity(Integer onDemandPercentageAboveBaseCapacity)

Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond OnDemandBaseCapacity.

The range is 0–100. The default value is 100. If you leave this parameter set to 100, the percentages are 100% for On-Demand Instances and 0% for Spot Instances.

Parameters:

onDemandPercentageAboveBaseCapacity - Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond OnDemandBaseCapacity.

The range is 0–100. The default value is 100. If you leave this parameter set to 100, the percentages are 100% for On-Demand Instances and 0% for Spot Instances.

Returns:

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

setSpotAllocationStrategy

public void setSpotAllocationStrategy(String spotAllocationStrategy)

Indicates how to allocate Spot capacity across Spot pools.

The only valid value is lowest-price, which is also the default value. The Auto Scaling group selects the cheapest Spot pools and evenly allocates your Spot capacity across the number of Spot pools that you specify.

Parameters:

spotAllocationStrategy - Indicates how to allocate Spot capacity across Spot pools.

The only valid value is lowest-price, which is also the default value. The Auto Scaling group selects the cheapest Spot pools and evenly allocates your Spot capacity across the number of Spot pools that you specify.

getSpotAllocationStrategy

public String getSpotAllocationStrategy()

Indicates how to allocate Spot capacity across Spot pools.

The only valid value is lowest-price, which is also the default value. The Auto Scaling group selects the cheapest Spot pools and evenly allocates your Spot capacity across the number of Spot pools that you specify.

Returns:

Indicates how to allocate Spot capacity across Spot pools.

The only valid value is lowest-price, which is also the default value. The Auto Scaling group selects the cheapest Spot pools and evenly allocates your Spot capacity across the number of Spot pools that you specify.

withSpotAllocationStrategy

public InstancesDistribution withSpotAllocationStrategy(String spotAllocationStrategy)

Indicates how to allocate Spot capacity across Spot pools.

The only valid value is lowest-price, which is also the default value. The Auto Scaling group selects the cheapest Spot pools and evenly allocates your Spot capacity across the number of Spot pools that you specify.

Parameters:

spotAllocationStrategy - Indicates how to allocate Spot capacity across Spot pools.

The only valid value is lowest-price, which is also the default value. The Auto Scaling group selects the cheapest Spot pools and evenly allocates your 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.

setSpotInstancePools

public void setSpotInstancePools(Integer spotInstancePools)

The number of Spot pools to use to allocate your Spot capacity. The Spot pools are determined from the different instance types in the Overrides array of LaunchTemplate.

The range is 1–20 and the default is 2.

Parameters:

spotInstancePools - The number of Spot pools to use to allocate your Spot capacity. The Spot pools are determined from the different instance types in the Overrides array of LaunchTemplate.

The range is 1–20 and the default is 2.

getSpotInstancePools

public Integer getSpotInstancePools()

The number of Spot pools to use to allocate your Spot capacity. The Spot pools are determined from the different instance types in the Overrides array of LaunchTemplate.

The range is 1–20 and the default is 2.

Returns:

The number of Spot pools to use to allocate your Spot capacity. The Spot pools are determined from the different instance types in the Overrides array of LaunchTemplate.

The range is 1–20 and the default is 2.

withSpotInstancePools

public InstancesDistribution withSpotInstancePools(Integer spotInstancePools)

The number of Spot pools to use to allocate your Spot capacity. The Spot pools are determined from the different instance types in the Overrides array of LaunchTemplate.

The range is 1–20 and the default is 2.

Parameters:

spotInstancePools - The number of Spot pools to use to allocate your Spot capacity. The Spot pools are determined from the different instance types in the Overrides array of LaunchTemplate.

The range is 1–20 and the default is 2.

Returns:

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

setSpotMaxPrice

public void setSpotMaxPrice(String spotMaxPrice)

The maximum price per unit hour that you are willing to pay for a Spot Instance. If you leave the value of this parameter blank (which is the default), the maximum Spot price is set at the On-Demand price.

To remove a value that you previously set, include the parameter but leave the value blank.

Parameters:

spotMaxPrice - The maximum price per unit hour that you are willing to pay for a Spot Instance. If you leave the value of this parameter blank (which is the default), the maximum Spot price is set at the On-Demand price.

To remove a value that you previously set, include the parameter but leave the value blank.

getSpotMaxPrice

public String getSpotMaxPrice()

The maximum price per unit hour that you are willing to pay for a Spot Instance. If you leave the value of this parameter blank (which is the default), the maximum Spot price is set at the On-Demand price.

To remove a value that you previously set, include the parameter but leave the value blank.

Returns:

The maximum price per unit hour that you are willing to pay for a Spot Instance. If you leave the value of this parameter blank (which is the default), the maximum Spot price is set at the On-Demand price.

To remove a value that you previously set, include the parameter but leave the value blank.

withSpotMaxPrice

public InstancesDistribution withSpotMaxPrice(String spotMaxPrice)

The maximum price per unit hour that you are willing to pay for a Spot Instance. If you leave the value of this parameter blank (which is the default), the maximum Spot price is set at the On-Demand price.

To remove a value that you previously set, include the parameter but leave the value blank.

Parameters:

spotMaxPrice - The maximum price per unit hour that you are willing to pay for a Spot Instance. If you leave the value of this parameter blank (which is the default), the maximum Spot price is set at the On-Demand price.

To remove a value that you previously set, include the parameter but leave the value blank.

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 InstancesDistribution clone()

Overrides:

clone in class Object