software.amazon.awscdk.services.autoscaling

Interface InstancesDistribution

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

InstancesDistribution.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.812Z")
 @Stability(value=Stable)
public interface InstancesDistribution
extends software.amazon.jsii.JsiiSerializable

InstancesDistribution is a subproperty of MixedInstancesPolicy that describes an instances distribution for an Auto Scaling group.

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 to fulfill On-Demand and Spot capacities.

For more information and example configurations, see Auto Scaling groups with multiple instance types and purchase options in the Amazon EC2 Auto Scaling User Guide:

https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-purchase-options.html

Example:

 Vpc vpc;
 LaunchTemplate launchTemplate1;
 LaunchTemplate launchTemplate2;
 AutoScalingGroup.Builder.create(this, "ASG")
         .vpc(vpc)
         .mixedInstancesPolicy(MixedInstancesPolicy.builder()
                 .instancesDistribution(InstancesDistribution.builder()
                         .onDemandPercentageAboveBaseCapacity(50)
                         .build())
                 .launchTemplate(launchTemplate1)
                 .launchTemplateOverrides(List.of(LaunchTemplateOverrides.builder().instanceType(new InstanceType("t3.micro")).build(), LaunchTemplateOverrides.builder().instanceType(new InstanceType("t3a.micro")).build(), LaunchTemplateOverrides.builder().instanceType(new InstanceType("t4g.micro")).launchTemplate(launchTemplate2).build()))
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	InstancesDistribution.Builder A builder for InstancesDistribution
static class	InstancesDistribution.Jsii$Proxy An implementation for InstancesDistribution

Method Summary

Modifier and Type	Method and Description
static InstancesDistribution.Builder	builder()
default OnDemandAllocationStrategy	getOnDemandAllocationStrategy() Indicates how to allocate instance types to fulfill On-Demand capacity.
default Number	getOnDemandBaseCapacity() The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances.
default Number	getOnDemandPercentageAboveBaseCapacity() Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond OnDemandBaseCapacity.
default SpotAllocationStrategy	getSpotAllocationStrategy() 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.
default Number	getSpotInstancePools() The number of Spot Instance pools to use to allocate your Spot capacity.
default String	getSpotMaxPrice() The maximum price per unit hour that you are willing to pay for a Spot Instance.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getOnDemandAllocationStrategy

@Stability(value=Stable)
 @Nullable
default OnDemandAllocationStrategy getOnDemandAllocationStrategy()

Indicates how to allocate instance types to fulfill On-Demand capacity.

The only valid value is prioritized, which is also the default value.

Default: OnDemandAllocationStrategy.PRIORITIZED

getOnDemandBaseCapacity

@Stability(value=Stable)
 @Nullable
default Number getOnDemandBaseCapacity()

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.

Default: 0

getOnDemandPercentageAboveBaseCapacity

@Stability(value=Stable)
 @Nullable
default Number getOnDemandPercentageAboveBaseCapacity()

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.

Default: 100

getSpotAllocationStrategy

@Stability(value=Stable)
 @Nullable
default SpotAllocationStrategy getSpotAllocationStrategy()

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.

Default: SpotAllocationStrategy.LOWEST_PRICE

getSpotInstancePools

@Stability(value=Stable)
 @Nullable
default Number getSpotInstancePools()

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.

Default: 2

getSpotMaxPrice

@Stability(value=Stable)
 @Nullable
default String getSpotMaxPrice()

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.

Default: "" - On-Demand price

builder

@Stability(value=Stable)
static InstancesDistribution.Builder builder()

Returns:

a InstancesDistribution.Builder of InstancesDistribution