Class: Aws::EC2::Types::SpotOptionsRequest

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::SpotOptionsRequest

Defined in:

gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass SpotOptionsRequest data as a hash:

{
  allocation_strategy: "lowest-price", # accepts lowest-price, diversified, capacity-optimized, capacity-optimized-prioritized
  maintenance_strategies: {
    capacity_rebalance: {
      replacement_strategy: "launch", # accepts launch
    },
  },
  instance_interruption_behavior: "hibernate", # accepts hibernate, stop, terminate
  instance_pools_to_use_count: 1,
  single_instance_type: false,
  single_availability_zone: false,
  min_target_capacity: 1,
  max_total_price: "String",
}

Describes the configuration of Spot Instances in an EC2 Fleet request.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #allocation_strategy ⇒ String

  Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet.

• #instance_interruption_behavior ⇒ String

  The behavior when a Spot Instance is interrupted.

• #instance_pools_to_use_count ⇒ Integer

  The number of Spot pools across which to allocate your target Spot capacity.

• #maintenance_strategies ⇒ Types::FleetSpotMaintenanceStrategiesRequest

  The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.

• #max_total_price ⇒ String

  The maximum amount per hour for Spot Instances that you're willing to pay.

• #min_target_capacity ⇒ Integer

  The minimum target capacity for Spot Instances in the fleet.

• #single_availability_zone ⇒ Boolean

  Indicates that the fleet launches all Spot Instances into a single Availability Zone.

• #single_instance_type ⇒ Boolean

  Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet.

Instance Attribute Details

#allocation_strategy ⇒ String

Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet.

If the allocation strategy is lowest-price, EC2 Fleet launches instances from the Spot Instance pools with the lowest price. This is the default allocation strategy.

If the allocation strategy is diversified, EC2 Fleet launches instances from all of the Spot Instance pools that you specify.

If the allocation strategy is capacity-optimized (recommended), EC2 Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching. To give certain instance types a higher chance of launching first, use capacity-optimized-prioritized. Set a priority for each instance type by using the Priority parameter for LaunchTemplateOverrides. You can assign the same priority to different LaunchTemplateOverrides. EC2 implements the priorities on a best-effort basis, but optimizes for capacity first. capacity-optimized-prioritized is supported only if your fleet uses a launch template. Note that if the On-Demand AllocationStrategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 51597

class SpotOptionsRequest < Struct.new(
  :allocation_strategy,
  :maintenance_strategies,
  :instance_interruption_behavior,
  :instance_pools_to_use_count,
  :single_instance_type,
  :single_availability_zone,
  :min_target_capacity,
  :max_total_price)
  SENSITIVE = []
  include Aws::Structure
end

#instance_interruption_behavior ⇒ String

The behavior when a Spot Instance is interrupted. The default is terminate.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 51597

class SpotOptionsRequest < Struct.new(
  :allocation_strategy,
  :maintenance_strategies,
  :instance_interruption_behavior,
  :instance_pools_to_use_count,
  :single_instance_type,
  :single_availability_zone,
  :min_target_capacity,
  :max_total_price)
  SENSITIVE = []
  include Aws::Structure
end

#instance_pools_to_use_count ⇒ Integer

The number of Spot pools across which to allocate your target Spot capacity. Valid only when Spot AllocationStrategy is set to lowest-price. EC2 Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify.

Returns:

• (Integer)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 51597

class SpotOptionsRequest < Struct.new(
  :allocation_strategy,
  :maintenance_strategies,
  :instance_interruption_behavior,
  :instance_pools_to_use_count,
  :single_instance_type,
  :single_availability_zone,
  :min_target_capacity,
  :max_total_price)
  SENSITIVE = []
  include Aws::Structure
end

#maintenance_strategies ⇒ Types::FleetSpotMaintenanceStrategiesRequest

The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.

Returns:

• (Types::FleetSpotMaintenanceStrategiesRequest)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 51597

class SpotOptionsRequest < Struct.new(
  :allocation_strategy,
  :maintenance_strategies,
  :instance_interruption_behavior,
  :instance_pools_to_use_count,
  :single_instance_type,
  :single_availability_zone,
  :min_target_capacity,
  :max_total_price)
  SENSITIVE = []
  include Aws::Structure
end

#max_total_price ⇒ String

The maximum amount per hour for Spot Instances that you're willing to pay.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 51597

class SpotOptionsRequest < Struct.new(
  :allocation_strategy,
  :maintenance_strategies,
  :instance_interruption_behavior,
  :instance_pools_to_use_count,
  :single_instance_type,
  :single_availability_zone,
  :min_target_capacity,
  :max_total_price)
  SENSITIVE = []
  include Aws::Structure
end

#min_target_capacity ⇒ Integer

The minimum target capacity for Spot Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances.

Returns:

• (Integer)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 51597

class SpotOptionsRequest < Struct.new(
  :allocation_strategy,
  :maintenance_strategies,
  :instance_interruption_behavior,
  :instance_pools_to_use_count,
  :single_instance_type,
  :single_availability_zone,
  :min_target_capacity,
  :max_total_price)
  SENSITIVE = []
  include Aws::Structure
end

#single_availability_zone ⇒ Boolean

Indicates that the fleet launches all Spot Instances into a single Availability Zone. Supported only for fleets of type instant.

Returns:

• (Boolean)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 51597

class SpotOptionsRequest < Struct.new(
  :allocation_strategy,
  :maintenance_strategies,
  :instance_interruption_behavior,
  :instance_pools_to_use_count,
  :single_instance_type,
  :single_availability_zone,
  :min_target_capacity,
  :max_total_price)
  SENSITIVE = []
  include Aws::Structure
end

#single_instance_type ⇒ Boolean

Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet. Supported only for fleets of type instant.

Returns:

• (Boolean)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 51597

class SpotOptionsRequest < Struct.new(
  :allocation_strategy,
  :maintenance_strategies,
  :instance_interruption_behavior,
  :instance_pools_to_use_count,
  :single_instance_type,
  :single_availability_zone,
  :min_target_capacity,
  :max_total_price)
  SENSITIVE = []
  include Aws::Structure
end