AWSEC2SpotFleetRequestConfigData
Objective-C
@interface AWSEC2SpotFleetRequestConfigData
Swift
class AWSEC2SpotFleetRequestConfigData
Describes the configuration of a Spot Fleet request.
Required parameters: [IamFleetRole, TargetCapacity]
-
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, usecapacityOptimizedPrioritized
. Set a priority for each instance type by using thePriority
parameter forLaunchTemplateOverrides
. You can assign the same priority to differentLaunchTemplateOverrides
. EC2 implements the priorities on a best-effort basis, but optimizes for capacity first.capacityOptimizedPrioritized
is supported only if your Spot Fleet uses a launch template. Note that if theOnDemandAllocationStrategy
is set toprioritized
, the same priority is applied when fulfilling On-Demand capacity.Declaration
Objective-C
@property (nonatomic) AWSEC2AllocationStrategy allocationStrategy;
Swift
var allocationStrategy: AWSEC2AllocationStrategy { get set }
-
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.
Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable clientToken;
Swift
var clientToken: String? { get set }
-
Reserved.
Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable context;
Swift
var context: String? { get set }
-
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.
Declaration
Objective-C
@property (nonatomic) AWSEC2ExcessCapacityTerminationPolicy excessCapacityTerminationPolicy;
Swift
var excessCapacityTerminationPolicy: AWSEC2ExcessCapacityTerminationPolicy { get set }
-
The number of units fulfilled by this request compared to the set target capacity. You cannot set this value.
Declaration
Objective-C
@property (nonatomic, strong) NSNumber *_Nullable fulfilledCapacity;
Swift
var fulfilledCapacity: NSNumber? { get set }
-
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
.Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable iamFleetRole;
Swift
var iamFleetRole: String? { get set }
-
The behavior when a Spot Instance is interrupted. The default is
terminate
.Declaration
Objective-C
@property (nonatomic) AWSEC2InstanceInterruptionBehavior instanceInterruptionBehavior;
Swift
var instanceInterruptionBehavior: AWSEC2InstanceInterruptionBehavior { get set }
-
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.
Declaration
Objective-C
@property (nonatomic, strong) NSNumber *_Nullable instancePoolsToUseCount;
Swift
var instancePoolsToUseCount: NSNumber? { get set }
-
The launch specifications for the Spot Fleet request. If you specify
LaunchSpecifications
, you can’t specifyLaunchTemplateConfigs
. If you include On-Demand capacity in your request, you must useLaunchTemplateConfigs
.Declaration
Objective-C
@property (nonatomic, strong) NSArray<AWSEC2SpotFleetLaunchSpecification *> *_Nullable launchSpecifications;
Swift
var launchSpecifications: [AWSEC2SpotFleetLaunchSpecification]? { get set }
-
The launch template and overrides. If you specify
LaunchTemplateConfigs
, you can’t specifyLaunchSpecifications
. If you include On-Demand capacity in your request, you must useLaunchTemplateConfigs
.Declaration
Objective-C
@property (nonatomic, strong) NSArray<AWSEC2LaunchTemplateConfig *> *_Nullable launchTemplateConfigs;
Swift
var launchTemplateConfigs: [AWSEC2LaunchTemplateConfig]? { get set }
-
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.
Declaration
Objective-C
@property (nonatomic, strong) AWSEC2LoadBalancersConfig *_Nullable loadBalancersConfig;
Swift
var loadBalancersConfig: AWSEC2LoadBalancersConfig? { get set }
-
The order of the launch template overrides to use in fulfilling On-Demand capacity. If you specify
lowestPrice
, Spot Fleet uses price to determine the order, launching the lowest price first. If you specifyprioritized
, Spot Fleet uses the priority that you assign to each Spot Fleet launch template override, launching the highest priority first. If you do not specify a value, Spot Fleet defaults tolowestPrice
.Declaration
Objective-C
@property (nonatomic) AWSEC2OnDemandAllocationStrategy onDemandAllocationStrategy;
Swift
var onDemandAllocationStrategy: AWSEC2OnDemandAllocationStrategy { get set }
-
The number of On-Demand units fulfilled by this request compared to the set target On-Demand capacity.
Declaration
Objective-C
@property (nonatomic, strong) NSNumber *_Nullable onDemandFulfilledCapacity;
Swift
var onDemandFulfilledCapacity: NSNumber? { get set }
-
The maximum amount per hour for On-Demand Instances that you’re willing to pay. You can use the
onDemandMaxTotalPrice
parameter, thespotMaxTotalPrice
parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum amount you’re willing to pay. When the maximum amount you’re willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity.Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable onDemandMaxTotalPrice;
Swift
var onDemandMaxTotalPrice: String? { get set }
-
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.Declaration
Objective-C
@property (nonatomic, strong) NSNumber *_Nullable onDemandTargetCapacity;
Swift
var onDemandTargetCapacity: NSNumber? { get set }
-
Indicates whether Spot Fleet should replace unhealthy instances.
Declaration
Objective-C
@property (nonatomic, strong) NSNumber *_Nullable replaceUnhealthyInstances;
Swift
var replaceUnhealthyInstances: NSNumber? { get set }
-
The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.
Declaration
Objective-C
@property (nonatomic, strong) AWSEC2SpotMaintenanceStrategies *_Nullable spotMaintenanceStrategies;
Swift
var spotMaintenanceStrategies: AWSEC2SpotMaintenanceStrategies? { get set }
-
The maximum amount per hour for Spot Instances that you’re willing to pay. You can use the
spotdMaxTotalPrice
parameter, theonDemandMaxTotalPrice
parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum amount you’re willing to pay. When the maximum amount you’re willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity.Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable spotMaxTotalPrice;
Swift
var spotMaxTotalPrice: String? { get set }
-
The maximum price per unit hour that you are willing to pay for a Spot Instance. The default is the On-Demand price.
Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable spotPrice;
Swift
var spotPrice: String? { get set }
-
The key-value pair for tagging the Spot Fleet request on creation. The value for
ResourceType
must bespot-fleet-request
, otherwise the Spot Fleet request fails. To tag instances at launch, specify the tags in the launch template (valid only if you useLaunchTemplateConfigs
) or in theSpotFleetTagSpecification
(valid only if you useLaunchSpecifications
). For information about tagging after launch, see Tagging Your Resources.Declaration
Objective-C
@property (nonatomic, strong) NSArray<AWSEC2TagSpecification *> *_Nullable tagSpecifications;
Swift
var tagSpecifications: [AWSEC2TagSpecification]? { get set }
-
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.Declaration
Objective-C
@property (nonatomic, strong) NSNumber *_Nullable targetCapacity;
Swift
var targetCapacity: NSNumber? { get set }
-
The unit for the target capacity.
Default:
units
(translates to number of instances)Declaration
Objective-C
@property (nonatomic) AWSEC2TargetCapacityUnitType targetCapacityUnitType;
Swift
var targetCapacityUnitType: AWSEC2TargetCapacityUnitType { get set }
-
Indicates whether running Spot Instances are terminated when the Spot Fleet request expires.
Declaration
Objective-C
@property (nonatomic, strong) NSNumber *_Nullable terminateInstancesWithExpiration;
Swift
var terminateInstancesWithExpiration: NSNumber? { get set }
-
The type of request. Indicates whether the Spot Fleet only requests the target capacity or also attempts to maintain it. When this value is
request
, the Spot Fleet only places the required requests. It does not attempt to replenish Spot Instances if capacity is diminished, nor does it submit requests in alternative Spot pools if capacity is not available. When this value ismaintain
, the Spot Fleet maintains the target capacity. The Spot Fleet places the required requests to meet capacity and automatically replenishes any interrupted instances. Default:maintain
.instant
is listed but is not used by Spot Fleet.Declaration
Objective-C
@property (nonatomic) AWSEC2FleetType types;
Swift
var types: AWSEC2FleetType { get set }
-
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.
Declaration
Objective-C
@property (nonatomic, strong) NSDate *_Nullable validFrom;
Swift
var validFrom: Date? { get set }
-
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.
Declaration
Objective-C
@property (nonatomic, strong) NSDate *_Nullable validUntil;
Swift
var validUntil: Date? { get set }