Skip to content

OnDemandOptionsRequest

Source code in docs_src/capo_ec2/types/on_demand_options_request.py
class OnDemandOptionsRequest(TypedDict, closed=True):
    allocation_strategy: NotRequired[
        "capo_ec2.types.fleet_on_demand_allocation_strategy.FleetOnDemandAllocationStrategy"
    ]
    """<p>The strategy that determines the order of the launch template overrides to use in fulfilling On-Demand capacity.</p> <p> <code>lowest-price</code> - EC2 Fleet uses price to determine the order, launching the lowest price first.</p> <p> <code>prioritized</code> - EC2 Fleet uses the priority that you assigned to each launch template override, launching the highest priority first.</p> <p>Default: <code>lowest-price</code> </p>"""
    capacity_reservation_options: NotRequired[
        "capo_ec2.types.capacity_reservation_options_request.CapacityReservationOptionsRequest"
    ]
    """<p>The strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.</p> <p>Supported only for fleets of type <code>instant</code>.</p>"""
    single_instance_type: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the fleet.</p> <p>Supported only for fleets of type <code>instant</code>.</p>"""
    single_availability_zone: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>Indicates that the fleet launches all On-Demand Instances into a single Availability Zone.</p> <p>Supported only for fleets of type <code>instant</code>.</p>"""
    min_target_capacity: NotRequired["capo_ec2.types.integer.Integer"]
    """<p>The minimum target capacity for On-Demand Instances in the fleet. If this minimum capacity isn't reached, no instances are launched.</p> <p>Constraints: Maximum value of <code>1000</code>. Supported only for fleets of type <code>instant</code>.</p> <p>At least one of the following must be specified: <code>SingleAvailabilityZone</code> | <code>SingleInstanceType</code> </p>"""
    max_total_price: NotRequired["capo_ec2.types.string.String"]
    """<p>The maximum amount per hour for On-Demand Instances that you're willing to pay.</p> <note> <p>If your fleet includes T instances that are configured as <code>unlimited</code>, and if their average CPU usage exceeds the baseline utilization, you will incur a charge for surplus credits. The <code>MaxTotalPrice</code> does not account for surplus credits, and, if you use surplus credits, your final cost might be higher than what you specified for <code>MaxTotalPrice</code>. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances-unlimited-mode-concepts.html#unlimited-mode-surplus-credits">Surplus credits can incur charges</a> in the <i>Amazon EC2 User Guide</i>.</p> </note>"""

allocation_strategy instance-attribute

allocation_strategy: NotRequired[FleetOnDemandAllocationStrategy]

The strategy that determines the order of the launch template overrides to use in fulfilling On-Demand capacity.

lowest-price - EC2 Fleet uses price to determine the order, launching the lowest price first.

prioritized - EC2 Fleet uses the priority that you assigned to each launch template override, launching the highest priority first.

Default: lowest-price

capacity_reservation_options instance-attribute

capacity_reservation_options: NotRequired[CapacityReservationOptionsRequest]

The strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.

Supported only for fleets of type instant.

max_total_price instance-attribute

max_total_price: NotRequired[String]

The maximum amount per hour for On-Demand Instances that you're willing to pay.

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 MaxTotalPrice does not account for surplus credits, and, if you use surplus credits, your final cost might be higher than what you specified for MaxTotalPrice. For more information, see Surplus credits can incur charges in the Amazon EC2 User Guide.

min_target_capacity instance-attribute

min_target_capacity: NotRequired[Integer]

The minimum target capacity for On-Demand Instances in the fleet. If this minimum capacity isn't reached, no instances are launched.

Constraints: Maximum value of 1000. Supported only for fleets of type instant.

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

single_availability_zone instance-attribute

single_availability_zone: NotRequired[Boolean]

Indicates that the fleet launches all On-Demand Instances into a single Availability Zone.

Supported only for fleets of type instant.

single_instance_type instance-attribute

single_instance_type: NotRequired[Boolean]

Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the fleet.

Supported only for fleets of type instant.