SpotFleetRequestConfigData (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.ec2.model.SpotFleetRequestConfigData

All Implemented Interfaces:: ToCopyableBuilder<SpotFleetRequestConfigData.Builder,SpotFleetRequestConfigData>

@Generated("software.amazon.awssdk:codegen")
public class SpotFleetRequestConfigData
extends Object
implements ToCopyableBuilder<SpotFleetRequestConfigData.Builder,SpotFleetRequestConfigData>

Describes the configuration of a Spot fleet request.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface SpotFleetRequestConfigData.Builder

Nested Classes
Modifier and Type	Class	Description
`static interface`	`SpotFleetRequestConfigData.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`allocationStrategy()`	Indicates how to allocate the target capacity across the Spot pools specified by the Spot fleet request.
`static SpotFleetRequestConfigData.Builder`	`builder()`
`String`	`clientToken()`	A unique, case-sensitive identifier you provide to ensure idempotency of your listings.
`boolean`	`equals(Object obj)`
`String`	`excessCapacityTerminationPolicy()`	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.
`Double`	`fulfilledCapacity()`	The number of units fulfilled by this request compared to the set target capacity.
`int`	`hashCode()`
`String`	`iamFleetRole()`	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`.
`List<SpotFleetLaunchSpecification>`	`launchSpecifications()`	Information about the launch specifications for the Spot fleet request.
`Boolean`	`replaceUnhealthyInstances()`	Indicates whether Spot fleet should replace unhealthy instances.
`static Class<? extends SpotFleetRequestConfigData.Builder>`	`serializableBuilderClass()`
`String`	`spotPrice()`	The bid price per unit hour.
`Integer`	`targetCapacity()`	The number of units to request.
`Boolean`	`terminateInstancesWithExpiration()`	Indicates whether running Spot instances should be terminated when the Spot fleet request expires.
`SpotFleetRequestConfigData.Builder`	`toBuilder()`	Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`String`	`type()`	The type of request.
`Date`	`validFrom()`	The start date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
`Date`	`validUntil()`	The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - allocationStrategy
```
public String allocationStrategy()
```
    Indicates how to allocate the target capacity across the Spot pools specified by the Spot fleet request. The default is lowestPrice.
    
    Returns:
    
    Indicates how to allocate the target capacity across the Spot pools specified by the Spot fleet request. The default is lowestPrice.
    
    See Also:
    
    AllocationStrategy
  - clientToken
```
public String clientToken()
```
    A unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency.
    
    Returns:
    
    A unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency.
  - excessCapacityTerminationPolicy
```
public String excessCapacityTerminationPolicy()
```
    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.
    
    Returns:
    
    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.
    
    See Also:
    
    ExcessCapacityTerminationPolicy
  - fulfilledCapacity
```
public Double fulfilledCapacity()
```
    The number of units fulfilled by this request compared to the set target capacity.
    
    Returns:
    
    The number of units fulfilled by this request compared to the set target capacity.
  - iamFleetRole
```
public String iamFleetRole()
```
    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.
    
    Returns:
    
    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.
  - launchSpecifications
```
public List<SpotFleetLaunchSpecification> launchSpecifications()
```
    Information about the launch specifications for the Spot fleet request.
    
    Returns:
    
    Information about the launch specifications for the Spot fleet request.
  - spotPrice
```
public String spotPrice()
```
    The bid price per unit hour.
    
    Returns:
    
    The bid price per unit hour.
  - targetCapacity
```
public Integer targetCapacity()
```
    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.
    
    Returns:
    
    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.
  - terminateInstancesWithExpiration
```
public Boolean terminateInstancesWithExpiration()
```
    Indicates whether running Spot instances should be terminated when the Spot fleet request expires.
    
    Returns:
    
    Indicates whether running Spot instances should be terminated when the Spot fleet request expires.
  - type
```
public String type()
```
    The type of request. Indicates whether the fleet will only request the target capacity or also attempt to maintain it. When you request a certain target capacity, the fleet will only place the required bids. It will not attempt to replenish Spot instances if capacity is diminished, nor will it submit bids in alternative Spot pools if capacity is not available. When you want to maintain a certain target capacity, fleet will place the required bids to meet this target capacity. It will also automatically replenish any interrupted instances. Default: maintain.
    
    Returns:
    
    The type of request. Indicates whether the fleet will only request the target capacity or also attempt to maintain it. When you request a certain target capacity, the fleet will only place the required bids. It will not attempt to replenish Spot instances if capacity is diminished, nor will it submit bids in alternative Spot pools if capacity is not available. When you want to maintain a certain target capacity, fleet will place the required bids to meet this target capacity. It will also automatically replenish any interrupted instances. Default: maintain.
    
    See Also:
    
    FleetType
  - validFrom
```
public Date validFrom()
```
    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.
    
    Returns:
    
    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.
  - validUntil
```
public Date validUntil()
```
    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 enabled to fulfill the request.
    
    Returns:
    
    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 enabled to fulfill the request.
  - replaceUnhealthyInstances
```
public Boolean replaceUnhealthyInstances()
```
    Indicates whether Spot fleet should replace unhealthy instances.
    
    Returns:
    
    Indicates whether Spot fleet should replace unhealthy instances.
  - toBuilder
```
public SpotFleetRequestConfigData.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<SpotFleetRequestConfigData.Builder,SpotFleetRequestConfigData>
    
    Returns:
    
    a builder for type T
  - builder
```
public static SpotFleetRequestConfigData.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends SpotFleetRequestConfigData.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class SpotFleetRequestConfigData

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

allocationStrategy

clientToken

excessCapacityTerminationPolicy

fulfilledCapacity

iamFleetRole

launchSpecifications

spotPrice

targetCapacity

terminateInstancesWithExpiration

type

validFrom

validUntil

replaceUnhealthyInstances

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString