AWS SDK for C++  1.9.132
AWS SDK for C++
Public Member Functions | List of all members
Aws::EC2::Model::SpotFleetRequestConfigData Class Reference

#include <SpotFleetRequestConfigData.h>

Public Member Functions

 SpotFleetRequestConfigData ()
 
 SpotFleetRequestConfigData (const Aws::Utils::Xml::XmlNode &xmlNode)
 
SpotFleetRequestConfigDataoperator= (const Aws::Utils::Xml::XmlNode &xmlNode)
 
void OutputToStream (Aws::OStream &ostream, const char *location, unsigned index, const char *locationValue) const
 
void OutputToStream (Aws::OStream &oStream, const char *location) const
 
const AllocationStrategyGetAllocationStrategy () const
 
bool AllocationStrategyHasBeenSet () const
 
void SetAllocationStrategy (const AllocationStrategy &value)
 
void SetAllocationStrategy (AllocationStrategy &&value)
 
SpotFleetRequestConfigDataWithAllocationStrategy (const AllocationStrategy &value)
 
SpotFleetRequestConfigDataWithAllocationStrategy (AllocationStrategy &&value)
 
const OnDemandAllocationStrategyGetOnDemandAllocationStrategy () const
 
bool OnDemandAllocationStrategyHasBeenSet () const
 
void SetOnDemandAllocationStrategy (const OnDemandAllocationStrategy &value)
 
void SetOnDemandAllocationStrategy (OnDemandAllocationStrategy &&value)
 
SpotFleetRequestConfigDataWithOnDemandAllocationStrategy (const OnDemandAllocationStrategy &value)
 
SpotFleetRequestConfigDataWithOnDemandAllocationStrategy (OnDemandAllocationStrategy &&value)
 
const SpotMaintenanceStrategiesGetSpotMaintenanceStrategies () const
 
bool SpotMaintenanceStrategiesHasBeenSet () const
 
void SetSpotMaintenanceStrategies (const SpotMaintenanceStrategies &value)
 
void SetSpotMaintenanceStrategies (SpotMaintenanceStrategies &&value)
 
SpotFleetRequestConfigDataWithSpotMaintenanceStrategies (const SpotMaintenanceStrategies &value)
 
SpotFleetRequestConfigDataWithSpotMaintenanceStrategies (SpotMaintenanceStrategies &&value)
 
const Aws::StringGetClientToken () const
 
bool ClientTokenHasBeenSet () const
 
void SetClientToken (const Aws::String &value)
 
void SetClientToken (Aws::String &&value)
 
void SetClientToken (const char *value)
 
SpotFleetRequestConfigDataWithClientToken (const Aws::String &value)
 
SpotFleetRequestConfigDataWithClientToken (Aws::String &&value)
 
SpotFleetRequestConfigDataWithClientToken (const char *value)
 
const ExcessCapacityTerminationPolicyGetExcessCapacityTerminationPolicy () const
 
bool ExcessCapacityTerminationPolicyHasBeenSet () const
 
void SetExcessCapacityTerminationPolicy (const ExcessCapacityTerminationPolicy &value)
 
void SetExcessCapacityTerminationPolicy (ExcessCapacityTerminationPolicy &&value)
 
SpotFleetRequestConfigDataWithExcessCapacityTerminationPolicy (const ExcessCapacityTerminationPolicy &value)
 
SpotFleetRequestConfigDataWithExcessCapacityTerminationPolicy (ExcessCapacityTerminationPolicy &&value)
 
double GetFulfilledCapacity () const
 
bool FulfilledCapacityHasBeenSet () const
 
void SetFulfilledCapacity (double value)
 
SpotFleetRequestConfigDataWithFulfilledCapacity (double value)
 
double GetOnDemandFulfilledCapacity () const
 
bool OnDemandFulfilledCapacityHasBeenSet () const
 
void SetOnDemandFulfilledCapacity (double value)
 
SpotFleetRequestConfigDataWithOnDemandFulfilledCapacity (double value)
 
const Aws::StringGetIamFleetRole () const
 
bool IamFleetRoleHasBeenSet () const
 
void SetIamFleetRole (const Aws::String &value)
 
void SetIamFleetRole (Aws::String &&value)
 
void SetIamFleetRole (const char *value)
 
SpotFleetRequestConfigDataWithIamFleetRole (const Aws::String &value)
 
SpotFleetRequestConfigDataWithIamFleetRole (Aws::String &&value)
 
SpotFleetRequestConfigDataWithIamFleetRole (const char *value)
 
const Aws::Vector< SpotFleetLaunchSpecification > & GetLaunchSpecifications () const
 
bool LaunchSpecificationsHasBeenSet () const
 
void SetLaunchSpecifications (const Aws::Vector< SpotFleetLaunchSpecification > &value)
 
void SetLaunchSpecifications (Aws::Vector< SpotFleetLaunchSpecification > &&value)
 
SpotFleetRequestConfigDataWithLaunchSpecifications (const Aws::Vector< SpotFleetLaunchSpecification > &value)
 
SpotFleetRequestConfigDataWithLaunchSpecifications (Aws::Vector< SpotFleetLaunchSpecification > &&value)
 
SpotFleetRequestConfigDataAddLaunchSpecifications (const SpotFleetLaunchSpecification &value)
 
SpotFleetRequestConfigDataAddLaunchSpecifications (SpotFleetLaunchSpecification &&value)
 
const Aws::Vector< LaunchTemplateConfig > & GetLaunchTemplateConfigs () const
 
bool LaunchTemplateConfigsHasBeenSet () const
 
void SetLaunchTemplateConfigs (const Aws::Vector< LaunchTemplateConfig > &value)
 
void SetLaunchTemplateConfigs (Aws::Vector< LaunchTemplateConfig > &&value)
 
SpotFleetRequestConfigDataWithLaunchTemplateConfigs (const Aws::Vector< LaunchTemplateConfig > &value)
 
SpotFleetRequestConfigDataWithLaunchTemplateConfigs (Aws::Vector< LaunchTemplateConfig > &&value)
 
SpotFleetRequestConfigDataAddLaunchTemplateConfigs (const LaunchTemplateConfig &value)
 
SpotFleetRequestConfigDataAddLaunchTemplateConfigs (LaunchTemplateConfig &&value)
 
const Aws::StringGetSpotPrice () const
 
bool SpotPriceHasBeenSet () const
 
void SetSpotPrice (const Aws::String &value)
 
void SetSpotPrice (Aws::String &&value)
 
void SetSpotPrice (const char *value)
 
SpotFleetRequestConfigDataWithSpotPrice (const Aws::String &value)
 
SpotFleetRequestConfigDataWithSpotPrice (Aws::String &&value)
 
SpotFleetRequestConfigDataWithSpotPrice (const char *value)
 
int GetTargetCapacity () const
 
bool TargetCapacityHasBeenSet () const
 
void SetTargetCapacity (int value)
 
SpotFleetRequestConfigDataWithTargetCapacity (int value)
 
int GetOnDemandTargetCapacity () const
 
bool OnDemandTargetCapacityHasBeenSet () const
 
void SetOnDemandTargetCapacity (int value)
 
SpotFleetRequestConfigDataWithOnDemandTargetCapacity (int value)
 
const Aws::StringGetOnDemandMaxTotalPrice () const
 
bool OnDemandMaxTotalPriceHasBeenSet () const
 
void SetOnDemandMaxTotalPrice (const Aws::String &value)
 
void SetOnDemandMaxTotalPrice (Aws::String &&value)
 
void SetOnDemandMaxTotalPrice (const char *value)
 
SpotFleetRequestConfigDataWithOnDemandMaxTotalPrice (const Aws::String &value)
 
SpotFleetRequestConfigDataWithOnDemandMaxTotalPrice (Aws::String &&value)
 
SpotFleetRequestConfigDataWithOnDemandMaxTotalPrice (const char *value)
 
const Aws::StringGetSpotMaxTotalPrice () const
 
bool SpotMaxTotalPriceHasBeenSet () const
 
void SetSpotMaxTotalPrice (const Aws::String &value)
 
void SetSpotMaxTotalPrice (Aws::String &&value)
 
void SetSpotMaxTotalPrice (const char *value)
 
SpotFleetRequestConfigDataWithSpotMaxTotalPrice (const Aws::String &value)
 
SpotFleetRequestConfigDataWithSpotMaxTotalPrice (Aws::String &&value)
 
SpotFleetRequestConfigDataWithSpotMaxTotalPrice (const char *value)
 
bool GetTerminateInstancesWithExpiration () const
 
bool TerminateInstancesWithExpirationHasBeenSet () const
 
void SetTerminateInstancesWithExpiration (bool value)
 
SpotFleetRequestConfigDataWithTerminateInstancesWithExpiration (bool value)
 
const FleetTypeGetType () const
 
bool TypeHasBeenSet () const
 
void SetType (const FleetType &value)
 
void SetType (FleetType &&value)
 
SpotFleetRequestConfigDataWithType (const FleetType &value)
 
SpotFleetRequestConfigDataWithType (FleetType &&value)
 
const Aws::Utils::DateTimeGetValidFrom () const
 
bool ValidFromHasBeenSet () const
 
void SetValidFrom (const Aws::Utils::DateTime &value)
 
void SetValidFrom (Aws::Utils::DateTime &&value)
 
SpotFleetRequestConfigDataWithValidFrom (const Aws::Utils::DateTime &value)
 
SpotFleetRequestConfigDataWithValidFrom (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetValidUntil () const
 
bool ValidUntilHasBeenSet () const
 
void SetValidUntil (const Aws::Utils::DateTime &value)
 
void SetValidUntil (Aws::Utils::DateTime &&value)
 
SpotFleetRequestConfigDataWithValidUntil (const Aws::Utils::DateTime &value)
 
SpotFleetRequestConfigDataWithValidUntil (Aws::Utils::DateTime &&value)
 
bool GetReplaceUnhealthyInstances () const
 
bool ReplaceUnhealthyInstancesHasBeenSet () const
 
void SetReplaceUnhealthyInstances (bool value)
 
SpotFleetRequestConfigDataWithReplaceUnhealthyInstances (bool value)
 
const InstanceInterruptionBehaviorGetInstanceInterruptionBehavior () const
 
bool InstanceInterruptionBehaviorHasBeenSet () const
 
void SetInstanceInterruptionBehavior (const InstanceInterruptionBehavior &value)
 
void SetInstanceInterruptionBehavior (InstanceInterruptionBehavior &&value)
 
SpotFleetRequestConfigDataWithInstanceInterruptionBehavior (const InstanceInterruptionBehavior &value)
 
SpotFleetRequestConfigDataWithInstanceInterruptionBehavior (InstanceInterruptionBehavior &&value)
 
const LoadBalancersConfigGetLoadBalancersConfig () const
 
bool LoadBalancersConfigHasBeenSet () const
 
void SetLoadBalancersConfig (const LoadBalancersConfig &value)
 
void SetLoadBalancersConfig (LoadBalancersConfig &&value)
 
SpotFleetRequestConfigDataWithLoadBalancersConfig (const LoadBalancersConfig &value)
 
SpotFleetRequestConfigDataWithLoadBalancersConfig (LoadBalancersConfig &&value)
 
int GetInstancePoolsToUseCount () const
 
bool InstancePoolsToUseCountHasBeenSet () const
 
void SetInstancePoolsToUseCount (int value)
 
SpotFleetRequestConfigDataWithInstancePoolsToUseCount (int value)
 
const Aws::StringGetContext () const
 
bool ContextHasBeenSet () const
 
void SetContext (const Aws::String &value)
 
void SetContext (Aws::String &&value)
 
void SetContext (const char *value)
 
SpotFleetRequestConfigDataWithContext (const Aws::String &value)
 
SpotFleetRequestConfigDataWithContext (Aws::String &&value)
 
SpotFleetRequestConfigDataWithContext (const char *value)
 
const TargetCapacityUnitTypeGetTargetCapacityUnitType () const
 
bool TargetCapacityUnitTypeHasBeenSet () const
 
void SetTargetCapacityUnitType (const TargetCapacityUnitType &value)
 
void SetTargetCapacityUnitType (TargetCapacityUnitType &&value)
 
SpotFleetRequestConfigDataWithTargetCapacityUnitType (const TargetCapacityUnitType &value)
 
SpotFleetRequestConfigDataWithTargetCapacityUnitType (TargetCapacityUnitType &&value)
 
const Aws::Vector< TagSpecification > & GetTagSpecifications () const
 
bool TagSpecificationsHasBeenSet () const
 
void SetTagSpecifications (const Aws::Vector< TagSpecification > &value)
 
void SetTagSpecifications (Aws::Vector< TagSpecification > &&value)
 
SpotFleetRequestConfigDataWithTagSpecifications (const Aws::Vector< TagSpecification > &value)
 
SpotFleetRequestConfigDataWithTagSpecifications (Aws::Vector< TagSpecification > &&value)
 
SpotFleetRequestConfigDataAddTagSpecifications (const TagSpecification &value)
 
SpotFleetRequestConfigDataAddTagSpecifications (TagSpecification &&value)
 

Detailed Description

Describes the configuration of a Spot Fleet request.

See Also:

AWS API Reference

Definition at line 45 of file SpotFleetRequestConfigData.h.

Constructor & Destructor Documentation

◆ SpotFleetRequestConfigData() [1/2]

Aws::EC2::Model::SpotFleetRequestConfigData::SpotFleetRequestConfigData ( )

◆ SpotFleetRequestConfigData() [2/2]

Aws::EC2::Model::SpotFleetRequestConfigData::SpotFleetRequestConfigData ( const Aws::Utils::Xml::XmlNode xmlNode)

Member Function Documentation

◆ AddLaunchSpecifications() [1/2]

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::AddLaunchSpecifications ( const SpotFleetLaunchSpecification value)
inline

The launch specifications for the Spot Fleet request. If you specify LaunchSpecifications, you can't specify LaunchTemplateConfigs. If you include On-Demand capacity in your request, you must use LaunchTemplateConfigs.

Definition at line 620 of file SpotFleetRequestConfigData.h.

◆ AddLaunchSpecifications() [2/2]

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::AddLaunchSpecifications ( SpotFleetLaunchSpecification &&  value)
inline

The launch specifications for the Spot Fleet request. If you specify LaunchSpecifications, you can't specify LaunchTemplateConfigs. If you include On-Demand capacity in your request, you must use LaunchTemplateConfigs.

Definition at line 628 of file SpotFleetRequestConfigData.h.

◆ AddLaunchTemplateConfigs() [1/2]

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::AddLaunchTemplateConfigs ( const LaunchTemplateConfig value)
inline

The launch template and overrides. If you specify LaunchTemplateConfigs, you can't specify LaunchSpecifications. If you include On-Demand capacity in your request, you must use LaunchTemplateConfigs.

Definition at line 685 of file SpotFleetRequestConfigData.h.

◆ AddLaunchTemplateConfigs() [2/2]

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::AddLaunchTemplateConfigs ( LaunchTemplateConfig &&  value)
inline

The launch template and overrides. If you specify LaunchTemplateConfigs, you can't specify LaunchSpecifications. If you include On-Demand capacity in your request, you must use LaunchTemplateConfigs.

Definition at line 693 of file SpotFleetRequestConfigData.h.

◆ AddTagSpecifications() [1/2]

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::AddTagSpecifications ( const TagSpecification value)
inline

The key-value pair for tagging the Spot Fleet request on creation. The value for ResourceType must be spot-fleet-request, otherwise the Spot Fleet request fails. To tag instances at launch, specify the tags in the launch template (valid only if you use LaunchTemplateConfigs) or in the SpotFleetTagSpecification (valid only if you use LaunchSpecifications). For information about tagging after launch, see Tagging Your Resources.

Definition at line 1600 of file SpotFleetRequestConfigData.h.

◆ AddTagSpecifications() [2/2]

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::AddTagSpecifications ( TagSpecification &&  value)
inline

The key-value pair for tagging the Spot Fleet request on creation. The value for ResourceType must be spot-fleet-request, otherwise the Spot Fleet request fails. To tag instances at launch, specify the tags in the launch template (valid only if you use LaunchTemplateConfigs) or in the SpotFleetTagSpecification (valid only if you use LaunchSpecifications). For information about tagging after launch, see Tagging Your Resources.

Definition at line 1617 of file SpotFleetRequestConfigData.h.

◆ AllocationStrategyHasBeenSet()

bool Aws::EC2::Model::SpotFleetRequestConfigData::AllocationStrategyHasBeenSet ( ) const
inline

Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the Spot Fleet request.

If the allocation strategy is lowestPrice, Spot Fleet launches instances from the Spot Instance pools with the lowest price. This is the default allocation strategy.

If the allocation strategy is diversified, Spot Fleet launches instances from all the Spot Instance pools that you specify.

If the allocation strategy is capacityOptimized (recommended), Spot Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching. To give certain instance types a higher chance of launching first, use capacityOptimizedPrioritized. Set a priority for each instance type by using the Priority parameter for LaunchTemplateOverrides. You can assign the same priority to different LaunchTemplateOverrides. EC2 implements the priorities on a best-effort basis, but optimizes for capacity first. capacityOptimizedPrioritized is supported only if your Spot Fleet uses a launch template. Note that if the OnDemandAllocationStrategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity.

Definition at line 98 of file SpotFleetRequestConfigData.h.

◆ ClientTokenHasBeenSet()

bool Aws::EC2::Model::SpotFleetRequestConfigData::ClientTokenHasBeenSet ( ) const
inline

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.

Definition at line 303 of file SpotFleetRequestConfigData.h.

◆ ContextHasBeenSet()

bool Aws::EC2::Model::SpotFleetRequestConfigData::ContextHasBeenSet ( ) const
inline

Reserved.

Definition at line 1413 of file SpotFleetRequestConfigData.h.

◆ ExcessCapacityTerminationPolicyHasBeenSet()

bool Aws::EC2::Model::SpotFleetRequestConfigData::ExcessCapacityTerminationPolicyHasBeenSet ( ) const
inline

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.

Definition at line 372 of file SpotFleetRequestConfigData.h.

◆ FulfilledCapacityHasBeenSet()

bool Aws::EC2::Model::SpotFleetRequestConfigData::FulfilledCapacityHasBeenSet ( ) const
inline

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

Definition at line 413 of file SpotFleetRequestConfigData.h.

◆ GetAllocationStrategy()

const AllocationStrategy& Aws::EC2::Model::SpotFleetRequestConfigData::GetAllocationStrategy ( ) const
inline

Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the Spot Fleet request.

If the allocation strategy is lowestPrice, Spot Fleet launches instances from the Spot Instance pools with the lowest price. This is the default allocation strategy.

If the allocation strategy is diversified, Spot Fleet launches instances from all the Spot Instance pools that you specify.

If the allocation strategy is capacityOptimized (recommended), Spot Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching. To give certain instance types a higher chance of launching first, use capacityOptimizedPrioritized. Set a priority for each instance type by using the Priority parameter for LaunchTemplateOverrides. You can assign the same priority to different LaunchTemplateOverrides. EC2 implements the priorities on a best-effort basis, but optimizes for capacity first. capacityOptimizedPrioritized is supported only if your Spot Fleet uses a launch template. Note that if the OnDemandAllocationStrategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity.

Definition at line 76 of file SpotFleetRequestConfigData.h.

◆ GetClientToken()

const Aws::String& Aws::EC2::Model::SpotFleetRequestConfigData::GetClientToken ( ) const
inline

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.

Definition at line 294 of file SpotFleetRequestConfigData.h.

◆ GetContext()

const Aws::String& Aws::EC2::Model::SpotFleetRequestConfigData::GetContext ( ) const
inline

Reserved.

Definition at line 1408 of file SpotFleetRequestConfigData.h.

◆ GetExcessCapacityTerminationPolicy()

const ExcessCapacityTerminationPolicy& Aws::EC2::Model::SpotFleetRequestConfigData::GetExcessCapacityTerminationPolicy ( ) const
inline

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.

Definition at line 365 of file SpotFleetRequestConfigData.h.

◆ GetFulfilledCapacity()

double Aws::EC2::Model::SpotFleetRequestConfigData::GetFulfilledCapacity ( ) const
inline

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

Definition at line 407 of file SpotFleetRequestConfigData.h.

◆ GetIamFleetRole()

const Aws::String& Aws::EC2::Model::SpotFleetRequestConfigData::GetIamFleetRole ( ) const
inline

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 for Linux Instances. 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.

Definition at line 465 of file SpotFleetRequestConfigData.h.

◆ GetInstanceInterruptionBehavior()

const InstanceInterruptionBehavior& Aws::EC2::Model::SpotFleetRequestConfigData::GetInstanceInterruptionBehavior ( ) const
inline

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

Definition at line 1246 of file SpotFleetRequestConfigData.h.

◆ GetInstancePoolsToUseCount()

int Aws::EC2::Model::SpotFleetRequestConfigData::GetInstancePoolsToUseCount ( ) const
inline

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.

Definition at line 1354 of file SpotFleetRequestConfigData.h.

◆ GetLaunchSpecifications()

const Aws::Vector<SpotFleetLaunchSpecification>& Aws::EC2::Model::SpotFleetRequestConfigData::GetLaunchSpecifications ( ) const
inline

The launch specifications for the Spot Fleet request. If you specify LaunchSpecifications, you can't specify LaunchTemplateConfigs. If you include On-Demand capacity in your request, you must use LaunchTemplateConfigs.

Definition at line 572 of file SpotFleetRequestConfigData.h.

◆ GetLaunchTemplateConfigs()

const Aws::Vector<LaunchTemplateConfig>& Aws::EC2::Model::SpotFleetRequestConfigData::GetLaunchTemplateConfigs ( ) const
inline

The launch template and overrides. If you specify LaunchTemplateConfigs, you can't specify LaunchSpecifications. If you include On-Demand capacity in your request, you must use LaunchTemplateConfigs.

Definition at line 637 of file SpotFleetRequestConfigData.h.

◆ GetLoadBalancersConfig()

const LoadBalancersConfig& Aws::EC2::Model::SpotFleetRequestConfigData::GetLoadBalancersConfig ( ) const
inline

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.

Definition at line 1287 of file SpotFleetRequestConfigData.h.

◆ GetOnDemandAllocationStrategy()

const OnDemandAllocationStrategy& Aws::EC2::Model::SpotFleetRequestConfigData::GetOnDemandAllocationStrategy ( ) const
inline

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.

Definition at line 197 of file SpotFleetRequestConfigData.h.

◆ GetOnDemandFulfilledCapacity()

double Aws::EC2::Model::SpotFleetRequestConfigData::GetOnDemandFulfilledCapacity ( ) const
inline

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

Definition at line 432 of file SpotFleetRequestConfigData.h.

◆ GetOnDemandMaxTotalPrice()

const Aws::String& Aws::EC2::Model::SpotFleetRequestConfigData::GetOnDemandMaxTotalPrice ( ) const
inline

The maximum amount per hour for On-Demand Instances that you're willing to pay. You can use the onDemandMaxTotalPrice parameter, the spotMaxTotalPrice 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.

Definition at line 829 of file SpotFleetRequestConfigData.h.

◆ GetOnDemandTargetCapacity()

int Aws::EC2::Model::SpotFleetRequestConfigData::GetOnDemandTargetCapacity ( ) const
inline

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.

Definition at line 789 of file SpotFleetRequestConfigData.h.

◆ GetReplaceUnhealthyInstances()

bool Aws::EC2::Model::SpotFleetRequestConfigData::GetReplaceUnhealthyInstances ( ) const
inline

Indicates whether Spot Fleet should replace unhealthy instances.

Definition at line 1224 of file SpotFleetRequestConfigData.h.

◆ GetSpotMaintenanceStrategies()

const SpotMaintenanceStrategies& Aws::EC2::Model::SpotFleetRequestConfigData::GetSpotMaintenanceStrategies ( ) const
inline

The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.

Definition at line 254 of file SpotFleetRequestConfigData.h.

◆ GetSpotMaxTotalPrice()

const Aws::String& Aws::EC2::Model::SpotFleetRequestConfigData::GetSpotMaxTotalPrice ( ) const
inline

The maximum amount per hour for Spot Instances that you're willing to pay. You can use the spotdMaxTotalPrice parameter, the onDemandMaxTotalPrice 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.

Definition at line 926 of file SpotFleetRequestConfigData.h.

◆ GetSpotPrice()

const Aws::String& Aws::EC2::Model::SpotFleetRequestConfigData::GetSpotPrice ( ) const
inline

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

Definition at line 700 of file SpotFleetRequestConfigData.h.

◆ GetTagSpecifications()

const Aws::Vector<TagSpecification>& Aws::EC2::Model::SpotFleetRequestConfigData::GetTagSpecifications ( ) const
inline

The key-value pair for tagging the Spot Fleet request on creation. The value for ResourceType must be spot-fleet-request, otherwise the Spot Fleet request fails. To tag instances at launch, specify the tags in the launch template (valid only if you use LaunchTemplateConfigs) or in the SpotFleetTagSpecification (valid only if you use LaunchSpecifications). For information about tagging after launch, see Tagging Your Resources.

Definition at line 1498 of file SpotFleetRequestConfigData.h.

◆ GetTargetCapacity()

int Aws::EC2::Model::SpotFleetRequestConfigData::GetTargetCapacity ( ) const
inline

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.

Definition at line 752 of file SpotFleetRequestConfigData.h.

◆ GetTargetCapacityUnitType()

const TargetCapacityUnitType& Aws::EC2::Model::SpotFleetRequestConfigData::GetTargetCapacityUnitType ( ) const
inline

The unit for the target capacity.

Default: units (translates to number of instances)

Definition at line 1450 of file SpotFleetRequestConfigData.h.

◆ GetTerminateInstancesWithExpiration()

bool Aws::EC2::Model::SpotFleetRequestConfigData::GetTerminateInstancesWithExpiration ( ) const
inline

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

Definition at line 1017 of file SpotFleetRequestConfigData.h.

◆ GetType()

const FleetType& Aws::EC2::Model::SpotFleetRequestConfigData::GetType ( ) const
inline

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 is maintain, 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.

Definition at line 1050 of file SpotFleetRequestConfigData.h.

◆ GetValidFrom()

const Aws::Utils::DateTime& Aws::EC2::Model::SpotFleetRequestConfigData::GetValidFrom ( ) const
inline

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.

Definition at line 1128 of file SpotFleetRequestConfigData.h.

◆ GetValidUntil()

const Aws::Utils::DateTime& Aws::EC2::Model::SpotFleetRequestConfigData::GetValidUntil ( ) const
inline

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.

Definition at line 1173 of file SpotFleetRequestConfigData.h.

◆ IamFleetRoleHasBeenSet()

bool Aws::EC2::Model::SpotFleetRequestConfigData::IamFleetRoleHasBeenSet ( ) const
inline

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 for Linux Instances. 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.

Definition at line 479 of file SpotFleetRequestConfigData.h.

◆ InstanceInterruptionBehaviorHasBeenSet()

bool Aws::EC2::Model::SpotFleetRequestConfigData::InstanceInterruptionBehaviorHasBeenSet ( ) const
inline

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

Definition at line 1252 of file SpotFleetRequestConfigData.h.

◆ InstancePoolsToUseCountHasBeenSet()

bool Aws::EC2::Model::SpotFleetRequestConfigData::InstancePoolsToUseCountHasBeenSet ( ) const
inline

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.

Definition at line 1370 of file SpotFleetRequestConfigData.h.

◆ LaunchSpecificationsHasBeenSet()

bool Aws::EC2::Model::SpotFleetRequestConfigData::LaunchSpecificationsHasBeenSet ( ) const
inline

The launch specifications for the Spot Fleet request. If you specify LaunchSpecifications, you can't specify LaunchTemplateConfigs. If you include On-Demand capacity in your request, you must use LaunchTemplateConfigs.

Definition at line 580 of file SpotFleetRequestConfigData.h.

◆ LaunchTemplateConfigsHasBeenSet()

bool Aws::EC2::Model::SpotFleetRequestConfigData::LaunchTemplateConfigsHasBeenSet ( ) const
inline

The launch template and overrides. If you specify LaunchTemplateConfigs, you can't specify LaunchSpecifications. If you include On-Demand capacity in your request, you must use LaunchTemplateConfigs.

Definition at line 645 of file SpotFleetRequestConfigData.h.

◆ LoadBalancersConfigHasBeenSet()

bool Aws::EC2::Model::SpotFleetRequestConfigData::LoadBalancersConfigHasBeenSet ( ) const
inline

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.

Definition at line 1297 of file SpotFleetRequestConfigData.h.

◆ OnDemandAllocationStrategyHasBeenSet()

bool Aws::EC2::Model::SpotFleetRequestConfigData::OnDemandAllocationStrategyHasBeenSet ( ) const
inline

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.

Definition at line 207 of file SpotFleetRequestConfigData.h.

◆ OnDemandFulfilledCapacityHasBeenSet()

bool Aws::EC2::Model::SpotFleetRequestConfigData::OnDemandFulfilledCapacityHasBeenSet ( ) const
inline

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

Definition at line 438 of file SpotFleetRequestConfigData.h.

◆ OnDemandMaxTotalPriceHasBeenSet()

bool Aws::EC2::Model::SpotFleetRequestConfigData::OnDemandMaxTotalPriceHasBeenSet ( ) const
inline

The maximum amount per hour for On-Demand Instances that you're willing to pay. You can use the onDemandMaxTotalPrice parameter, the spotMaxTotalPrice 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.

Definition at line 841 of file SpotFleetRequestConfigData.h.

◆ OnDemandTargetCapacityHasBeenSet()

bool Aws::EC2::Model::SpotFleetRequestConfigData::OnDemandTargetCapacityHasBeenSet ( ) const
inline

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.

Definition at line 798 of file SpotFleetRequestConfigData.h.

◆ operator=()

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::operator= ( const Aws::Utils::Xml::XmlNode xmlNode)

◆ OutputToStream() [1/2]

void Aws::EC2::Model::SpotFleetRequestConfigData::OutputToStream ( Aws::OStream oStream,
const char *  location 
) const

◆ OutputToStream() [2/2]

void Aws::EC2::Model::SpotFleetRequestConfigData::OutputToStream ( Aws::OStream ostream,
const char *  location,
unsigned  index,
const char *  locationValue 
) const

◆ ReplaceUnhealthyInstancesHasBeenSet()

bool Aws::EC2::Model::SpotFleetRequestConfigData::ReplaceUnhealthyInstancesHasBeenSet ( ) const
inline

Indicates whether Spot Fleet should replace unhealthy instances.

Definition at line 1229 of file SpotFleetRequestConfigData.h.

◆ SetAllocationStrategy() [1/2]

void Aws::EC2::Model::SpotFleetRequestConfigData::SetAllocationStrategy ( AllocationStrategy &&  value)
inline

Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the Spot Fleet request.

If the allocation strategy is lowestPrice, Spot Fleet launches instances from the Spot Instance pools with the lowest price. This is the default allocation strategy.

If the allocation strategy is diversified, Spot Fleet launches instances from all the Spot Instance pools that you specify.

If the allocation strategy is capacityOptimized (recommended), Spot Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching. To give certain instance types a higher chance of launching first, use capacityOptimizedPrioritized. Set a priority for each instance type by using the Priority parameter for LaunchTemplateOverrides. You can assign the same priority to different LaunchTemplateOverrides. EC2 implements the priorities on a best-effort basis, but optimizes for capacity first. capacityOptimizedPrioritized is supported only if your Spot Fleet uses a launch template. Note that if the OnDemandAllocationStrategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity.

Definition at line 142 of file SpotFleetRequestConfigData.h.

◆ SetAllocationStrategy() [2/2]

void Aws::EC2::Model::SpotFleetRequestConfigData::SetAllocationStrategy ( const AllocationStrategy value)
inline

Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the Spot Fleet request.

If the allocation strategy is lowestPrice, Spot Fleet launches instances from the Spot Instance pools with the lowest price. This is the default allocation strategy.

If the allocation strategy is diversified, Spot Fleet launches instances from all the Spot Instance pools that you specify.

If the allocation strategy is capacityOptimized (recommended), Spot Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching. To give certain instance types a higher chance of launching first, use capacityOptimizedPrioritized. Set a priority for each instance type by using the Priority parameter for LaunchTemplateOverrides. You can assign the same priority to different LaunchTemplateOverrides. EC2 implements the priorities on a best-effort basis, but optimizes for capacity first. capacityOptimizedPrioritized is supported only if your Spot Fleet uses a launch template. Note that if the OnDemandAllocationStrategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity.

Definition at line 120 of file SpotFleetRequestConfigData.h.

◆ SetClientToken() [1/3]

void Aws::EC2::Model::SpotFleetRequestConfigData::SetClientToken ( Aws::String &&  value)
inline

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.

Definition at line 321 of file SpotFleetRequestConfigData.h.

◆ SetClientToken() [2/3]

void Aws::EC2::Model::SpotFleetRequestConfigData::SetClientToken ( const Aws::String value)
inline

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.

Definition at line 312 of file SpotFleetRequestConfigData.h.

◆ SetClientToken() [3/3]

void Aws::EC2::Model::SpotFleetRequestConfigData::SetClientToken ( const char *  value)
inline

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.

Definition at line 330 of file SpotFleetRequestConfigData.h.

◆ SetContext() [1/3]

void Aws::EC2::Model::SpotFleetRequestConfigData::SetContext ( Aws::String &&  value)
inline

Reserved.

Definition at line 1423 of file SpotFleetRequestConfigData.h.

◆ SetContext() [2/3]

void Aws::EC2::Model::SpotFleetRequestConfigData::SetContext ( const Aws::String value)
inline

Reserved.

Definition at line 1418 of file SpotFleetRequestConfigData.h.

◆ SetContext() [3/3]

void Aws::EC2::Model::SpotFleetRequestConfigData::SetContext ( const char *  value)
inline

Reserved.

Definition at line 1428 of file SpotFleetRequestConfigData.h.

◆ SetExcessCapacityTerminationPolicy() [1/2]

void Aws::EC2::Model::SpotFleetRequestConfigData::SetExcessCapacityTerminationPolicy ( const ExcessCapacityTerminationPolicy value)
inline

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.

Definition at line 379 of file SpotFleetRequestConfigData.h.

◆ SetExcessCapacityTerminationPolicy() [2/2]

void Aws::EC2::Model::SpotFleetRequestConfigData::SetExcessCapacityTerminationPolicy ( ExcessCapacityTerminationPolicy &&  value)
inline

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.

Definition at line 386 of file SpotFleetRequestConfigData.h.

◆ SetFulfilledCapacity()

void Aws::EC2::Model::SpotFleetRequestConfigData::SetFulfilledCapacity ( double  value)
inline

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

Definition at line 419 of file SpotFleetRequestConfigData.h.

◆ SetIamFleetRole() [1/3]

void Aws::EC2::Model::SpotFleetRequestConfigData::SetIamFleetRole ( Aws::String &&  value)
inline

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 for Linux Instances. 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.

Definition at line 507 of file SpotFleetRequestConfigData.h.

◆ SetIamFleetRole() [2/3]

void Aws::EC2::Model::SpotFleetRequestConfigData::SetIamFleetRole ( const Aws::String value)
inline

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 for Linux Instances. 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.

Definition at line 493 of file SpotFleetRequestConfigData.h.

◆ SetIamFleetRole() [3/3]

void Aws::EC2::Model::SpotFleetRequestConfigData::SetIamFleetRole ( const char *  value)
inline

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 for Linux Instances. 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.

Definition at line 521 of file SpotFleetRequestConfigData.h.

◆ SetInstanceInterruptionBehavior() [1/2]

void Aws::EC2::Model::SpotFleetRequestConfigData::SetInstanceInterruptionBehavior ( const InstanceInterruptionBehavior value)
inline

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

Definition at line 1258 of file SpotFleetRequestConfigData.h.

◆ SetInstanceInterruptionBehavior() [2/2]

void Aws::EC2::Model::SpotFleetRequestConfigData::SetInstanceInterruptionBehavior ( InstanceInterruptionBehavior &&  value)
inline

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

Definition at line 1264 of file SpotFleetRequestConfigData.h.

◆ SetInstancePoolsToUseCount()

void Aws::EC2::Model::SpotFleetRequestConfigData::SetInstancePoolsToUseCount ( int  value)
inline

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.

Definition at line 1386 of file SpotFleetRequestConfigData.h.

◆ SetLaunchSpecifications() [1/2]

void Aws::EC2::Model::SpotFleetRequestConfigData::SetLaunchSpecifications ( Aws::Vector< SpotFleetLaunchSpecification > &&  value)
inline

The launch specifications for the Spot Fleet request. If you specify LaunchSpecifications, you can't specify LaunchTemplateConfigs. If you include On-Demand capacity in your request, you must use LaunchTemplateConfigs.

Definition at line 596 of file SpotFleetRequestConfigData.h.

◆ SetLaunchSpecifications() [2/2]

void Aws::EC2::Model::SpotFleetRequestConfigData::SetLaunchSpecifications ( const Aws::Vector< SpotFleetLaunchSpecification > &  value)
inline

The launch specifications for the Spot Fleet request. If you specify LaunchSpecifications, you can't specify LaunchTemplateConfigs. If you include On-Demand capacity in your request, you must use LaunchTemplateConfigs.

Definition at line 588 of file SpotFleetRequestConfigData.h.

◆ SetLaunchTemplateConfigs() [1/2]

void Aws::EC2::Model::SpotFleetRequestConfigData::SetLaunchTemplateConfigs ( Aws::Vector< LaunchTemplateConfig > &&  value)
inline

The launch template and overrides. If you specify LaunchTemplateConfigs, you can't specify LaunchSpecifications. If you include On-Demand capacity in your request, you must use LaunchTemplateConfigs.

Definition at line 661 of file SpotFleetRequestConfigData.h.

◆ SetLaunchTemplateConfigs() [2/2]

void Aws::EC2::Model::SpotFleetRequestConfigData::SetLaunchTemplateConfigs ( const Aws::Vector< LaunchTemplateConfig > &  value)
inline

The launch template and overrides. If you specify LaunchTemplateConfigs, you can't specify LaunchSpecifications. If you include On-Demand capacity in your request, you must use LaunchTemplateConfigs.

Definition at line 653 of file SpotFleetRequestConfigData.h.

◆ SetLoadBalancersConfig() [1/2]

void Aws::EC2::Model::SpotFleetRequestConfigData::SetLoadBalancersConfig ( const LoadBalancersConfig value)
inline

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.

Definition at line 1307 of file SpotFleetRequestConfigData.h.

◆ SetLoadBalancersConfig() [2/2]

void Aws::EC2::Model::SpotFleetRequestConfigData::SetLoadBalancersConfig ( LoadBalancersConfig &&  value)
inline

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.

Definition at line 1317 of file SpotFleetRequestConfigData.h.

◆ SetOnDemandAllocationStrategy() [1/2]

void Aws::EC2::Model::SpotFleetRequestConfigData::SetOnDemandAllocationStrategy ( const OnDemandAllocationStrategy value)
inline

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.

Definition at line 217 of file SpotFleetRequestConfigData.h.

◆ SetOnDemandAllocationStrategy() [2/2]

void Aws::EC2::Model::SpotFleetRequestConfigData::SetOnDemandAllocationStrategy ( OnDemandAllocationStrategy &&  value)
inline

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.

Definition at line 227 of file SpotFleetRequestConfigData.h.

◆ SetOnDemandFulfilledCapacity()

void Aws::EC2::Model::SpotFleetRequestConfigData::SetOnDemandFulfilledCapacity ( double  value)
inline

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

Definition at line 444 of file SpotFleetRequestConfigData.h.

◆ SetOnDemandMaxTotalPrice() [1/3]

void Aws::EC2::Model::SpotFleetRequestConfigData::SetOnDemandMaxTotalPrice ( Aws::String &&  value)
inline

The maximum amount per hour for On-Demand Instances that you're willing to pay. You can use the onDemandMaxTotalPrice parameter, the spotMaxTotalPrice 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.

Definition at line 865 of file SpotFleetRequestConfigData.h.

◆ SetOnDemandMaxTotalPrice() [2/3]

void Aws::EC2::Model::SpotFleetRequestConfigData::SetOnDemandMaxTotalPrice ( const Aws::String value)
inline

The maximum amount per hour for On-Demand Instances that you're willing to pay. You can use the onDemandMaxTotalPrice parameter, the spotMaxTotalPrice 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.

Definition at line 853 of file SpotFleetRequestConfigData.h.

◆ SetOnDemandMaxTotalPrice() [3/3]

void Aws::EC2::Model::SpotFleetRequestConfigData::SetOnDemandMaxTotalPrice ( const char *  value)
inline

The maximum amount per hour for On-Demand Instances that you're willing to pay. You can use the onDemandMaxTotalPrice parameter, the spotMaxTotalPrice 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.

Definition at line 877 of file SpotFleetRequestConfigData.h.

◆ SetOnDemandTargetCapacity()

void Aws::EC2::Model::SpotFleetRequestConfigData::SetOnDemandTargetCapacity ( int  value)
inline

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.

Definition at line 807 of file SpotFleetRequestConfigData.h.

◆ SetReplaceUnhealthyInstances()

void Aws::EC2::Model::SpotFleetRequestConfigData::SetReplaceUnhealthyInstances ( bool  value)
inline

Indicates whether Spot Fleet should replace unhealthy instances.

Definition at line 1234 of file SpotFleetRequestConfigData.h.

◆ SetSpotMaintenanceStrategies() [1/2]

void Aws::EC2::Model::SpotFleetRequestConfigData::SetSpotMaintenanceStrategies ( const SpotMaintenanceStrategies value)
inline

The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.

Definition at line 266 of file SpotFleetRequestConfigData.h.

◆ SetSpotMaintenanceStrategies() [2/2]

void Aws::EC2::Model::SpotFleetRequestConfigData::SetSpotMaintenanceStrategies ( SpotMaintenanceStrategies &&  value)
inline

The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.

Definition at line 272 of file SpotFleetRequestConfigData.h.

◆ SetSpotMaxTotalPrice() [1/3]

void Aws::EC2::Model::SpotFleetRequestConfigData::SetSpotMaxTotalPrice ( Aws::String &&  value)
inline

The maximum amount per hour for Spot Instances that you're willing to pay. You can use the spotdMaxTotalPrice parameter, the onDemandMaxTotalPrice 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.

Definition at line 962 of file SpotFleetRequestConfigData.h.

◆ SetSpotMaxTotalPrice() [2/3]

void Aws::EC2::Model::SpotFleetRequestConfigData::SetSpotMaxTotalPrice ( const Aws::String value)
inline

The maximum amount per hour for Spot Instances that you're willing to pay. You can use the spotdMaxTotalPrice parameter, the onDemandMaxTotalPrice 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.

Definition at line 950 of file SpotFleetRequestConfigData.h.

◆ SetSpotMaxTotalPrice() [3/3]

void Aws::EC2::Model::SpotFleetRequestConfigData::SetSpotMaxTotalPrice ( const char *  value)
inline

The maximum amount per hour for Spot Instances that you're willing to pay. You can use the spotdMaxTotalPrice parameter, the onDemandMaxTotalPrice 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.

Definition at line 974 of file SpotFleetRequestConfigData.h.

◆ SetSpotPrice() [1/3]

void Aws::EC2::Model::SpotFleetRequestConfigData::SetSpotPrice ( Aws::String &&  value)
inline

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

Definition at line 718 of file SpotFleetRequestConfigData.h.

◆ SetSpotPrice() [2/3]

void Aws::EC2::Model::SpotFleetRequestConfigData::SetSpotPrice ( const Aws::String value)
inline

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

Definition at line 712 of file SpotFleetRequestConfigData.h.

◆ SetSpotPrice() [3/3]

void Aws::EC2::Model::SpotFleetRequestConfigData::SetSpotPrice ( const char *  value)
inline

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

Definition at line 724 of file SpotFleetRequestConfigData.h.

◆ SetTagSpecifications() [1/2]

void Aws::EC2::Model::SpotFleetRequestConfigData::SetTagSpecifications ( Aws::Vector< TagSpecification > &&  value)
inline

The key-value pair for tagging the Spot Fleet request on creation. The value for ResourceType must be spot-fleet-request, otherwise the Spot Fleet request fails. To tag instances at launch, specify the tags in the launch template (valid only if you use LaunchTemplateConfigs) or in the SpotFleetTagSpecification (valid only if you use LaunchSpecifications). For information about tagging after launch, see Tagging Your Resources.

Definition at line 1549 of file SpotFleetRequestConfigData.h.

◆ SetTagSpecifications() [2/2]

void Aws::EC2::Model::SpotFleetRequestConfigData::SetTagSpecifications ( const Aws::Vector< TagSpecification > &  value)
inline

The key-value pair for tagging the Spot Fleet request on creation. The value for ResourceType must be spot-fleet-request, otherwise the Spot Fleet request fails. To tag instances at launch, specify the tags in the launch template (valid only if you use LaunchTemplateConfigs) or in the SpotFleetTagSpecification (valid only if you use LaunchSpecifications). For information about tagging after launch, see Tagging Your Resources.

Definition at line 1532 of file SpotFleetRequestConfigData.h.

◆ SetTargetCapacity()

void Aws::EC2::Model::SpotFleetRequestConfigData::SetTargetCapacity ( int  value)
inline

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.

Definition at line 770 of file SpotFleetRequestConfigData.h.

◆ SetTargetCapacityUnitType() [1/2]

void Aws::EC2::Model::SpotFleetRequestConfigData::SetTargetCapacityUnitType ( const TargetCapacityUnitType value)
inline

The unit for the target capacity.

Default: units (translates to number of instances)

Definition at line 1462 of file SpotFleetRequestConfigData.h.

◆ SetTargetCapacityUnitType() [2/2]

void Aws::EC2::Model::SpotFleetRequestConfigData::SetTargetCapacityUnitType ( TargetCapacityUnitType &&  value)
inline

The unit for the target capacity.

Default: units (translates to number of instances)

Definition at line 1468 of file SpotFleetRequestConfigData.h.

◆ SetTerminateInstancesWithExpiration()

void Aws::EC2::Model::SpotFleetRequestConfigData::SetTerminateInstancesWithExpiration ( bool  value)
inline

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

Definition at line 1029 of file SpotFleetRequestConfigData.h.

◆ SetType() [1/2]

void Aws::EC2::Model::SpotFleetRequestConfigData::SetType ( const FleetType value)
inline

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 is maintain, 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.

Definition at line 1078 of file SpotFleetRequestConfigData.h.

◆ SetType() [2/2]

void Aws::EC2::Model::SpotFleetRequestConfigData::SetType ( FleetType &&  value)
inline

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 is maintain, 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.

Definition at line 1092 of file SpotFleetRequestConfigData.h.

◆ SetValidFrom() [1/2]

void Aws::EC2::Model::SpotFleetRequestConfigData::SetValidFrom ( Aws::Utils::DateTime &&  value)
inline

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.

Definition at line 1149 of file SpotFleetRequestConfigData.h.

◆ SetValidFrom() [2/2]

void Aws::EC2::Model::SpotFleetRequestConfigData::SetValidFrom ( const Aws::Utils::DateTime value)
inline

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.

Definition at line 1142 of file SpotFleetRequestConfigData.h.

◆ SetValidUntil() [1/2]

void Aws::EC2::Model::SpotFleetRequestConfigData::SetValidUntil ( Aws::Utils::DateTime &&  value)
inline

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.

Definition at line 1200 of file SpotFleetRequestConfigData.h.

◆ SetValidUntil() [2/2]

void Aws::EC2::Model::SpotFleetRequestConfigData::SetValidUntil ( const Aws::Utils::DateTime value)
inline

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.

Definition at line 1191 of file SpotFleetRequestConfigData.h.

◆ SpotMaintenanceStrategiesHasBeenSet()

bool Aws::EC2::Model::SpotFleetRequestConfigData::SpotMaintenanceStrategiesHasBeenSet ( ) const
inline

The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.

Definition at line 260 of file SpotFleetRequestConfigData.h.

◆ SpotMaxTotalPriceHasBeenSet()

bool Aws::EC2::Model::SpotFleetRequestConfigData::SpotMaxTotalPriceHasBeenSet ( ) const
inline

The maximum amount per hour for Spot Instances that you're willing to pay. You can use the spotdMaxTotalPrice parameter, the onDemandMaxTotalPrice 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.

Definition at line 938 of file SpotFleetRequestConfigData.h.

◆ SpotPriceHasBeenSet()

bool Aws::EC2::Model::SpotFleetRequestConfigData::SpotPriceHasBeenSet ( ) const
inline

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

Definition at line 706 of file SpotFleetRequestConfigData.h.

◆ TagSpecificationsHasBeenSet()

bool Aws::EC2::Model::SpotFleetRequestConfigData::TagSpecificationsHasBeenSet ( ) const
inline

The key-value pair for tagging the Spot Fleet request on creation. The value for ResourceType must be spot-fleet-request, otherwise the Spot Fleet request fails. To tag instances at launch, specify the tags in the launch template (valid only if you use LaunchTemplateConfigs) or in the SpotFleetTagSpecification (valid only if you use LaunchSpecifications). For information about tagging after launch, see Tagging Your Resources.

Definition at line 1515 of file SpotFleetRequestConfigData.h.

◆ TargetCapacityHasBeenSet()

bool Aws::EC2::Model::SpotFleetRequestConfigData::TargetCapacityHasBeenSet ( ) const
inline

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.

Definition at line 761 of file SpotFleetRequestConfigData.h.

◆ TargetCapacityUnitTypeHasBeenSet()

bool Aws::EC2::Model::SpotFleetRequestConfigData::TargetCapacityUnitTypeHasBeenSet ( ) const
inline

The unit for the target capacity.

Default: units (translates to number of instances)

Definition at line 1456 of file SpotFleetRequestConfigData.h.

◆ TerminateInstancesWithExpirationHasBeenSet()

bool Aws::EC2::Model::SpotFleetRequestConfigData::TerminateInstancesWithExpirationHasBeenSet ( ) const
inline

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

Definition at line 1023 of file SpotFleetRequestConfigData.h.

◆ TypeHasBeenSet()

bool Aws::EC2::Model::SpotFleetRequestConfigData::TypeHasBeenSet ( ) const
inline

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 is maintain, 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.

Definition at line 1064 of file SpotFleetRequestConfigData.h.

◆ ValidFromHasBeenSet()

bool Aws::EC2::Model::SpotFleetRequestConfigData::ValidFromHasBeenSet ( ) const
inline

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.

Definition at line 1135 of file SpotFleetRequestConfigData.h.

◆ ValidUntilHasBeenSet()

bool Aws::EC2::Model::SpotFleetRequestConfigData::ValidUntilHasBeenSet ( ) const
inline

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.

Definition at line 1182 of file SpotFleetRequestConfigData.h.

◆ WithAllocationStrategy() [1/2]

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::WithAllocationStrategy ( AllocationStrategy &&  value)
inline

Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the Spot Fleet request.

If the allocation strategy is lowestPrice, Spot Fleet launches instances from the Spot Instance pools with the lowest price. This is the default allocation strategy.

If the allocation strategy is diversified, Spot Fleet launches instances from all the Spot Instance pools that you specify.

If the allocation strategy is capacityOptimized (recommended), Spot Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching. To give certain instance types a higher chance of launching first, use capacityOptimizedPrioritized. Set a priority for each instance type by using the Priority parameter for LaunchTemplateOverrides. You can assign the same priority to different LaunchTemplateOverrides. EC2 implements the priorities on a best-effort basis, but optimizes for capacity first. capacityOptimizedPrioritized is supported only if your Spot Fleet uses a launch template. Note that if the OnDemandAllocationStrategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity.

Definition at line 186 of file SpotFleetRequestConfigData.h.

◆ WithAllocationStrategy() [2/2]

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::WithAllocationStrategy ( const AllocationStrategy value)
inline

Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the Spot Fleet request.

If the allocation strategy is lowestPrice, Spot Fleet launches instances from the Spot Instance pools with the lowest price. This is the default allocation strategy.

If the allocation strategy is diversified, Spot Fleet launches instances from all the Spot Instance pools that you specify.

If the allocation strategy is capacityOptimized (recommended), Spot Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching. To give certain instance types a higher chance of launching first, use capacityOptimizedPrioritized. Set a priority for each instance type by using the Priority parameter for LaunchTemplateOverrides. You can assign the same priority to different LaunchTemplateOverrides. EC2 implements the priorities on a best-effort basis, but optimizes for capacity first. capacityOptimizedPrioritized is supported only if your Spot Fleet uses a launch template. Note that if the OnDemandAllocationStrategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity.

Definition at line 164 of file SpotFleetRequestConfigData.h.

◆ WithClientToken() [1/3]

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::WithClientToken ( Aws::String &&  value)
inline

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.

Definition at line 348 of file SpotFleetRequestConfigData.h.

◆ WithClientToken() [2/3]

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::WithClientToken ( const Aws::String value)
inline

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.

Definition at line 339 of file SpotFleetRequestConfigData.h.

◆ WithClientToken() [3/3]

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::WithClientToken ( const char *  value)
inline

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.

Definition at line 357 of file SpotFleetRequestConfigData.h.

◆ WithContext() [1/3]

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::WithContext ( Aws::String &&  value)
inline

Reserved.

Definition at line 1438 of file SpotFleetRequestConfigData.h.

◆ WithContext() [2/3]

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::WithContext ( const Aws::String value)
inline

Reserved.

Definition at line 1433 of file SpotFleetRequestConfigData.h.

◆ WithContext() [3/3]

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::WithContext ( const char *  value)
inline

Reserved.

Definition at line 1443 of file SpotFleetRequestConfigData.h.

◆ WithExcessCapacityTerminationPolicy() [1/2]

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::WithExcessCapacityTerminationPolicy ( const ExcessCapacityTerminationPolicy value)
inline

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.

Definition at line 393 of file SpotFleetRequestConfigData.h.

◆ WithExcessCapacityTerminationPolicy() [2/2]

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::WithExcessCapacityTerminationPolicy ( ExcessCapacityTerminationPolicy &&  value)
inline

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.

Definition at line 400 of file SpotFleetRequestConfigData.h.

◆ WithFulfilledCapacity()

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::WithFulfilledCapacity ( double  value)
inline

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

Definition at line 425 of file SpotFleetRequestConfigData.h.

◆ WithIamFleetRole() [1/3]

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::WithIamFleetRole ( Aws::String &&  value)
inline

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 for Linux Instances. 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.

Definition at line 549 of file SpotFleetRequestConfigData.h.

◆ WithIamFleetRole() [2/3]

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::WithIamFleetRole ( const Aws::String value)
inline

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 for Linux Instances. 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.

Definition at line 535 of file SpotFleetRequestConfigData.h.

◆ WithIamFleetRole() [3/3]

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::WithIamFleetRole ( const char *  value)
inline

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 for Linux Instances. 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.

Definition at line 563 of file SpotFleetRequestConfigData.h.

◆ WithInstanceInterruptionBehavior() [1/2]

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::WithInstanceInterruptionBehavior ( const InstanceInterruptionBehavior value)
inline

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

Definition at line 1270 of file SpotFleetRequestConfigData.h.

◆ WithInstanceInterruptionBehavior() [2/2]

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::WithInstanceInterruptionBehavior ( InstanceInterruptionBehavior &&  value)
inline

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

Definition at line 1276 of file SpotFleetRequestConfigData.h.

◆ WithInstancePoolsToUseCount()

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::WithInstancePoolsToUseCount ( int  value)
inline

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.

Definition at line 1402 of file SpotFleetRequestConfigData.h.

◆ WithLaunchSpecifications() [1/2]

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::WithLaunchSpecifications ( Aws::Vector< SpotFleetLaunchSpecification > &&  value)
inline

The launch specifications for the Spot Fleet request. If you specify LaunchSpecifications, you can't specify LaunchTemplateConfigs. If you include On-Demand capacity in your request, you must use LaunchTemplateConfigs.

Definition at line 612 of file SpotFleetRequestConfigData.h.

◆ WithLaunchSpecifications() [2/2]

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::WithLaunchSpecifications ( const Aws::Vector< SpotFleetLaunchSpecification > &  value)
inline

The launch specifications for the Spot Fleet request. If you specify LaunchSpecifications, you can't specify LaunchTemplateConfigs. If you include On-Demand capacity in your request, you must use LaunchTemplateConfigs.

Definition at line 604 of file SpotFleetRequestConfigData.h.

◆ WithLaunchTemplateConfigs() [1/2]

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::WithLaunchTemplateConfigs ( Aws::Vector< LaunchTemplateConfig > &&  value)
inline

The launch template and overrides. If you specify LaunchTemplateConfigs, you can't specify LaunchSpecifications. If you include On-Demand capacity in your request, you must use LaunchTemplateConfigs.

Definition at line 677 of file SpotFleetRequestConfigData.h.

◆ WithLaunchTemplateConfigs() [2/2]

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::WithLaunchTemplateConfigs ( const Aws::Vector< LaunchTemplateConfig > &  value)
inline

The launch template and overrides. If you specify LaunchTemplateConfigs, you can't specify LaunchSpecifications. If you include On-Demand capacity in your request, you must use LaunchTemplateConfigs.

Definition at line 669 of file SpotFleetRequestConfigData.h.

◆ WithLoadBalancersConfig() [1/2]

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::WithLoadBalancersConfig ( const LoadBalancersConfig value)
inline

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.

Definition at line 1327 of file SpotFleetRequestConfigData.h.

◆ WithLoadBalancersConfig() [2/2]

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::WithLoadBalancersConfig ( LoadBalancersConfig &&  value)
inline

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.

Definition at line 1337 of file SpotFleetRequestConfigData.h.

◆ WithOnDemandAllocationStrategy() [1/2]

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::WithOnDemandAllocationStrategy ( const OnDemandAllocationStrategy value)
inline

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.

Definition at line 237 of file SpotFleetRequestConfigData.h.

◆ WithOnDemandAllocationStrategy() [2/2]

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::WithOnDemandAllocationStrategy ( OnDemandAllocationStrategy &&  value)
inline

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.

Definition at line 247 of file SpotFleetRequestConfigData.h.

◆ WithOnDemandFulfilledCapacity()

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::WithOnDemandFulfilledCapacity ( double  value)
inline

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

Definition at line 450 of file SpotFleetRequestConfigData.h.

◆ WithOnDemandMaxTotalPrice() [1/3]

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::WithOnDemandMaxTotalPrice ( Aws::String &&  value)
inline

The maximum amount per hour for On-Demand Instances that you're willing to pay. You can use the onDemandMaxTotalPrice parameter, the spotMaxTotalPrice 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.

Definition at line 901 of file SpotFleetRequestConfigData.h.

◆ WithOnDemandMaxTotalPrice() [2/3]

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::WithOnDemandMaxTotalPrice ( const Aws::String value)
inline

The maximum amount per hour for On-Demand Instances that you're willing to pay. You can use the onDemandMaxTotalPrice parameter, the spotMaxTotalPrice 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.

Definition at line 889 of file SpotFleetRequestConfigData.h.

◆ WithOnDemandMaxTotalPrice() [3/3]

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::WithOnDemandMaxTotalPrice ( const char *  value)
inline

The maximum amount per hour for On-Demand Instances that you're willing to pay. You can use the onDemandMaxTotalPrice parameter, the spotMaxTotalPrice 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.

Definition at line 913 of file SpotFleetRequestConfigData.h.

◆ WithOnDemandTargetCapacity()

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::WithOnDemandTargetCapacity ( int  value)
inline

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.

Definition at line 816 of file SpotFleetRequestConfigData.h.

◆ WithReplaceUnhealthyInstances()

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::WithReplaceUnhealthyInstances ( bool  value)
inline

Indicates whether Spot Fleet should replace unhealthy instances.

Definition at line 1239 of file SpotFleetRequestConfigData.h.

◆ WithSpotMaintenanceStrategies() [1/2]

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::WithSpotMaintenanceStrategies ( const SpotMaintenanceStrategies value)
inline

The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.

Definition at line 278 of file SpotFleetRequestConfigData.h.

◆ WithSpotMaintenanceStrategies() [2/2]

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::WithSpotMaintenanceStrategies ( SpotMaintenanceStrategies &&  value)
inline

The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.

Definition at line 284 of file SpotFleetRequestConfigData.h.

◆ WithSpotMaxTotalPrice() [1/3]

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::WithSpotMaxTotalPrice ( Aws::String &&  value)
inline

The maximum amount per hour for Spot Instances that you're willing to pay. You can use the spotdMaxTotalPrice parameter, the onDemandMaxTotalPrice 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.

Definition at line 998 of file SpotFleetRequestConfigData.h.

◆ WithSpotMaxTotalPrice() [2/3]

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::WithSpotMaxTotalPrice ( const Aws::String value)
inline

The maximum amount per hour for Spot Instances that you're willing to pay. You can use the spotdMaxTotalPrice parameter, the onDemandMaxTotalPrice 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.

Definition at line 986 of file SpotFleetRequestConfigData.h.

◆ WithSpotMaxTotalPrice() [3/3]

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::WithSpotMaxTotalPrice ( const char *  value)
inline

The maximum amount per hour for Spot Instances that you're willing to pay. You can use the spotdMaxTotalPrice parameter, the onDemandMaxTotalPrice 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.

Definition at line 1010 of file SpotFleetRequestConfigData.h.

◆ WithSpotPrice() [1/3]

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::WithSpotPrice ( Aws::String &&  value)
inline

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

Definition at line 736 of file SpotFleetRequestConfigData.h.

◆ WithSpotPrice() [2/3]

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::WithSpotPrice ( const Aws::String value)
inline

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

Definition at line 730 of file SpotFleetRequestConfigData.h.

◆ WithSpotPrice() [3/3]

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::WithSpotPrice ( const char *  value)
inline

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

Definition at line 742 of file SpotFleetRequestConfigData.h.

◆ WithTagSpecifications() [1/2]

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::WithTagSpecifications ( Aws::Vector< TagSpecification > &&  value)
inline

The key-value pair for tagging the Spot Fleet request on creation. The value for ResourceType must be spot-fleet-request, otherwise the Spot Fleet request fails. To tag instances at launch, specify the tags in the launch template (valid only if you use LaunchTemplateConfigs) or in the SpotFleetTagSpecification (valid only if you use LaunchSpecifications). For information about tagging after launch, see Tagging Your Resources.

Definition at line 1583 of file SpotFleetRequestConfigData.h.

◆ WithTagSpecifications() [2/2]

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::WithTagSpecifications ( const Aws::Vector< TagSpecification > &  value)
inline

The key-value pair for tagging the Spot Fleet request on creation. The value for ResourceType must be spot-fleet-request, otherwise the Spot Fleet request fails. To tag instances at launch, specify the tags in the launch template (valid only if you use LaunchTemplateConfigs) or in the SpotFleetTagSpecification (valid only if you use LaunchSpecifications). For information about tagging after launch, see Tagging Your Resources.

Definition at line 1566 of file SpotFleetRequestConfigData.h.

◆ WithTargetCapacity()

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::WithTargetCapacity ( int  value)
inline

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.

Definition at line 779 of file SpotFleetRequestConfigData.h.

◆ WithTargetCapacityUnitType() [1/2]

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::WithTargetCapacityUnitType ( const TargetCapacityUnitType value)
inline

The unit for the target capacity.

Default: units (translates to number of instances)

Definition at line 1474 of file SpotFleetRequestConfigData.h.

◆ WithTargetCapacityUnitType() [2/2]

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::WithTargetCapacityUnitType ( TargetCapacityUnitType &&  value)
inline

The unit for the target capacity.

Default: units (translates to number of instances)

Definition at line 1480 of file SpotFleetRequestConfigData.h.

◆ WithTerminateInstancesWithExpiration()

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::WithTerminateInstancesWithExpiration ( bool  value)
inline

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

Definition at line 1035 of file SpotFleetRequestConfigData.h.

◆ WithType() [1/2]

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::WithType ( const FleetType value)
inline

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 is maintain, 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.

Definition at line 1106 of file SpotFleetRequestConfigData.h.

◆ WithType() [2/2]

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::WithType ( FleetType &&  value)
inline

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 is maintain, 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.

Definition at line 1120 of file SpotFleetRequestConfigData.h.

◆ WithValidFrom() [1/2]

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::WithValidFrom ( Aws::Utils::DateTime &&  value)
inline

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.

Definition at line 1163 of file SpotFleetRequestConfigData.h.

◆ WithValidFrom() [2/2]

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::WithValidFrom ( const Aws::Utils::DateTime value)
inline

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.

Definition at line 1156 of file SpotFleetRequestConfigData.h.

◆ WithValidUntil() [1/2]

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::WithValidUntil ( Aws::Utils::DateTime &&  value)
inline

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.

Definition at line 1218 of file SpotFleetRequestConfigData.h.

◆ WithValidUntil() [2/2]

SpotFleetRequestConfigData& Aws::EC2::Model::SpotFleetRequestConfigData::WithValidUntil ( const Aws::Utils::DateTime value)
inline

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.

Definition at line 1209 of file SpotFleetRequestConfigData.h.


The documentation for this class was generated from the following file: