Menu
Amazon Elastic Compute Cloud
API Reference (API Version 2016-11-15)

SpotFleetRequestConfigData

Describes the configuration of a Spot Fleet request.

Contents

AllocationStrategy (request), allocationStrategy (response)

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

Type: String

Valid Values: lowestPrice | diversified

Required: No

ClientToken (request), clientToken (response)

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.

Type: String

Required: No

ExcessCapacityTerminationPolicy (request), excessCapacityTerminationPolicy (response)

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

Type: String

Valid Values: noTermination | default

Required: No

FulfilledCapacity (request), fulfilledCapacity (response)

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

Type: Double

Required: No

IamFleetRole (request), iamFleetRole (response)

Grants the Spot Fleet permission to terminate Spot Instances on your behalf when you cancel its Spot Fleet request using CancelSpotFleetRequests or when the Spot Fleet request expires, if you set terminateInstancesWithExpiration.

Type: String

Required: Yes

InstanceInterruptionBehavior (request), instanceInterruptionBehavior (response)

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

Type: String

Valid Values: hibernate | stop | terminate

Required: No

InstancePoolsToUseCount (request), instancePoolsToUseCount (response)

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.

Type: Integer

Required: No

LaunchSpecifications (request), launchSpecifications (response)

The launch specifications for the Spot Fleet request.

Type: Array of SpotFleetLaunchSpecification objects

Required: No

LaunchTemplateConfigs (request), launchTemplateConfigs (response)

The launch template and overrides.

Type: Array of LaunchTemplateConfig objects

Required: No

LoadBalancersConfig (request), loadBalancersConfig (response)

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.

Type: LoadBalancersConfig object

Required: No

OnDemandAllocationStrategy (request), onDemandAllocationStrategy (response)

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.

Type: String

Valid Values: lowestPrice | prioritized

Required: No

OnDemandFulfilledCapacity (request), onDemandFulfilledCapacity (response)

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

Type: Double

Required: No

OnDemandTargetCapacity (request), onDemandTargetCapacity (response)

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.

Type: Integer

Required: No

ReplaceUnhealthyInstances (request), replaceUnhealthyInstances (response)

Indicates whether Spot Fleet should replace unhealthy instances.

Type: Boolean

Required: No

SpotPrice (request), spotPrice (response)

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

Type: String

Required: No

TargetCapacity (request), targetCapacity (response)

The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.

Type: Integer

Required: Yes

TerminateInstancesWithExpiration (request), terminateInstancesWithExpiration (response)

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

Type: Boolean

Required: No

Type (request), type (response)

The type of request. Indicates whether the Spot Fleet only requests the target capacity or also attempts to maintain it. When this value is request, the Spot Fleet only places the required requests. It does not attempt to replenish Spot Instances if capacity is diminished, nor does it submit requests in alternative Spot pools if capacity is not available. To maintain a certain target capacity, the Spot Fleet places the required requests to meet capacity and automatically replenishes any interrupted instances. Default: maintain.

Type: String

Valid Values: request | maintain

Required: No

ValidFrom (request), validFrom (response)

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

Type: Timestamp

Required: No

ValidUntil (request), validUntil (response)

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

Type: Timestamp

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: