software.amazon.awssdk.services.autoscaling.model

Class InstancesDistribution

java.lang.Object

software.amazon.awssdk.services.autoscaling.model.InstancesDistribution

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<InstancesDistribution.Builder,InstancesDistribution>

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

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	InstancesDistribution.Builder

Method Summary

Modifier and Type	Method and Description
static InstancesDistribution.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	onDemandAllocationStrategy() Indicates how to allocate instance types to fulfill On-Demand capacity.
Integer	onDemandBaseCapacity() The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances.
Integer	onDemandPercentageAboveBaseCapacity() Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond OnDemandBaseCapacity.
List<SdkField<?>>	sdkFields()
static Class<? extends InstancesDistribution.Builder>	serializableBuilderClass()
String	spotAllocationStrategy() Indicates how to allocate Spot capacity across Spot pools.
Integer	spotInstancePools() The number of Spot pools to use to allocate your Spot capacity.
String	spotMaxPrice() The maximum price per unit hour that you are willing to pay for a Spot Instance.
InstancesDistribution.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

onDemandAllocationStrategy

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

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.

onDemandBaseCapacity

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

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.

onDemandPercentageAboveBaseCapacity

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

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.

spotAllocationStrategy

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

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.

spotInstancePools

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

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.

spotMaxPrice

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

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.

toBuilder

public InstancesDistribution.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<InstancesDistribution.Builder,InstancesDistribution>

builder

public static InstancesDistribution.Builder builder()

serializableBuilderClass

public static Class<? extends InstancesDistribution.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

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

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo