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
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description SpotFleetRequestConfigData.Builder
allocationStrategy(String allocationStrategy)
The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the Spot Fleet launch configuration.SpotFleetRequestConfigData.Builder
allocationStrategy(AllocationStrategy allocationStrategy)
The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the Spot Fleet launch configuration.SpotFleetRequestConfigData.Builder
clientToken(String clientToken)
A unique, case-sensitive identifier that you provide to ensure the idempotency of your listings.SpotFleetRequestConfigData.Builder
context(String context)
Reserved.SpotFleetRequestConfigData.Builder
excessCapacityTerminationPolicy(String excessCapacityTerminationPolicy)
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.SpotFleetRequestConfigData.Builder
excessCapacityTerminationPolicy(ExcessCapacityTerminationPolicy excessCapacityTerminationPolicy)
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.SpotFleetRequestConfigData.Builder
fulfilledCapacity(Double fulfilledCapacity)
The number of units fulfilled by this request compared to the set target capacity.SpotFleetRequestConfigData.Builder
iamFleetRole(String iamFleetRole)
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.SpotFleetRequestConfigData.Builder
instanceInterruptionBehavior(String instanceInterruptionBehavior)
The behavior when a Spot Instance is interrupted.SpotFleetRequestConfigData.Builder
instanceInterruptionBehavior(InstanceInterruptionBehavior 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(String onDemandAllocationStrategy)
The order of the launch template overrides to use in fulfilling On-Demand capacity.SpotFleetRequestConfigData.Builder
onDemandAllocationStrategy(OnDemandAllocationStrategy 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
onDemandMaxTotalPrice(String onDemandMaxTotalPrice)
The maximum amount per hour for On-Demand Instances that you're willing to pay.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.default SpotFleetRequestConfigData.Builder
spotMaintenanceStrategies(Consumer<SpotMaintenanceStrategies.Builder> spotMaintenanceStrategies)
The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.SpotFleetRequestConfigData.Builder
spotMaintenanceStrategies(SpotMaintenanceStrategies spotMaintenanceStrategies)
The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.SpotFleetRequestConfigData.Builder
spotMaxTotalPrice(String spotMaxTotalPrice)
The maximum amount per hour for Spot Instances that you're willing to pay.SpotFleetRequestConfigData.Builder
spotPrice(String spotPrice)
The maximum price per unit hour that you are willing to pay for a Spot Instance.SpotFleetRequestConfigData.Builder
tagSpecifications(Collection<TagSpecification> tagSpecifications)
The key-value pair for tagging the Spot Fleet request on creation.SpotFleetRequestConfigData.Builder
tagSpecifications(Consumer<TagSpecification.Builder>... tagSpecifications)
The key-value pair for tagging the Spot Fleet request on creation.SpotFleetRequestConfigData.Builder
tagSpecifications(TagSpecification... tagSpecifications)
The key-value pair for tagging the Spot Fleet request on creation.SpotFleetRequestConfigData.Builder
targetCapacity(Integer targetCapacity)
The number of units to request for the Spot Fleet.SpotFleetRequestConfigData.Builder
targetCapacityUnitType(String targetCapacityUnitType)
The unit for the target capacity.SpotFleetRequestConfigData.Builder
targetCapacityUnitType(TargetCapacityUnitType targetCapacityUnitType)
The unit for the target capacity.SpotFleetRequestConfigData.Builder
terminateInstancesWithExpiration(Boolean terminateInstancesWithExpiration)
Indicates whether running Spot Instances are terminated when the Spot Fleet request expires.SpotFleetRequestConfigData.Builder
type(String type)
The type of request.SpotFleetRequestConfigData.Builder
type(FleetType type)
The type of request.SpotFleetRequestConfigData.Builder
validFrom(Instant validFrom)
The start date and time of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ).SpotFleetRequestConfigData.Builder
validUntil(Instant validUntil)
The end date and time of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ).-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
allocationStrategy
SpotFleetRequestConfigData.Builder allocationStrategy(String allocationStrategy)
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 thePriority
parameter forLaunchTemplateOverrides
. You can assign the same priority to differentLaunchTemplateOverrides
. EC2 implements the priorities on a best-effort basis, but optimizes for capacity first.capacityOptimizedPrioritized
is supported only if your Spot Fleet uses a launch template. Note that if theOnDemandAllocationStrategy
is 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
-
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
- Parameters:
allocationStrategy
- 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 thePriority
parameter forLaunchTemplateOverrides
. You can assign the same priority to differentLaunchTemplateOverrides
. EC2 implements the priorities on a best-effort basis, but optimizes for capacity first.capacityOptimizedPrioritized
is supported only if your Spot Fleet uses a launch template. Note that if theOnDemandAllocationStrategy
is 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
-
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
- 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)
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 thePriority
parameter forLaunchTemplateOverrides
. You can assign the same priority to differentLaunchTemplateOverrides
. EC2 implements the priorities on a best-effort basis, but optimizes for capacity first.capacityOptimizedPrioritized
is supported only if your Spot Fleet uses a launch template. Note that if theOnDemandAllocationStrategy
is 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
-
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
- Parameters:
allocationStrategy
- 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 thePriority
parameter forLaunchTemplateOverrides
. You can assign the same priority to differentLaunchTemplateOverrides
. EC2 implements the priorities on a best-effort basis, but optimizes for capacity first.capacityOptimizedPrioritized
is supported only if your Spot Fleet uses a launch template. Note that if theOnDemandAllocationStrategy
is 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
-
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
- 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 specifyprioritized
, 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 tolowestPrice
.- Parameters:
onDemandAllocationStrategy
- The order of the launch template overrides to use in fulfilling On-Demand capacity. If you specifylowestPrice
, Spot Fleet uses price to determine the order, launching the lowest price first. If you specifyprioritized
, 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 tolowestPrice
.- 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 specifyprioritized
, 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 tolowestPrice
.- Parameters:
onDemandAllocationStrategy
- The order of the launch template overrides to use in fulfilling On-Demand capacity. If you specifylowestPrice
, Spot Fleet uses price to determine the order, launching the lowest price first. If you specifyprioritized
, 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 tolowestPrice
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
OnDemandAllocationStrategy
,OnDemandAllocationStrategy
-
spotMaintenanceStrategies
SpotFleetRequestConfigData.Builder spotMaintenanceStrategies(SpotMaintenanceStrategies spotMaintenanceStrategies)
The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.
- Parameters:
spotMaintenanceStrategies
- The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
spotMaintenanceStrategies
default SpotFleetRequestConfigData.Builder spotMaintenanceStrategies(Consumer<SpotMaintenanceStrategies.Builder> spotMaintenanceStrategies)
The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.
This is a convenience method that creates an instance of theSpotMaintenanceStrategies.Builder
avoiding the need to create one manually viaSpotMaintenanceStrategies.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tospotMaintenanceStrategies(SpotMaintenanceStrategies)
.- Parameters:
spotMaintenanceStrategies
- a consumer that will call methods onSpotMaintenanceStrategies.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
spotMaintenanceStrategies(SpotMaintenanceStrategies)
-
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 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
.- Parameters:
excessCapacityTerminationPolicy
- 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
.- 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 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
.- Parameters:
excessCapacityTerminationPolicy
- 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
.- 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)
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
.- Parameters:
iamFleetRole
- 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 setTerminateInstancesWithExpiration
.- 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. If you specify
LaunchSpecifications
, you can't specifyLaunchTemplateConfigs
. If you include On-Demand capacity in your request, you must useLaunchTemplateConfigs
.- Parameters:
launchSpecifications
- The launch specifications for the Spot Fleet request. If you specifyLaunchSpecifications
, you can't specifyLaunchTemplateConfigs
. If you include On-Demand capacity in your request, you must useLaunchTemplateConfigs
.- 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. If you specify
LaunchSpecifications
, you can't specifyLaunchTemplateConfigs
. If you include On-Demand capacity in your request, you must useLaunchTemplateConfigs
.- Parameters:
launchSpecifications
- The launch specifications for the Spot Fleet request. If you specifyLaunchSpecifications
, you can't specifyLaunchTemplateConfigs
. If you include On-Demand capacity in your request, you must useLaunchTemplateConfigs
.- 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. If you specify
This is a convenience method that creates an instance of theLaunchSpecifications
, you can't specifyLaunchTemplateConfigs
. If you include On-Demand capacity in your request, you must useLaunchTemplateConfigs
.SpotFleetLaunchSpecification.Builder
avoiding the need to create one manually viaSpotFleetLaunchSpecification.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#launchSpecifications(List
.) - Parameters:
launchSpecifications
- a consumer that will call methods onSpotFleetLaunchSpecification.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#launchSpecifications(java.util.Collection
)
-
launchTemplateConfigs
SpotFleetRequestConfigData.Builder launchTemplateConfigs(Collection<LaunchTemplateConfig> launchTemplateConfigs)
The launch template and overrides. If you specify
LaunchTemplateConfigs
, you can't specifyLaunchSpecifications
. If you include On-Demand capacity in your request, you must useLaunchTemplateConfigs
.- Parameters:
launchTemplateConfigs
- The launch template and overrides. If you specifyLaunchTemplateConfigs
, you can't specifyLaunchSpecifications
. If you include On-Demand capacity in your request, you must useLaunchTemplateConfigs
.- 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. If you specify
LaunchTemplateConfigs
, you can't specifyLaunchSpecifications
. If you include On-Demand capacity in your request, you must useLaunchTemplateConfigs
.- Parameters:
launchTemplateConfigs
- The launch template and overrides. If you specifyLaunchTemplateConfigs
, you can't specifyLaunchSpecifications
. If you include On-Demand capacity in your request, you must useLaunchTemplateConfigs
.- 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. If you specify
This is a convenience method that creates an instance of theLaunchTemplateConfigs
, you can't specifyLaunchSpecifications
. If you include On-Demand capacity in your request, you must useLaunchTemplateConfigs
.LaunchTemplateConfig.Builder
avoiding the need to create one manually viaLaunchTemplateConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#launchTemplateConfigs(List
.) - Parameters:
launchTemplateConfigs
- a consumer that will call methods onLaunchTemplateConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#launchTemplateConfigs(java.util.Collection
)
-
spotPrice
SpotFleetRequestConfigData.Builder spotPrice(String spotPrice)
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.
If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.
- Parameters:
spotPrice
- 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.If you specify a maximum price, your 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.
-
targetCapacity
SpotFleetRequestConfigData.Builder targetCapacity(Integer targetCapacity)
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.- Parameters:
targetCapacity
- 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 ismaintain
, 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 ismaintain
, 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.
-
onDemandMaxTotalPrice
SpotFleetRequestConfigData.Builder onDemandMaxTotalPrice(String onDemandMaxTotalPrice)
The maximum amount per hour for On-Demand Instances that you're willing to pay. You can use the
onDemandMaxTotalPrice
parameter, thespotMaxTotalPrice
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.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. TheonDemandMaxTotalPrice
does not account for surplus credits, and, if you use surplus credits, your final cost might be higher than what you specified foronDemandMaxTotalPrice
. For more information, see Surplus credits can incur charges in the EC2 User Guide.- Parameters:
onDemandMaxTotalPrice
- The maximum amount per hour for On-Demand Instances that you're willing to pay. You can use theonDemandMaxTotalPrice
parameter, thespotMaxTotalPrice
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.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. TheonDemandMaxTotalPrice
does not account for surplus credits, and, if you use surplus credits, your final cost might be higher than what you specified foronDemandMaxTotalPrice
. 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.
-
spotMaxTotalPrice
SpotFleetRequestConfigData.Builder spotMaxTotalPrice(String spotMaxTotalPrice)
The maximum amount per hour for Spot Instances that you're willing to pay. You can use the
spotMaxTotalPrice
parameter, theonDemandMaxTotalPrice
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.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. ThespotMaxTotalPrice
does not account for surplus credits, and, if you use surplus credits, your final cost might be higher than what you specified forspotMaxTotalPrice
. For more information, see Surplus credits can incur charges in the EC2 User Guide.- Parameters:
spotMaxTotalPrice
- The maximum amount per hour for Spot Instances that you're willing to pay. You can use thespotMaxTotalPrice
parameter, theonDemandMaxTotalPrice
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.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. ThespotMaxTotalPrice
does not account for surplus credits, and, if you use surplus credits, your final cost might be higher than what you specified forspotMaxTotalPrice
. 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.
-
terminateInstancesWithExpiration
SpotFleetRequestConfigData.Builder terminateInstancesWithExpiration(Boolean terminateInstancesWithExpiration)
Indicates whether running Spot Instances are terminated when the Spot Fleet request expires.
- Parameters:
terminateInstancesWithExpiration
- Indicates whether running Spot Instances are 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. When this value ismaintain
, 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.- 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 isrequest
, 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 ismaintain
, 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.- 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. When this value ismaintain
, 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.- 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 isrequest
, 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 ismaintain
, 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.- 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 (YYYY-MM-DDTHH:MM:SSZ). By default, Amazon EC2 starts fulfilling the request immediately.
- Parameters:
validFrom
- 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.- 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 (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.
- Parameters:
validUntil
- 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.- 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 isterminate
.- 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 isterminate
.- 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 method that creates an instance of theLoadBalancersConfig.Builder
avoiding the need to create one manually viaLoadBalancersConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toloadBalancersConfig(LoadBalancersConfig)
.- Parameters:
loadBalancersConfig
- a consumer that will call methods onLoadBalancersConfig.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.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.
- Parameters:
instancePoolsToUseCount
- The number of Spot pools across which to allocate your target Spot capacity. Valid only when Spot AllocationStrategy is set tolowest-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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
context
SpotFleetRequestConfigData.Builder context(String context)
Reserved.
- Parameters:
context
- Reserved.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
targetCapacityUnitType
SpotFleetRequestConfigData.Builder targetCapacityUnitType(String targetCapacityUnitType)
The unit for the target capacity.
TargetCapacityUnitType
can only be specified whenInstanceRequirements
is specified.Default:
units
(translates to number of instances)- Parameters:
targetCapacityUnitType
- The unit for the target capacity.TargetCapacityUnitType
can only be specified whenInstanceRequirements
is specified.Default:
units
(translates to number of instances)- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
TargetCapacityUnitType
,TargetCapacityUnitType
-
targetCapacityUnitType
SpotFleetRequestConfigData.Builder targetCapacityUnitType(TargetCapacityUnitType targetCapacityUnitType)
The unit for the target capacity.
TargetCapacityUnitType
can only be specified whenInstanceRequirements
is specified.Default:
units
(translates to number of instances)- Parameters:
targetCapacityUnitType
- The unit for the target capacity.TargetCapacityUnitType
can only be specified whenInstanceRequirements
is specified.Default:
units
(translates to number of instances)- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
TargetCapacityUnitType
,TargetCapacityUnitType
-
tagSpecifications
SpotFleetRequestConfigData.Builder tagSpecifications(Collection<TagSpecification> tagSpecifications)
The key-value pair for tagging the Spot Fleet request on creation. The value for
ResourceType
must bespot-fleet-request
, otherwise the Spot Fleet request fails. To tag instances at launch, specify the tags in the launch template (valid only if you useLaunchTemplateConfigs
) or in theSpotFleetTagSpecification
(valid only if you useLaunchSpecifications
). For information about tagging after launch, see Tag your resources.- Parameters:
tagSpecifications
- The key-value pair for tagging the Spot Fleet request on creation. The value forResourceType
must bespot-fleet-request
, otherwise the Spot Fleet request fails. To tag instances at launch, specify the tags in the launch template (valid only if you useLaunchTemplateConfigs
) or in theSpotFleetTagSpecification
(valid only if you useLaunchSpecifications
). For information about tagging after launch, see Tag your resources.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tagSpecifications
SpotFleetRequestConfigData.Builder tagSpecifications(TagSpecification... tagSpecifications)
The key-value pair for tagging the Spot Fleet request on creation. The value for
ResourceType
must bespot-fleet-request
, otherwise the Spot Fleet request fails. To tag instances at launch, specify the tags in the launch template (valid only if you useLaunchTemplateConfigs
) or in theSpotFleetTagSpecification
(valid only if you useLaunchSpecifications
). For information about tagging after launch, see Tag your resources.- Parameters:
tagSpecifications
- The key-value pair for tagging the Spot Fleet request on creation. The value forResourceType
must bespot-fleet-request
, otherwise the Spot Fleet request fails. To tag instances at launch, specify the tags in the launch template (valid only if you useLaunchTemplateConfigs
) or in theSpotFleetTagSpecification
(valid only if you useLaunchSpecifications
). For information about tagging after launch, see Tag your resources.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tagSpecifications
SpotFleetRequestConfigData.Builder tagSpecifications(Consumer<TagSpecification.Builder>... tagSpecifications)
The key-value pair for tagging the Spot Fleet request on creation. The value for
This is a convenience method that creates an instance of theResourceType
must bespot-fleet-request
, otherwise the Spot Fleet request fails. To tag instances at launch, specify the tags in the launch template (valid only if you useLaunchTemplateConfigs
) or in theSpotFleetTagSpecification
(valid only if you useLaunchSpecifications
). For information about tagging after launch, see Tag your resources.TagSpecification.Builder
avoiding the need to create one manually viaTagSpecification.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#tagSpecifications(List
.) - Parameters:
tagSpecifications
- a consumer that will call methods onTagSpecification.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#tagSpecifications(java.util.Collection
)
-
-