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) Indicates how to allocate instance types to fulfill 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)

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 types in the LaunchTemplateOverrides 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 types in the LaunchTemplateOverrides 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.

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 provisioned first as your group scales. Defaults to 0 if not specified. If you specify weights for the instance types in the overrides, set the value of OnDemandBaseCapacity in terms of the number of capacity units, and not the number of instances.

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. Defaults to 0 if not specified. If you specify weights for the instance types in the overrides, set the value of OnDemandBaseCapacity in terms of the number of capacity units, and not the number of instances.

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). Defaults to 100 if not specified. If set to 100, only On-Demand Instances are provisioned.

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). Defaults to 100 if not specified. If set to 100, only On-Demand Instances are provisioned.

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. Defaults to lowest-price if not specified.

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.

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. Defaults to lowest-price if not specified.

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.

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 to 20. Defaults to 2 if not specified.

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 to 20. Defaults to 2 if not specified.

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 leave the value at its default (empty), 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.

Parameters:

spotMaxPrice - The maximum price per unit hour that you are willing to pay for a Spot Instance. If you leave the value at its default (empty), 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.

Returns:

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