SpotFleetRequestConfigData¶
Structure Class¶
SpotFleetRequestConfigData
dataclass
¶
Bases: _SerdeShape
Describes the configuration of a Spot Fleet request.
Attributes¶
allocation_strategy
class-attribute
instance-attribute
¶
allocation_strategy: str | None = ...
The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the Spot Fleet launch configuration. For more information, see Allocation strategies for Spot Instances in the Amazon EC2 User Guide.
- priceCapacityOptimized (recommended)
-
Spot 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. Spot Fleet then requests Spot Instances from the lowest priced of these pools.
- capacityOptimized
-
Spot 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
capacityOptimizedPrioritized. Set a priority for each instance type by using thePriorityparameter forLaunchTemplateOverrides. You can assign the same priority to differentLaunchTemplateOverrides. EC2 implements the priorities on a best-effort basis, but optimizes for capacity first.capacityOptimizedPrioritizedis supported only if your Spot Fleet uses a launch template. Note that if theOnDemandAllocationStrategyis set toprioritized, the same priority is applied when fulfilling On-Demand capacity. - diversified
-
Spot Fleet requests instances from all of the Spot Instance pools that you specify.
- lowestPrice (not recommended)
-
Warning: We don't recommend the
lowestPriceallocation strategy because it has the highest risk of interruption for your Spot Instances.
Spot 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, Spot 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: lowestPrice
client_token
class-attribute
instance-attribute
¶
client_token: str | None = ...
A unique, case-sensitive identifier that you provide to ensure the idempotency of your listings. This helps to avoid duplicate listings. For more information, see Ensuring Idempotency.
excess_capacity_termination_policy
class-attribute
instance-attribute
¶
excess_capacity_termination_policy: str | None = ...
Indicates whether running instances should be terminated if you decrease the target capacity of the Spot Fleet request below the current size of the Spot Fleet.
Supported only for fleets of type maintain.
fulfilled_capacity
class-attribute
instance-attribute
¶
fulfilled_capacity: float | None = ...
The number of units fulfilled by this request compared to the set target capacity. You cannot set this value.
iam_fleet_role
class-attribute
instance-attribute
¶
iam_fleet_role: str | None = ...
The Amazon Resource Name (ARN) of an Identity and Access Management
(IAM) role that grants the Spot Fleet the permission to request, launch,
terminate, and tag instances on your behalf. For more information, see
Spot Fleet
prerequisites
in the Amazon EC2 User Guide. Spot Fleet can terminate Spot Instances
on your behalf when you cancel its Spot Fleet request using
CancelSpotFleetRequests
or when the Spot Fleet request expires, if you set
TerminateInstancesWithExpiration.
instance_interruption_behavior
class-attribute
instance-attribute
¶
instance_interruption_behavior: str | None = ...
The behavior when a Spot Instance is interrupted. The default is
terminate.
instance_pools_to_use_count
class-attribute
instance-attribute
¶
instance_pools_to_use_count: int | None = ...
The number of Spot pools across which to allocate your target Spot
capacity. Valid only when Spot AllocationStrategy is set to
lowest-price. Spot Fleet selects the cheapest Spot pools and evenly
allocates your target Spot capacity across the number of Spot pools that
you specify.
Note that Spot 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, Spot 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.
launch_specifications
class-attribute
instance-attribute
¶
launch_specifications: list[SpotFleetLaunchSpecification] | None = ...
The launch specifications for the Spot Fleet request. If you specify
LaunchSpecifications, you can't specify LaunchTemplateConfigs. If
you include On-Demand capacity in your request, you must use
LaunchTemplateConfigs.
Note
If an AMI specified in a launch specification is deregistered or
disabled, no new instances can be launched from the AMI. For fleets of
type maintain, the target capacity will not be maintained.
launch_template_configs
class-attribute
instance-attribute
¶
launch_template_configs: list[LaunchTemplateConfig] | None = ...
The launch template and overrides. If you specify
LaunchTemplateConfigs, you can't specify LaunchSpecifications. If
you include On-Demand capacity in your request, you must use
LaunchTemplateConfigs.
load_balancers_config
class-attribute
instance-attribute
¶
load_balancers_config: LoadBalancersConfig | None = ...
One or more Classic Load Balancers and target groups to attach to the Spot Fleet request. Spot Fleet registers the running Spot Instances with the specified Classic Load Balancers and target groups.
With Network Load Balancers, Spot Fleet cannot register instances that have the following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1.
on_demand_allocation_strategy
class-attribute
instance-attribute
¶
on_demand_allocation_strategy: str | None = ...
The order of the launch template overrides to use in fulfilling
On-Demand capacity. If you specify lowestPrice, Spot Fleet uses price
to determine the order, launching the lowest price first. If you specify
prioritized, Spot Fleet uses the priority that you assign to each Spot
Fleet launch template override, launching the highest priority first. If
you do not specify a value, Spot Fleet defaults to lowestPrice.
on_demand_fulfilled_capacity
class-attribute
instance-attribute
¶
on_demand_fulfilled_capacity: float | None = ...
The number of On-Demand units fulfilled by this request compared to the set target On-Demand capacity.
on_demand_max_total_price
class-attribute
instance-attribute
¶
on_demand_max_total_price: str | None = ...
The maximum amount per hour for On-Demand Instances that you're willing
to pay. You can use the onDemandMaxTotalPrice parameter, the
spotMaxTotalPrice parameter, or both parameters to ensure that your
fleet cost does not exceed your budget. If you set a maximum price per
hour for the On-Demand Instances and Spot Instances in your request,
Spot Fleet will launch instances until it reaches the maximum amount
you're willing to pay. When the maximum amount you're willing to pay
is reached, the fleet stops launching instances even if it hasn't met
the target capacity.
Note
If your fleet includes T instances that are configured as unlimited,
and if their average CPU usage exceeds the baseline utilization, you
will incur a charge for surplus credits. The onDemandMaxTotalPrice
does not account for surplus credits, and, if you use surplus credits,
your final cost might be higher than what you specified for
onDemandMaxTotalPrice. For more information, see Surplus credits can
incur
charges
in the Amazon EC2 User Guide.
on_demand_target_capacity
class-attribute
instance-attribute
¶
on_demand_target_capacity: int | None = ...
The number of On-Demand units to request. You can choose to set the
target capacity in terms of instances or a performance characteristic
that is important to your application workload, such as vCPUs, memory,
or I/O. If the request type is maintain, you can specify a target
capacity of 0 and add capacity later.
replace_unhealthy_instances
class-attribute
instance-attribute
¶
replace_unhealthy_instances: bool | None = ...
Indicates whether Spot Fleet should replace unhealthy instances.
spot_maintenance_strategies
class-attribute
instance-attribute
¶
spot_maintenance_strategies: SpotMaintenanceStrategies | None = ...
The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.
spot_max_total_price
class-attribute
instance-attribute
¶
spot_max_total_price: str | None = ...
The maximum amount per hour for Spot Instances that you're willing to
pay. You can use the spotMaxTotalPrice parameter, the
onDemandMaxTotalPrice parameter, or both parameters to ensure that
your fleet cost does not exceed your budget. If you set a maximum price
per hour for the On-Demand Instances and Spot Instances in your request,
Spot Fleet will launch instances until it reaches the maximum amount
you're willing to pay. When the maximum amount you're willing to pay
is reached, the fleet stops launching instances even if it hasn't met
the target capacity.
Note
If your fleet includes T instances that are configured as unlimited,
and if their average CPU usage exceeds the baseline utilization, you
will incur a charge for surplus credits. The spotMaxTotalPrice does
not account for surplus credits, and, if you use surplus credits, your
final cost might be higher than what you specified for
spotMaxTotalPrice. For more information, see Surplus credits can
incur
charges
in the Amazon EC2 User Guide.
spot_price
class-attribute
instance-attribute
¶
spot_price: str | None = ...
The maximum price per unit hour that you are willing to pay for a Spot Instance. 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.
Warning
If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.
tag_specifications
class-attribute
instance-attribute
¶
tag_specifications: list[TagSpecification] | None = ...
The key-value pair for tagging the Spot Fleet request on creation. The
value for ResourceType must be spot-fleet-request, otherwise the
Spot Fleet request fails. To tag instances at launch, specify the tags
in the launch
template
(valid only if you use LaunchTemplateConfigs) or in the
SpotFleetTagSpecification
(valid only if you use LaunchSpecifications). For information about
tagging after launch, see Tag your
resources.
target_capacity
class-attribute
instance-attribute
¶
target_capacity: int | None = ...
The number of units to request for the Spot Fleet. You can choose to set
the target capacity in terms of instances or a performance
characteristic that is important to your application workload, such as
vCPUs, memory, or I/O. If the request type is maintain, you can
specify a target capacity of 0 and add capacity later.
target_capacity_unit_type
class-attribute
instance-attribute
¶
target_capacity_unit_type: str | None = ...
The unit for the target capacity. You can specify this parameter only when using attribute-based instance type selection.
Default: units (the number of instances)
terminate_instances_with_expiration
class-attribute
instance-attribute
¶
terminate_instances_with_expiration: bool | None = ...
Indicates whether running Spot Instances are terminated when the Spot Fleet request expires.
type
class-attribute
instance-attribute
¶
type: str | None = ...
The type of request. Indicates whether the Spot Fleet only requests the
target capacity or also attempts to maintain it. When this value is
request, the Spot Fleet only places the required requests. It does not
attempt to replenish Spot Instances if capacity is diminished, nor does
it submit requests in alternative Spot pools if capacity is not
available. When this value is maintain, the Spot Fleet maintains the
target capacity. The Spot Fleet places the required requests to meet
capacity and automatically replenishes any interrupted instances.
Default: maintain. instant is listed but is not used by Spot Fleet.
valid_from
class-attribute
instance-attribute
¶
valid_from: datetime | None = ...
The start date and time of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ). By default, Amazon EC2 starts fulfilling the request immediately.
valid_until
class-attribute
instance-attribute
¶
valid_until: datetime | None = ...
The end date and time of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ). After the end date and time, no new Spot Instance requests are placed or able to fulfill the request. If no value is specified, the Spot Fleet request remains until you cancel it.