software.amazon.awssdk.services.ec2.model

Interface SpotOptions.Builder

All Superinterfaces:

Buildable, CopyableBuilder<SpotOptions.Builder,SpotOptions>, SdkBuilder<SpotOptions.Builder,SpotOptions>, SdkPojo

Enclosing class:

SpotOptions

public static interface SpotOptions.Builder
extends SdkPojo, CopyableBuilder<SpotOptions.Builder,SpotOptions>

Method Summary

Modifier and Type	Method and Description
SpotOptions.Builder	allocationStrategy(SpotAllocationStrategy 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.
SpotOptions.Builder	allocationStrategy(String 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.
SpotOptions.Builder	instanceInterruptionBehavior(SpotInstanceInterruptionBehavior instanceInterruptionBehavior) The behavior when a Spot Instance is interrupted.
SpotOptions.Builder	instanceInterruptionBehavior(String instanceInterruptionBehavior) The behavior when a Spot Instance is interrupted.
SpotOptions.Builder	instancePoolsToUseCount(Integer instancePoolsToUseCount) The number of Spot pools across which to allocate your target Spot capacity.
default SpotOptions.Builder	maintenanceStrategies(Consumer<FleetSpotMaintenanceStrategies.Builder> maintenanceStrategies) The strategies for managing your workloads on your Spot Instances that will be interrupted.
SpotOptions.Builder	maintenanceStrategies(FleetSpotMaintenanceStrategies maintenanceStrategies) The strategies for managing your workloads on your Spot Instances that will be interrupted.
SpotOptions.Builder	maxTotalPrice(String maxTotalPrice) The maximum amount per hour for Spot Instances that you're willing to pay.
SpotOptions.Builder	minTargetCapacity(Integer minTargetCapacity) The minimum target capacity for Spot Instances in the fleet.
SpotOptions.Builder	singleAvailabilityZone(Boolean singleAvailabilityZone) Indicates that the fleet launches all Spot Instances into a single Availability Zone.
SpotOptions.Builder	singleInstanceType(Boolean singleInstanceType) Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

allocationStrategy

SpotOptions.Builder allocationStrategy(String 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.

lowest-price - EC2 Fleet launches instances from the lowest-price Spot Instance pool that has available capacity. If the cheapest pool doesn't have available capacity, the Spot Instances come from the next cheapest 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 cheapest pool. To ensure that your desired capacity is met, you might receive Spot Instances from several pools.

diversified - EC2 Fleet launches instances from all of the Spot Instance pools that you specify.

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.

Default: lowest-price

Parameters:

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.

lowest-price - EC2 Fleet launches instances from the lowest-price Spot Instance pool that has available capacity. If the cheapest pool doesn't have available capacity, the Spot Instances come from the next cheapest 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 cheapest pool. To ensure that your desired capacity is met, you might receive Spot Instances from several pools.

diversified - EC2 Fleet launches instances from all of the Spot Instance pools that you specify.

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.

Default: lowest-price

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SpotAllocationStrategy, SpotAllocationStrategy

allocationStrategy

SpotOptions.Builder allocationStrategy(SpotAllocationStrategy 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.

lowest-price - EC2 Fleet launches instances from the lowest-price Spot Instance pool that has available capacity. If the cheapest pool doesn't have available capacity, the Spot Instances come from the next cheapest 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 cheapest pool. To ensure that your desired capacity is met, you might receive Spot Instances from several pools.

diversified - EC2 Fleet launches instances from all of the Spot Instance pools that you specify.

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.

Default: lowest-price

Parameters:

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.

lowest-price - EC2 Fleet launches instances from the lowest-price Spot Instance pool that has available capacity. If the cheapest pool doesn't have available capacity, the Spot Instances come from the next cheapest 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 cheapest pool. To ensure that your desired capacity is met, you might receive Spot Instances from several pools.

diversified - EC2 Fleet launches instances from all of the Spot Instance pools that you specify.

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.

Default: lowest-price

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SpotAllocationStrategy, SpotAllocationStrategy

maintenanceStrategies

SpotOptions.Builder maintenanceStrategies(FleetSpotMaintenanceStrategies maintenanceStrategies)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

maintenanceStrategies

default SpotOptions.Builder maintenanceStrategies(Consumer<FleetSpotMaintenanceStrategies.Builder> maintenanceStrategies)

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

This is a convenience method that creates an instance of the FleetSpotMaintenanceStrategies.Builder avoiding the need to create one manually via FleetSpotMaintenanceStrategies.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to maintenanceStrategies(FleetSpotMaintenanceStrategies).

Parameters:

maintenanceStrategies - a consumer that will call methods on FleetSpotMaintenanceStrategies.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

maintenanceStrategies(FleetSpotMaintenanceStrategies)

instanceInterruptionBehavior

SpotOptions.Builder instanceInterruptionBehavior(String instanceInterruptionBehavior)

The behavior when a Spot Instance is interrupted.

Default: terminate

Parameters:

instanceInterruptionBehavior - The behavior when a Spot Instance is interrupted.

Default: terminate

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SpotInstanceInterruptionBehavior, SpotInstanceInterruptionBehavior

instanceInterruptionBehavior

SpotOptions.Builder instanceInterruptionBehavior(SpotInstanceInterruptionBehavior instanceInterruptionBehavior)

The behavior when a Spot Instance is interrupted.

Default: terminate

Parameters:

instanceInterruptionBehavior - The behavior when a Spot Instance is interrupted.

Default: terminate

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SpotInstanceInterruptionBehavior, SpotInstanceInterruptionBehavior

instancePoolsToUseCount

SpotOptions.Builder instancePoolsToUseCount(Integer 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

singleInstanceType

SpotOptions.Builder singleInstanceType(Boolean 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

singleAvailabilityZone

SpotOptions.Builder singleAvailabilityZone(Boolean singleAvailabilityZone)

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

Supported only for fleets of type instant.

Parameters:

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

Supported only for fleets of type instant.

Returns:

Returns a reference to this object so that method calls can be chained together.

minTargetCapacity

SpotOptions.Builder minTargetCapacity(Integer 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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

maxTotalPrice

SpotOptions.Builder maxTotalPrice(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.