Class CfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty>
- Enclosing interface:
CfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionallocationStrategy(String allocationStrategy) build()Builds the configured instance.Sets the value ofCfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.getContext()excessCapacityTerminationPolicy(String excessCapacityTerminationPolicy) iamFleetRole(String iamFleetRole) iamFleetRole(IRoleRef iamFleetRole) instanceInterruptionBehavior(String instanceInterruptionBehavior) instancePoolsToUseCount(Number instancePoolsToUseCount) launchSpecifications(List<? extends Object> launchSpecifications) launchSpecifications(IResolvable launchSpecifications) launchTemplateConfigs(List<? extends Object> launchTemplateConfigs) launchTemplateConfigs(IResolvable launchTemplateConfigs) loadBalancersConfig(CfnSpotFleetPropsMixin.LoadBalancersConfigProperty loadBalancersConfig) loadBalancersConfig(IResolvable loadBalancersConfig) onDemandAllocationStrategy(String onDemandAllocationStrategy) onDemandMaxTotalPrice(String onDemandMaxTotalPrice) onDemandTargetCapacity(Number onDemandTargetCapacity) replaceUnhealthyInstances(Boolean replaceUnhealthyInstances) replaceUnhealthyInstances(IResolvable replaceUnhealthyInstances) spotMaintenanceStrategies(CfnSpotFleetPropsMixin.SpotMaintenanceStrategiesProperty spotMaintenanceStrategies) spotMaintenanceStrategies(IResolvable spotMaintenanceStrategies) spotMaxTotalPrice(String spotMaxTotalPrice) Sets the value ofCfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.getSpotPrice()tagSpecifications(List<? extends Object> tagSpecifications) tagSpecifications(IResolvable tagSpecifications) targetCapacity(Number targetCapacity) targetCapacityUnitType(String targetCapacityUnitType) terminateInstancesWithExpiration(Boolean terminateInstancesWithExpiration) terminateInstancesWithExpiration(IResolvable terminateInstancesWithExpiration) Sets the value ofCfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.getType()Sets the value ofCfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.getValidFrom()validUntil(String validUntil)
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
allocationStrategy
@Stability(Stable) public CfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.Builder allocationStrategy(String allocationStrategy) - 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 thePriorityparameter forLaunchTemplateOverrides. You can assign the same priority to differentLaunchTemplateOverrides. EC2 implements the priorities on a best-effort basis, but optimizes for capacity first.capacityOptimizedPrioritizedis supported only if your Spot Fleet uses a launch template. Note that if theOnDemandAllocationStrategyis 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 (not recommended) - > We don't recommend the
lowestPriceallocation strategy because it has the highest risk of interruption for your Spot Instances.
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:
this
-
context
@Stability(Stable) public CfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.Builder context(String context) Sets the value ofCfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.getContext()- Parameters:
context- Reserved.- Returns:
this
-
excessCapacityTerminationPolicy
@Stability(Stable) public CfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.Builder excessCapacityTerminationPolicy(String excessCapacityTerminationPolicy) Sets the value ofCfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.getExcessCapacityTerminationPolicy()- Parameters:
excessCapacityTerminationPolicy- Indicates whether running Spot 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 typemaintain.- Returns:
this
-
iamFleetRole
@Stability(Stable) public CfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.Builder iamFleetRole(String iamFleetRole) - Parameters:
iamFleetRole- The Amazon Resource Name (ARN) of an AWS 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 or when the Spot Fleet request expires, if you setTerminateInstancesWithExpiration.- Returns:
this
-
iamFleetRole
@Stability(Stable) public CfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.Builder iamFleetRole(IRoleRef iamFleetRole) - Parameters:
iamFleetRole- The Amazon Resource Name (ARN) of an AWS 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 or when the Spot Fleet request expires, if you setTerminateInstancesWithExpiration.- Returns:
this
-
instanceInterruptionBehavior
@Stability(Stable) public CfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.Builder instanceInterruptionBehavior(String instanceInterruptionBehavior) Sets the value ofCfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.getInstanceInterruptionBehavior()- Parameters:
instanceInterruptionBehavior- The behavior when a Spot Instance is interrupted. The default isterminate.- Returns:
this
-
instancePoolsToUseCount
@Stability(Stable) public CfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.Builder instancePoolsToUseCount(Number instancePoolsToUseCount) Sets the value ofCfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.getInstancePoolsToUseCount()- 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:
this
-
launchSpecifications
@Stability(Stable) public CfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.Builder launchSpecifications(IResolvable launchSpecifications) Sets the value ofCfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.getLaunchSpecifications()- Parameters:
launchSpecifications- The launch specifications for the Spot Fleet request. If you specifyLaunchSpecifications, you can't specifyLaunchTemplateConfigs.- Returns:
this
-
launchSpecifications
@Stability(Stable) public CfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.Builder launchSpecifications(List<? extends Object> launchSpecifications) Sets the value ofCfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.getLaunchSpecifications()- Parameters:
launchSpecifications- The launch specifications for the Spot Fleet request. If you specifyLaunchSpecifications, you can't specifyLaunchTemplateConfigs.- Returns:
this
-
launchTemplateConfigs
@Stability(Stable) public CfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.Builder launchTemplateConfigs(IResolvable launchTemplateConfigs) Sets the value ofCfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.getLaunchTemplateConfigs()- Parameters:
launchTemplateConfigs- The launch template and overrides. If you specifyLaunchTemplateConfigs, you can't specifyLaunchSpecifications.- Returns:
this
-
launchTemplateConfigs
@Stability(Stable) public CfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.Builder launchTemplateConfigs(List<? extends Object> launchTemplateConfigs) Sets the value ofCfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.getLaunchTemplateConfigs()- Parameters:
launchTemplateConfigs- The launch template and overrides. If you specifyLaunchTemplateConfigs, you can't specifyLaunchSpecifications.- Returns:
this
-
loadBalancersConfig
@Stability(Stable) public CfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.Builder loadBalancersConfig(IResolvable loadBalancersConfig) Sets the value ofCfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.getLoadBalancersConfig()- 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:
this
-
loadBalancersConfig
@Stability(Stable) public CfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.Builder loadBalancersConfig(CfnSpotFleetPropsMixin.LoadBalancersConfigProperty loadBalancersConfig) Sets the value ofCfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.getLoadBalancersConfig()- 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:
this
-
onDemandAllocationStrategy
@Stability(Stable) public CfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.Builder onDemandAllocationStrategy(String onDemandAllocationStrategy) Sets the value ofCfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.getOnDemandAllocationStrategy()- 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:
this
-
onDemandMaxTotalPrice
@Stability(Stable) public CfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.Builder onDemandMaxTotalPrice(String onDemandMaxTotalPrice) Sets the value ofCfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.getOnDemandMaxTotalPrice()- Parameters:
onDemandMaxTotalPrice- The maximum amount per hour for On-Demand Instances that you're willing to pay. You can use theonDemandMaxTotalPriceparameter, thespotMaxTotalPriceparameter, 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. TheonDemandMaxTotalPricedoes 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 Amazon EC2 User Guide .- Returns:
this
-
onDemandTargetCapacity
@Stability(Stable) public CfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.Builder onDemandTargetCapacity(Number onDemandTargetCapacity) Sets the value ofCfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.getOnDemandTargetCapacity()- 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:
this
-
replaceUnhealthyInstances
@Stability(Stable) public CfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.Builder replaceUnhealthyInstances(Boolean replaceUnhealthyInstances) Sets the value ofCfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.getReplaceUnhealthyInstances()- Parameters:
replaceUnhealthyInstances- Indicates whether Spot Fleet should replace unhealthy instances.- Returns:
this
-
replaceUnhealthyInstances
@Stability(Stable) public CfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.Builder replaceUnhealthyInstances(IResolvable replaceUnhealthyInstances) Sets the value ofCfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.getReplaceUnhealthyInstances()- Parameters:
replaceUnhealthyInstances- Indicates whether Spot Fleet should replace unhealthy instances.- Returns:
this
-
spotMaintenanceStrategies
@Stability(Stable) public CfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.Builder spotMaintenanceStrategies(IResolvable spotMaintenanceStrategies) Sets the value ofCfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.getSpotMaintenanceStrategies()- Parameters:
spotMaintenanceStrategies- The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.- Returns:
this
-
spotMaintenanceStrategies
@Stability(Stable) public CfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.Builder spotMaintenanceStrategies(CfnSpotFleetPropsMixin.SpotMaintenanceStrategiesProperty spotMaintenanceStrategies) Sets the value ofCfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.getSpotMaintenanceStrategies()- Parameters:
spotMaintenanceStrategies- The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.- Returns:
this
-
spotMaxTotalPrice
@Stability(Stable) public CfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.Builder spotMaxTotalPrice(String spotMaxTotalPrice) - Parameters:
spotMaxTotalPrice- The maximum amount per hour for Spot Instances that you're willing to pay. You can use thespotMaxTotalPriceparameter, theonDemandMaxTotalPriceparameter, 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. ThespotMaxTotalPricedoes 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 Amazon EC2 User Guide .- Returns:
this
-
spotPrice
@Stability(Stable) public CfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.Builder spotPrice(String spotPrice) Sets the value ofCfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.getSpotPrice()- 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:
this
-
tagSpecifications
@Stability(Stable) public CfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.Builder tagSpecifications(IResolvable tagSpecifications) - Parameters:
tagSpecifications- The key-value pair for tagging the Spot Fleet request on creation. The value forResourceTypemust 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 the[SpotFleetTagSpecification](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotFleetTagSpecification.html)(valid only if you useLaunchSpecifications). For information about tagging after launch, see Tag your resources .- Returns:
this
-
tagSpecifications
@Stability(Stable) public CfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.Builder tagSpecifications(List<? extends Object> tagSpecifications) - Parameters:
tagSpecifications- The key-value pair for tagging the Spot Fleet request on creation. The value forResourceTypemust 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 the[SpotFleetTagSpecification](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotFleetTagSpecification.html)(valid only if you useLaunchSpecifications). For information about tagging after launch, see Tag your resources .- Returns:
this
-
targetCapacity
@Stability(Stable) public CfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.Builder targetCapacity(Number targetCapacity) - 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:
this
-
targetCapacityUnitType
@Stability(Stable) public CfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.Builder targetCapacityUnitType(String targetCapacityUnitType) Sets the value ofCfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.getTargetCapacityUnitType()- Parameters:
targetCapacityUnitType- The unit for the target capacity. You can specify this parameter only when using attribute-based instance type selection. Default:units(the number of instances)- Returns:
this
-
terminateInstancesWithExpiration
@Stability(Stable) public CfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.Builder terminateInstancesWithExpiration(Boolean terminateInstancesWithExpiration) Sets the value ofCfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.getTerminateInstancesWithExpiration()- Parameters:
terminateInstancesWithExpiration- Indicates whether running Spot Instances are terminated when the Spot Fleet request expires.- Returns:
this
-
terminateInstancesWithExpiration
@Stability(Stable) public CfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.Builder terminateInstancesWithExpiration(IResolvable terminateInstancesWithExpiration) Sets the value ofCfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.getTerminateInstancesWithExpiration()- Parameters:
terminateInstancesWithExpiration- Indicates whether running Spot Instances are terminated when the Spot Fleet request expires.- Returns:
this
-
type
@Stability(Stable) public CfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.Builder type(String type) Sets the value ofCfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.getType()- 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.instantis listed but is not used by Spot Fleet.- Returns:
this
-
validFrom
@Stability(Stable) public CfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.Builder validFrom(String validFrom) Sets the value ofCfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.getValidFrom()- Parameters:
validFrom- The start date and time of the request, in UTC format ( YYYY - MM - DD T HH : MM : SS Z). By default, Amazon EC2 starts fulfilling the request immediately.- Returns:
this
-
validUntil
@Stability(Stable) public CfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty.Builder validUntil(String validUntil) - Parameters:
validUntil- The end date and time of the request, in UTC format ( YYYY - MM - DD T HH : MM : SS Z). 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:
this
-
build
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty>- Returns:
- a new instance of
CfnSpotFleetPropsMixin.SpotFleetRequestConfigDataProperty - Throws:
NullPointerException- if any required attribute was not provided
-