software.amazon.awssdk.services.ec2.model

Interface SpotFleetRequestConfigData.Builder

All Superinterfaces:

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

Enclosing class:

SpotFleetRequestConfigData

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

Method Summary

Modifier and Type	Method and Description
SpotFleetRequestConfigData.Builder	allocationStrategy(AllocationStrategy allocationStrategy) Indicates how to allocate the target capacity across the Spot pools specified by the Spot Fleet request.
SpotFleetRequestConfigData.Builder	allocationStrategy(String allocationStrategy) Indicates how to allocate the target capacity across the Spot pools specified by the Spot Fleet request.
SpotFleetRequestConfigData.Builder	clientToken(String clientToken) A unique, case-sensitive identifier that you provide to ensure the idempotency of your listings.
SpotFleetRequestConfigData.Builder	excessCapacityTerminationPolicy(ExcessCapacityTerminationPolicy excessCapacityTerminationPolicy) Indicates whether running Spot Instances should be terminated if the target capacity of the Spot Fleet request is decreased below the current size of the Spot Fleet.
SpotFleetRequestConfigData.Builder	excessCapacityTerminationPolicy(String excessCapacityTerminationPolicy) Indicates whether running Spot Instances should be terminated if the target capacity of the Spot Fleet request is decreased below the current size of the Spot Fleet.
SpotFleetRequestConfigData.Builder	fulfilledCapacity(Double fulfilledCapacity) The number of units fulfilled by this request compared to the set target capacity.
SpotFleetRequestConfigData.Builder	iamFleetRole(String iamFleetRole) Grants the Spot Fleet permission to 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.
SpotFleetRequestConfigData.Builder	instanceInterruptionBehavior(InstanceInterruptionBehavior instanceInterruptionBehavior) The behavior when a Spot Instance is interrupted.
SpotFleetRequestConfigData.Builder	instanceInterruptionBehavior(String instanceInterruptionBehavior) The behavior when a Spot Instance is interrupted.
SpotFleetRequestConfigData.Builder	instancePoolsToUseCount(Integer instancePoolsToUseCount) The number of Spot pools across which to allocate your target Spot capacity.
SpotFleetRequestConfigData.Builder	launchSpecifications(Collection<SpotFleetLaunchSpecification> launchSpecifications) The launch specifications for the Spot Fleet request.
SpotFleetRequestConfigData.Builder	launchSpecifications(Consumer<SpotFleetLaunchSpecification.Builder>... launchSpecifications) The launch specifications for the Spot Fleet request.
SpotFleetRequestConfigData.Builder	launchSpecifications(SpotFleetLaunchSpecification... launchSpecifications) The launch specifications for the Spot Fleet request.
SpotFleetRequestConfigData.Builder	launchTemplateConfigs(Collection<LaunchTemplateConfig> launchTemplateConfigs) The launch template and overrides.
SpotFleetRequestConfigData.Builder	launchTemplateConfigs(Consumer<LaunchTemplateConfig.Builder>... launchTemplateConfigs) The launch template and overrides.
SpotFleetRequestConfigData.Builder	launchTemplateConfigs(LaunchTemplateConfig... launchTemplateConfigs) The launch template and overrides.
default SpotFleetRequestConfigData.Builder	loadBalancersConfig(Consumer<LoadBalancersConfig.Builder> loadBalancersConfig) One or more Classic Load Balancers and target groups to attach to the Spot Fleet request.
SpotFleetRequestConfigData.Builder	loadBalancersConfig(LoadBalancersConfig loadBalancersConfig) One or more Classic Load Balancers and target groups to attach to the Spot Fleet request.
SpotFleetRequestConfigData.Builder	onDemandAllocationStrategy(OnDemandAllocationStrategy onDemandAllocationStrategy) The order of the launch template overrides to use in fulfilling On-Demand capacity.
SpotFleetRequestConfigData.Builder	onDemandAllocationStrategy(String onDemandAllocationStrategy) The order of the launch template overrides to use in fulfilling On-Demand capacity.
SpotFleetRequestConfigData.Builder	onDemandFulfilledCapacity(Double onDemandFulfilledCapacity) The number of On-Demand units fulfilled by this request compared to the set target On-Demand capacity.
SpotFleetRequestConfigData.Builder	onDemandTargetCapacity(Integer onDemandTargetCapacity) The number of On-Demand units to request.
SpotFleetRequestConfigData.Builder	replaceUnhealthyInstances(Boolean replaceUnhealthyInstances) Indicates whether Spot Fleet should replace unhealthy instances.
SpotFleetRequestConfigData.Builder	spotPrice(String spotPrice) The maximum price per unit hour that you are willing to pay for a Spot Instance.
SpotFleetRequestConfigData.Builder	targetCapacity(Integer targetCapacity) The number of units to request.
SpotFleetRequestConfigData.Builder	terminateInstancesWithExpiration(Boolean terminateInstancesWithExpiration) Indicates whether running Spot Instances should be terminated when the Spot Fleet request expires.
SpotFleetRequestConfigData.Builder	type(FleetType type) The type of request.
SpotFleetRequestConfigData.Builder	type(String type) The type of request.
SpotFleetRequestConfigData.Builder	validFrom(Instant validFrom) The start date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
SpotFleetRequestConfigData.Builder	validUntil(Instant validUntil) The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

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

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

SpotFleetRequestConfigData.Builder allocationStrategy(String allocationStrategy)

Indicates how to allocate the target capacity across the Spot pools specified by the Spot Fleet request. The default is lowestPrice.

Parameters:

allocationStrategy - Indicates how to allocate the target capacity across the Spot pools specified by the Spot Fleet request. The default is lowestPrice.

Returns:

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

See Also:

AllocationStrategy, AllocationStrategy

allocationStrategy

SpotFleetRequestConfigData.Builder allocationStrategy(AllocationStrategy allocationStrategy)

Indicates how to allocate the target capacity across the Spot pools specified by the Spot Fleet request. The default is lowestPrice.

Parameters:

allocationStrategy - Indicates how to allocate the target capacity across the Spot pools specified by the Spot Fleet request. The default is lowestPrice.

Returns:

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

See Also:

AllocationStrategy, AllocationStrategy

onDemandAllocationStrategy

SpotFleetRequestConfigData.Builder onDemandAllocationStrategy(String onDemandAllocationStrategy)

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.

Parameters:

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

Returns:

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

See Also:

OnDemandAllocationStrategy, OnDemandAllocationStrategy

onDemandAllocationStrategy

SpotFleetRequestConfigData.Builder onDemandAllocationStrategy(OnDemandAllocationStrategy onDemandAllocationStrategy)

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.

Parameters:

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

Returns:

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

See Also:

OnDemandAllocationStrategy, OnDemandAllocationStrategy

clientToken

SpotFleetRequestConfigData.Builder clientToken(String clientToken)

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.

Parameters:

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

Returns:

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

excessCapacityTerminationPolicy

SpotFleetRequestConfigData.Builder excessCapacityTerminationPolicy(String excessCapacityTerminationPolicy)

Indicates whether running Spot Instances should be terminated if the target capacity of the Spot Fleet request is decreased below the current size of the Spot Fleet.

Parameters:

excessCapacityTerminationPolicy - Indicates whether running Spot Instances should be terminated if the target capacity of the Spot Fleet request is decreased below the current size of the Spot Fleet.

Returns:

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

See Also:

ExcessCapacityTerminationPolicy, ExcessCapacityTerminationPolicy

excessCapacityTerminationPolicy

SpotFleetRequestConfigData.Builder excessCapacityTerminationPolicy(ExcessCapacityTerminationPolicy excessCapacityTerminationPolicy)

Indicates whether running Spot Instances should be terminated if the target capacity of the Spot Fleet request is decreased below the current size of the Spot Fleet.

Parameters:

excessCapacityTerminationPolicy - Indicates whether running Spot Instances should be terminated if the target capacity of the Spot Fleet request is decreased below the current size of the Spot Fleet.

Returns:

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

See Also:

ExcessCapacityTerminationPolicy, ExcessCapacityTerminationPolicy

fulfilledCapacity

SpotFleetRequestConfigData.Builder fulfilledCapacity(Double fulfilledCapacity)

The number of units fulfilled by this request compared to the set target capacity. You cannot set this value.

Parameters:

fulfilledCapacity - The number of units fulfilled by this request compared to the set target capacity. You cannot set this value.

Returns:

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

onDemandFulfilledCapacity

SpotFleetRequestConfigData.Builder onDemandFulfilledCapacity(Double onDemandFulfilledCapacity)

The number of On-Demand units fulfilled by this request compared to the set target On-Demand capacity.

Parameters:

onDemandFulfilledCapacity - The number of On-Demand units fulfilled by this request compared to the set target On-Demand capacity.

Returns:

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

iamFleetRole

SpotFleetRequestConfigData.Builder iamFleetRole(String iamFleetRole)

Grants the Spot Fleet permission to 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.

Parameters:

iamFleetRole - Grants the Spot Fleet permission to 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.

Returns:

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

launchSpecifications

SpotFleetRequestConfigData.Builder launchSpecifications(Collection<SpotFleetLaunchSpecification> launchSpecifications)

The launch specifications for the Spot Fleet request.

Parameters:

launchSpecifications - The launch specifications for the Spot Fleet request.

Returns:

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

launchSpecifications

SpotFleetRequestConfigData.Builder launchSpecifications(SpotFleetLaunchSpecification... launchSpecifications)

The launch specifications for the Spot Fleet request.

Parameters:

launchSpecifications - The launch specifications for the Spot Fleet request.

Returns:

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

launchSpecifications

SpotFleetRequestConfigData.Builder launchSpecifications(Consumer<SpotFleetLaunchSpecification.Builder>... launchSpecifications)

The launch specifications for the Spot Fleet request.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #launchSpecifications(List).

Parameters:

launchSpecifications - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#launchSpecifications(List)

launchTemplateConfigs

SpotFleetRequestConfigData.Builder launchTemplateConfigs(Collection<LaunchTemplateConfig> launchTemplateConfigs)

The launch template and overrides.

Parameters:

launchTemplateConfigs - The launch template and overrides.

Returns:

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

launchTemplateConfigs

SpotFleetRequestConfigData.Builder launchTemplateConfigs(LaunchTemplateConfig... launchTemplateConfigs)

The launch template and overrides.

Parameters:

launchTemplateConfigs - The launch template and overrides.

Returns:

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

launchTemplateConfigs

SpotFleetRequestConfigData.Builder launchTemplateConfigs(Consumer<LaunchTemplateConfig.Builder>... launchTemplateConfigs)

The launch template and overrides.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #launchTemplateConfigs(List).

Parameters:

launchTemplateConfigs - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#launchTemplateConfigs(List)

spotPrice

SpotFleetRequestConfigData.Builder spotPrice(String spotPrice)

The maximum price per unit hour that you are willing to pay for a Spot Instance. The default is the On-Demand price.

Parameters:

spotPrice - The maximum price per unit hour that you are willing to pay for a Spot Instance. The default is the On-Demand price.

Returns:

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

targetCapacity

SpotFleetRequestConfigData.Builder targetCapacity(Integer targetCapacity)

The number of 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.

Parameters:

targetCapacity - The number of 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.

Returns:

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

onDemandTargetCapacity

SpotFleetRequestConfigData.Builder onDemandTargetCapacity(Integer onDemandTargetCapacity)

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.

Parameters:

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

Returns:

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

terminateInstancesWithExpiration

SpotFleetRequestConfigData.Builder terminateInstancesWithExpiration(Boolean terminateInstancesWithExpiration)

Indicates whether running Spot Instances should be terminated when the Spot Fleet request expires.

Parameters:

terminateInstancesWithExpiration - Indicates whether running Spot Instances should be terminated when the Spot Fleet request expires.

Returns:

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

type

SpotFleetRequestConfigData.Builder type(String type)

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. To maintain a certain target capacity, the Spot Fleet places the required requests to meet capacity and automatically replenishes any interrupted instances. Default: maintain.

Parameters:

type - 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. To maintain a certain target capacity, the Spot Fleet places the required requests to meet capacity and automatically replenishes any interrupted instances. Default: maintain.

Returns:

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

See Also:

FleetType, FleetType

type

SpotFleetRequestConfigData.Builder type(FleetType type)

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. To maintain a certain target capacity, the Spot Fleet places the required requests to meet capacity and automatically replenishes any interrupted instances. Default: maintain.

Parameters:

type - 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. To maintain a certain target capacity, the Spot Fleet places the required requests to meet capacity and automatically replenishes any interrupted instances. Default: maintain.

Returns:

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

See Also:

FleetType, FleetType

validFrom

SpotFleetRequestConfigData.Builder validFrom(Instant validFrom)

The start date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The default is to start fulfilling the request immediately.

Parameters:

validFrom - The start date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The default is to start fulfilling the request immediately.

Returns:

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

validUntil

SpotFleetRequestConfigData.Builder validUntil(Instant validUntil)

The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). At this point, no new Spot Instance requests are placed or able to fulfill the request. The default end date is 7 days from the current date.

Parameters:

validUntil - The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). At this point, no new Spot Instance requests are placed or able to fulfill the request. The default end date is 7 days from the current date.

Returns:

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

replaceUnhealthyInstances

SpotFleetRequestConfigData.Builder replaceUnhealthyInstances(Boolean replaceUnhealthyInstances)

Indicates whether Spot Fleet should replace unhealthy instances.

Parameters:

replaceUnhealthyInstances - Indicates whether Spot Fleet should replace unhealthy instances.

Returns:

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

instanceInterruptionBehavior

SpotFleetRequestConfigData.Builder instanceInterruptionBehavior(String instanceInterruptionBehavior)

The behavior when a Spot Instance is interrupted. The default is terminate.

Parameters:

instanceInterruptionBehavior - The behavior when a Spot Instance is interrupted. The default is terminate.

Returns:

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

See Also:

InstanceInterruptionBehavior, InstanceInterruptionBehavior

instanceInterruptionBehavior

SpotFleetRequestConfigData.Builder instanceInterruptionBehavior(InstanceInterruptionBehavior instanceInterruptionBehavior)

The behavior when a Spot Instance is interrupted. The default is terminate.

Parameters:

instanceInterruptionBehavior - The behavior when a Spot Instance is interrupted. The default is terminate.

Returns:

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

See Also:

InstanceInterruptionBehavior, InstanceInterruptionBehavior

loadBalancersConfig

SpotFleetRequestConfigData.Builder loadBalancersConfig(LoadBalancersConfig loadBalancersConfig)

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.

Parameters:

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

Returns:

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

loadBalancersConfig

default SpotFleetRequestConfigData.Builder loadBalancersConfig(Consumer<LoadBalancersConfig.Builder> loadBalancersConfig)

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.

This is a convenience that creates an instance of the LoadBalancersConfig.Builder avoiding the need to create one manually via LoadBalancersConfig.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to loadBalancersConfig(LoadBalancersConfig).

Parameters:

loadBalancersConfig - a consumer that will call methods on LoadBalancersConfig.Builder

Returns:

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

See Also:

loadBalancersConfig(LoadBalancersConfig)

instancePoolsToUseCount

SpotFleetRequestConfigData.Builder instancePoolsToUseCount(Integer instancePoolsToUseCount)

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.

Parameters:

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

Returns:

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