software.amazon.awssdk.services.ec2.model

Interface OnDemandOptions.Builder

All Superinterfaces:

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

Enclosing class:

OnDemandOptions

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

Method Summary

Modifier and Type	Method and Description
OnDemandOptions.Builder	allocationStrategy(FleetOnDemandAllocationStrategy allocationStrategy) The strategy that determines the order of the launch template overrides to use in fulfilling On-Demand capacity.
OnDemandOptions.Builder	allocationStrategy(String allocationStrategy) The strategy that determines the order of the launch template overrides to use in fulfilling On-Demand capacity.
OnDemandOptions.Builder	capacityReservationOptions(CapacityReservationOptions capacityReservationOptions) The strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.
default OnDemandOptions.Builder	capacityReservationOptions(Consumer<CapacityReservationOptions.Builder> capacityReservationOptions) The strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.
OnDemandOptions.Builder	maxTotalPrice(String maxTotalPrice) The maximum amount per hour for On-Demand Instances that you're willing to pay.
OnDemandOptions.Builder	minTargetCapacity(Integer minTargetCapacity) The minimum target capacity for On-Demand Instances in the fleet.
OnDemandOptions.Builder	singleAvailabilityZone(Boolean singleAvailabilityZone) Indicates that the fleet launches all On-Demand Instances into a single Availability Zone.
OnDemandOptions.Builder	singleInstanceType(Boolean singleInstanceType) Indicates that the fleet uses a single instance type to launch all On-Demand 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

OnDemandOptions.Builder allocationStrategy(String allocationStrategy)

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

Parameters:

allocationStrategy - 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

Returns:

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

See Also:

FleetOnDemandAllocationStrategy, FleetOnDemandAllocationStrategy

allocationStrategy

OnDemandOptions.Builder allocationStrategy(FleetOnDemandAllocationStrategy allocationStrategy)

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

Parameters:

allocationStrategy - 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

Returns:

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

See Also:

FleetOnDemandAllocationStrategy, FleetOnDemandAllocationStrategy

capacityReservationOptions

OnDemandOptions.Builder capacityReservationOptions(CapacityReservationOptions capacityReservationOptions)

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

Supported only for fleets of type instant.

Parameters:

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

Supported only for fleets of type instant.

Returns:

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

capacityReservationOptions

default OnDemandOptions.Builder capacityReservationOptions(Consumer<CapacityReservationOptions.Builder> capacityReservationOptions)

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

Supported only for fleets of type instant.

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

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

Parameters:

capacityReservationOptions - a consumer that will call methods on CapacityReservationOptions.Builder

Returns:

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

See Also:

capacityReservationOptions(CapacityReservationOptions)

singleInstanceType

OnDemandOptions.Builder singleInstanceType(Boolean singleInstanceType)

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.

Parameters:

singleInstanceType - 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.

Returns:

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

singleAvailabilityZone

OnDemandOptions.Builder singleAvailabilityZone(Boolean singleAvailabilityZone)

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

Supported only for fleets of type instant.

Parameters:

singleAvailabilityZone - Indicates that the fleet launches all On-Demand 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

OnDemandOptions.Builder minTargetCapacity(Integer minTargetCapacity)

The minimum target capacity for On-Demand 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 On-Demand 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

OnDemandOptions.Builder maxTotalPrice(String maxTotalPrice)

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 EC2 User Guide.

Parameters:

maxTotalPrice - 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 EC2 User Guide.

Returns:

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