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.

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)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	onDemandAllocationStrategy() The order of the launch template overrides to use in fulfilling 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 instances across Spot Instance pools.
Integer	spotInstancePools() The number of Spot Instance pools across which to allocate your Spot Instances.
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 final String onDemandAllocationStrategy()

The order of the launch template overrides to use in fulfilling On-Demand capacity.

If you specify lowest-price, Amazon EC2 Auto Scaling uses price to determine the order, launching the lowest price first.

If you specify prioritized, Amazon EC2 Auto Scaling uses the priority that you assigned to each launch template override, launching the highest priority first. If all your On-Demand capacity cannot be fulfilled using your highest priority instance, then Amazon EC2 Auto Scaling launches the remaining capacity using the second priority instance type, and so on.

Default: lowest-price for Auto Scaling groups that specify InstanceRequirements in the overrides and prioritized for Auto Scaling groups that don't.

Valid values: lowest-price | prioritized

Returns:

The order of the launch template overrides to use in fulfilling On-Demand capacity.

If you specify lowest-price, Amazon EC2 Auto Scaling uses price to determine the order, launching the lowest price first.

If you specify prioritized, Amazon EC2 Auto Scaling uses the priority that you assigned to each launch template override, launching the highest priority first. If all your On-Demand capacity cannot be fulfilled using your highest priority instance, then Amazon EC2 Auto Scaling launches the remaining capacity using the second priority instance type, and so on.

Default: lowest-price for Auto Scaling groups that specify InstanceRequirements in the overrides and prioritized for Auto Scaling groups that don't.

Valid values: lowest-price | prioritized

onDemandBaseCapacity

public final Integer onDemandBaseCapacity()

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

If you specify weights for the instance types in the overrides, the base capacity is measured in the same unit of measurement as the instance types. If you specify InstanceRequirements in the overrides, the base capacity is measured in the same unit of measurement as your group's desired capacity.

Default: 0

Returns:

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

If you specify weights for the instance types in the overrides, the base capacity is measured in the same unit of measurement as the instance types. If you specify InstanceRequirements in the overrides, the base capacity is measured in the same unit of measurement as your group's desired capacity.

Default: 0

onDemandPercentageAboveBaseCapacity

public final Integer onDemandPercentageAboveBaseCapacity()

Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond OnDemandBaseCapacity. Expressed as a number (for example, 20 specifies 20% On-Demand Instances, 80% Spot Instances). If set to 100, only On-Demand Instances are used.

Default: 100

Returns:

Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond OnDemandBaseCapacity. Expressed as a number (for example, 20 specifies 20% On-Demand Instances, 80% Spot Instances). If set to 100, only On-Demand Instances are used.

Default: 100

spotAllocationStrategy

public final String spotAllocationStrategy()

Indicates how to allocate instances across Spot Instance pools.

If the allocation strategy is lowest-price, the Auto Scaling group launches instances using the Spot pools with the lowest price, and evenly allocates your instances across the number of Spot pools that you specify.

If the allocation strategy is capacity-optimized (recommended), the Auto Scaling group launches instances using Spot pools that are optimally chosen based on the available Spot capacity. Alternatively, you can use capacity-optimized-prioritized and set the order of instance types in the list of launch template overrides from highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling honors the instance type priorities on a best-effort basis but optimizes for capacity first.

Default: lowest-price

Valid values: lowest-price | capacity-optimized | capacity-optimized-prioritized

Returns:

Indicates how to allocate instances across Spot Instance pools.

If the allocation strategy is lowest-price, the Auto Scaling group launches instances using the Spot pools with the lowest price, and evenly allocates your instances across the number of Spot pools that you specify.

If the allocation strategy is capacity-optimized (recommended), the Auto Scaling group launches instances using Spot pools that are optimally chosen based on the available Spot capacity. Alternatively, you can use capacity-optimized-prioritized and set the order of instance types in the list of launch template overrides from highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling honors the instance type priorities on a best-effort basis but optimizes for capacity first.

Default: lowest-price

Valid values: lowest-price | capacity-optimized | capacity-optimized-prioritized

spotInstancePools

public final Integer spotInstancePools()

The number of Spot Instance pools across which to allocate your Spot Instances. The Spot pools are determined from the different instance types in the overrides. Valid only when the Spot allocation strategy is lowest-price. Value must be in the range of 1–20.

Default: 2

Returns:

The number of Spot Instance pools across which to allocate your Spot Instances. The Spot pools are determined from the different instance types in the overrides. Valid only when the Spot allocation strategy is lowest-price. Value must be in the range of 1–20.

Default: 2

spotMaxPrice

public final String spotMaxPrice()

The maximum price per unit hour that you are willing to pay for a Spot Instance. If you keep the value at its default (unspecified), Amazon EC2 Auto Scaling uses the On-Demand price as the maximum Spot price. To remove a value that you previously set, include the property but specify an empty string ("") for the value.

If your maximum price is lower than the Spot price for the instance types that you selected, your Spot Instances are not launched.

Valid Range: Minimum value of 0.001

Returns:

The maximum price per unit hour that you are willing to pay for a Spot Instance. If you keep the value at its default (unspecified), Amazon EC2 Auto Scaling uses the On-Demand price as the maximum Spot price. To remove a value that you previously set, include the property but specify an empty string ("") for the value.

If your maximum price is lower than the Spot price for the instance types that you selected, your Spot Instances are not launched.

Valid Range: Minimum value of 0.001

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 final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo