AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::AutoScaling::Types::InstancesDistribution

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing InstancesDistribution as input to an Aws::Client method, you can use a vanilla Hash:

{
  on_demand_allocation_strategy: "XmlString",
  on_demand_base_capacity: 1,
  on_demand_percentage_above_base_capacity: 1,
  spot_allocation_strategy: "XmlString",
  spot_instance_pools: 1,
  spot_max_price: "MixedInstanceSpotPrice",
}

Describes an instances distribution for an Auto Scaling group with a MixedInstancesPolicy.

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.

When you update SpotAllocationStrategy, SpotInstancePools, or SpotMaxPrice, this update action does not deploy any changes across the running Amazon EC2 instances in the group. Your existing Spot Instances continue to run as long as the maximum price for those instances is higher than the current Spot price. When scale out occurs, Amazon EC2 Auto Scaling launches instances based on the new settings. When scale in occurs, Amazon EC2 Auto Scaling terminates instances according to the group's termination policies.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#on_demand_allocation_strategyString

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 overrides 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:

  • (String)

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

#on_demand_base_capacityInteger

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:

  • (Integer)

    The minimum amount of the Auto Scaling group\'s capacity that must be fulfilled by On-Demand Instances.

#on_demand_percentage_above_base_capacityInteger

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:

  • (Integer)

    Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond OnDemandBaseCapacity.

#spot_allocation_strategyString

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, the Auto Scaling group launches instances using Spot pools that are optimally chosen based on the available Spot capacity. Defaults to lowest-price if not specified.

Returns:

  • (String)

    Indicates how to allocate instances across Spot Instance pools.

#spot_instance_poolsInteger

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. Defaults to 2 if not specified. Valid only when the Spot allocation strategy is lowest-price.

Valid Range: Minimum value of 1. Maximum value of 20.

Returns:

  • (Integer)

    The number of Spot Instance pools across which to allocate your Spot Instances.

#spot_max_priceString

The maximum price per unit hour that you are willing to pay for a Spot Instance. If you leave the value of this parameter blank (which is the default), the maximum Spot price is set at the On-Demand price. To remove a value that you previously set, include the parameter but leave the value blank.

Returns:

  • (String)

    The maximum price per unit hour that you are willing to pay for a Spot Instance.