amazonka-ec2-2.0: Amazon Elastic Compute Cloud SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.EC2.Types.SpotOptions

Description

 
Synopsis

Documentation

data SpotOptions Source #

Describes the configuration of Spot Instances in an EC2 Fleet.

See: newSpotOptions smart constructor.

Constructors

SpotOptions' 

Fields

  • allocationStrategy :: Maybe SpotAllocationStrategy

    The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet launch configuration. For more information, see Allocation strategies for Spot Instances in the Amazon EC2 User Guide.

    price-capacity-optimized (recommended)
    EC2 Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. EC2 Fleet then requests Spot Instances from the lowest priced of these pools.
    capacity-optimized
    EC2 Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. 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 EC2 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.
    diversified
    EC2 Fleet requests instances from all of the Spot Instance pools that you specify.
    lowest-price
    EC2 Fleet requests instances from the lowest priced Spot Instance pool that has available capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances come from the next lowest priced pool that has available capacity. If a pool runs out of capacity before fulfilling your desired capacity, EC2 Fleet will continue to fulfill your request by drawing from the next lowest priced pool. To ensure that your desired capacity is met, you might receive Spot Instances from several pools. Because this strategy only considers instance price and not capacity availability, it might lead to high interruption rates.

    Default: lowest-price

  • instanceInterruptionBehavior :: Maybe SpotInstanceInterruptionBehavior

    The behavior when a Spot Instance is interrupted.

    Default: terminate

  • instancePoolsToUseCount :: Maybe Int

    The number of Spot pools across which to allocate your target Spot capacity. Supported only when 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.

    Note that EC2 Fleet attempts to draw Spot Instances from the number of pools that you specify on a best effort basis. If a pool runs out of Spot capacity before fulfilling your target capacity, EC2 Fleet will continue to fulfill your request by drawing from the next cheapest pool. To ensure that your target capacity is met, you might receive Spot Instances from more than the number of pools that you specified. Similarly, if most of the pools have no Spot capacity, you might receive your full target capacity from fewer than the number of pools that you specified.

  • maintenanceStrategies :: Maybe FleetSpotMaintenanceStrategies

    The strategies for managing your workloads on your Spot Instances that will be interrupted. Currently only the capacity rebalance strategy is available.

  • maxTotalPrice :: Maybe Text

    The maximum amount per hour for Spot Instances that you're willing to pay. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.

    If you specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter.

  • minTargetCapacity :: Maybe Int

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

    Supported only for fleets of type instant.

    At least one of the following must be specified: SingleAvailabilityZone | SingleInstanceType

  • singleAvailabilityZone :: Maybe Bool

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

    Supported only for fleets of type instant.

  • singleInstanceType :: Maybe Bool

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

    Supported only for fleets of type instant.

Instances

Instances details
FromXML SpotOptions Source # 
Instance details

Defined in Amazonka.EC2.Types.SpotOptions

Generic SpotOptions Source # 
Instance details

Defined in Amazonka.EC2.Types.SpotOptions

Associated Types

type Rep SpotOptions :: Type -> Type #

Read SpotOptions Source # 
Instance details

Defined in Amazonka.EC2.Types.SpotOptions

Show SpotOptions Source # 
Instance details

Defined in Amazonka.EC2.Types.SpotOptions

NFData SpotOptions Source # 
Instance details

Defined in Amazonka.EC2.Types.SpotOptions

Methods

rnf :: SpotOptions -> () #

Eq SpotOptions Source # 
Instance details

Defined in Amazonka.EC2.Types.SpotOptions

Hashable SpotOptions Source # 
Instance details

Defined in Amazonka.EC2.Types.SpotOptions

type Rep SpotOptions Source # 
Instance details

Defined in Amazonka.EC2.Types.SpotOptions

type Rep SpotOptions = D1 ('MetaData "SpotOptions" "Amazonka.EC2.Types.SpotOptions" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "SpotOptions'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "allocationStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SpotAllocationStrategy)) :*: S1 ('MetaSel ('Just "instanceInterruptionBehavior") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SpotInstanceInterruptionBehavior))) :*: (S1 ('MetaSel ('Just "instancePoolsToUseCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "maintenanceStrategies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FleetSpotMaintenanceStrategies)))) :*: ((S1 ('MetaSel ('Just "maxTotalPrice") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "minTargetCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "singleAvailabilityZone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "singleInstanceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))))

newSpotOptions :: SpotOptions Source #

Create a value of SpotOptions with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:allocationStrategy:SpotOptions', spotOptions_allocationStrategy - The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet launch configuration. For more information, see Allocation strategies for Spot Instances in the Amazon EC2 User Guide.

price-capacity-optimized (recommended)
EC2 Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. EC2 Fleet then requests Spot Instances from the lowest priced of these pools.
capacity-optimized
EC2 Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. 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 EC2 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.
diversified
EC2 Fleet requests instances from all of the Spot Instance pools that you specify.
lowest-price
EC2 Fleet requests instances from the lowest priced Spot Instance pool that has available capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances come from the next lowest priced pool that has available capacity. If a pool runs out of capacity before fulfilling your desired capacity, EC2 Fleet will continue to fulfill your request by drawing from the next lowest priced pool. To ensure that your desired capacity is met, you might receive Spot Instances from several pools. Because this strategy only considers instance price and not capacity availability, it might lead to high interruption rates.

Default: lowest-price

$sel:instanceInterruptionBehavior:SpotOptions', spotOptions_instanceInterruptionBehavior - The behavior when a Spot Instance is interrupted.

Default: terminate

$sel:instancePoolsToUseCount:SpotOptions', spotOptions_instancePoolsToUseCount - The number of Spot pools across which to allocate your target Spot capacity. Supported only when 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.

Note that EC2 Fleet attempts to draw Spot Instances from the number of pools that you specify on a best effort basis. If a pool runs out of Spot capacity before fulfilling your target capacity, EC2 Fleet will continue to fulfill your request by drawing from the next cheapest pool. To ensure that your target capacity is met, you might receive Spot Instances from more than the number of pools that you specified. Similarly, if most of the pools have no Spot capacity, you might receive your full target capacity from fewer than the number of pools that you specified.

$sel:maintenanceStrategies:SpotOptions', spotOptions_maintenanceStrategies - The strategies for managing your workloads on your Spot Instances that will be interrupted. Currently only the capacity rebalance strategy is available.

$sel:maxTotalPrice:SpotOptions', spotOptions_maxTotalPrice - The maximum amount per hour for Spot Instances that you're willing to pay. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.

If you specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter.

$sel:minTargetCapacity:SpotOptions', spotOptions_minTargetCapacity - The minimum target capacity for Spot Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances.

Supported only for fleets of type instant.

At least one of the following must be specified: SingleAvailabilityZone | SingleInstanceType

$sel:singleAvailabilityZone:SpotOptions', spotOptions_singleAvailabilityZone - Indicates that the fleet launches all Spot Instances into a single Availability Zone.

Supported only for fleets of type instant.

$sel:singleInstanceType:SpotOptions', spotOptions_singleInstanceType - Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet.

Supported only for fleets of type instant.

spotOptions_allocationStrategy :: Lens' SpotOptions (Maybe SpotAllocationStrategy) Source #

The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet launch configuration. For more information, see Allocation strategies for Spot Instances in the Amazon EC2 User Guide.

price-capacity-optimized (recommended)
EC2 Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. EC2 Fleet then requests Spot Instances from the lowest priced of these pools.
capacity-optimized
EC2 Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. 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 EC2 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.
diversified
EC2 Fleet requests instances from all of the Spot Instance pools that you specify.
lowest-price
EC2 Fleet requests instances from the lowest priced Spot Instance pool that has available capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances come from the next lowest priced pool that has available capacity. If a pool runs out of capacity before fulfilling your desired capacity, EC2 Fleet will continue to fulfill your request by drawing from the next lowest priced pool. To ensure that your desired capacity is met, you might receive Spot Instances from several pools. Because this strategy only considers instance price and not capacity availability, it might lead to high interruption rates.

Default: lowest-price

spotOptions_instanceInterruptionBehavior :: Lens' SpotOptions (Maybe SpotInstanceInterruptionBehavior) Source #

The behavior when a Spot Instance is interrupted.

Default: terminate

spotOptions_instancePoolsToUseCount :: Lens' SpotOptions (Maybe Int) Source #

The number of Spot pools across which to allocate your target Spot capacity. Supported only when 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.

Note that EC2 Fleet attempts to draw Spot Instances from the number of pools that you specify on a best effort basis. If a pool runs out of Spot capacity before fulfilling your target capacity, EC2 Fleet will continue to fulfill your request by drawing from the next cheapest pool. To ensure that your target capacity is met, you might receive Spot Instances from more than the number of pools that you specified. Similarly, if most of the pools have no Spot capacity, you might receive your full target capacity from fewer than the number of pools that you specified.

spotOptions_maintenanceStrategies :: Lens' SpotOptions (Maybe FleetSpotMaintenanceStrategies) Source #

The strategies for managing your workloads on your Spot Instances that will be interrupted. Currently only the capacity rebalance strategy is available.

spotOptions_maxTotalPrice :: Lens' SpotOptions (Maybe Text) Source #

The maximum amount per hour for Spot Instances that you're willing to pay. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.

If you specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter.

spotOptions_minTargetCapacity :: Lens' SpotOptions (Maybe Int) Source #

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

Supported only for fleets of type instant.

At least one of the following must be specified: SingleAvailabilityZone | SingleInstanceType

spotOptions_singleAvailabilityZone :: Lens' SpotOptions (Maybe Bool) Source #

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

Supported only for fleets of type instant.

spotOptions_singleInstanceType :: Lens' SpotOptions (Maybe Bool) Source #

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

Supported only for fleets of type instant.