software.amazon.awssdk.services.autoscaling.model

Interface InstancesDistribution.Builder

All Superinterfaces:

Buildable, CopyableBuilder<InstancesDistribution.Builder,InstancesDistribution>, SdkBuilder<InstancesDistribution.Builder,InstancesDistribution>, SdkPojo

Enclosing class:

InstancesDistribution

public static interface InstancesDistribution.Builder
extends SdkPojo, CopyableBuilder<InstancesDistribution.Builder,InstancesDistribution>

Method Summary

Modifier and Type	Method and Description
InstancesDistribution.Builder	onDemandAllocationStrategy(String onDemandAllocationStrategy) The order of the launch template overrides to use in fulfilling On-Demand capacity.
InstancesDistribution.Builder	onDemandBaseCapacity(Integer onDemandBaseCapacity) The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances.
InstancesDistribution.Builder	onDemandPercentageAboveBaseCapacity(Integer onDemandPercentageAboveBaseCapacity) Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond OnDemandBaseCapacity.
InstancesDistribution.Builder	spotAllocationStrategy(String spotAllocationStrategy) Indicates how to allocate instances across Spot Instance pools.
InstancesDistribution.Builder	spotInstancePools(Integer spotInstancePools) The number of Spot Instance pools across which to allocate your Spot Instances.
InstancesDistribution.Builder	spotMaxPrice(String spotMaxPrice) The maximum price per unit hour that you are willing to pay for a Spot Instance.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

onDemandAllocationStrategy

InstancesDistribution.Builder onDemandAllocationStrategy(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

Parameters:

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:

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

onDemandBaseCapacity

InstancesDistribution.Builder onDemandBaseCapacity(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

Parameters:

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:

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

onDemandPercentageAboveBaseCapacity

InstancesDistribution.Builder onDemandPercentageAboveBaseCapacity(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

Parameters:

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:

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

spotAllocationStrategy

InstancesDistribution.Builder spotAllocationStrategy(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

Parameters:

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:

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

spotInstancePools

InstancesDistribution.Builder spotInstancePools(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

Parameters:

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:

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

spotMaxPrice

InstancesDistribution.Builder spotMaxPrice(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

Parameters:

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:

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