Class InstancesDistribution.Builder
java.lang.Object
software.amazon.awscdk.services.autoscaling.InstancesDistribution.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<InstancesDistribution>
- Enclosing interface:
InstancesDistribution
@Stability(Stable)
public static final class InstancesDistribution.Builder
extends Object
implements software.amazon.jsii.Builder<InstancesDistribution>
A builder for
InstancesDistribution
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds the configured instance.onDemandAllocationStrategy
(OnDemandAllocationStrategy onDemandAllocationStrategy) Sets the value ofInstancesDistribution.getOnDemandAllocationStrategy()
onDemandBaseCapacity
(Number onDemandBaseCapacity) Sets the value ofInstancesDistribution.getOnDemandBaseCapacity()
onDemandPercentageAboveBaseCapacity
(Number onDemandPercentageAboveBaseCapacity) Sets the value ofInstancesDistribution.getOnDemandPercentageAboveBaseCapacity()
spotAllocationStrategy
(SpotAllocationStrategy spotAllocationStrategy) Sets the value ofInstancesDistribution.getSpotAllocationStrategy()
spotInstancePools
(Number spotInstancePools) Sets the value ofInstancesDistribution.getSpotInstancePools()
spotMaxPrice
(String spotMaxPrice) Sets the value ofInstancesDistribution.getSpotMaxPrice()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
onDemandAllocationStrategy
@Stability(Stable) public InstancesDistribution.Builder onDemandAllocationStrategy(OnDemandAllocationStrategy onDemandAllocationStrategy) Sets the value ofInstancesDistribution.getOnDemandAllocationStrategy()
- 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.- Returns:
this
-
onDemandBaseCapacity
@Stability(Stable) public InstancesDistribution.Builder onDemandBaseCapacity(Number onDemandBaseCapacity) Sets the value ofInstancesDistribution.getOnDemandBaseCapacity()
- 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:
this
-
onDemandPercentageAboveBaseCapacity
@Stability(Stable) public InstancesDistribution.Builder onDemandPercentageAboveBaseCapacity(Number onDemandPercentageAboveBaseCapacity) Sets the value ofInstancesDistribution.getOnDemandPercentageAboveBaseCapacity()
- 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:
this
-
spotAllocationStrategy
@Stability(Stable) public InstancesDistribution.Builder spotAllocationStrategy(SpotAllocationStrategy spotAllocationStrategy) Sets the value ofInstancesDistribution.getSpotAllocationStrategy()
- Parameters:
spotAllocationStrategy
- 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:
this
-
spotInstancePools
Sets the value ofInstancesDistribution.getSpotInstancePools()
- Parameters:
spotInstancePools
- The number of Spot Instance pools to use to allocate your Spot capacity. 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:
this
-
spotMaxPrice
Sets the value ofInstancesDistribution.getSpotMaxPrice()
- 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:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<InstancesDistribution>
- Returns:
- a new instance of
InstancesDistribution
- Throws:
NullPointerException
- if any required attribute was not provided
-