@Generated(value="software.amazon.awssdk:codegen") public class SpotFleetRequestConfigData extends Object implements ToCopyableBuilder<SpotFleetRequestConfigData.Builder,SpotFleetRequestConfigData>
Describes the configuration of a Spot fleet request.
Modifier and Type | Class and Description |
---|---|
static interface |
SpotFleetRequestConfigData.Builder |
Modifier and Type | Method and Description |
---|---|
AllocationStrategy |
allocationStrategy()
Indicates how to allocate the target capacity across the Spot pools specified by the Spot fleet request.
|
String |
allocationStrategyString()
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) |
ExcessCapacityTerminationPolicy |
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.
|
String |
excessCapacityTerminationPolicyString()
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.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
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 . |
InstanceInterruptionBehavior |
instanceInterruptionBehavior()
Indicates whether a Spot instance stops or terminates when it is interrupted.
|
String |
instanceInterruptionBehaviorString()
Indicates whether a Spot instance stops or terminates when it is interrupted.
|
List<SpotFleetLaunchSpecification> |
launchSpecifications()
Information about the launch specifications for the Spot fleet request.
|
LoadBalancersConfig |
loadBalancersConfig()
One or more Classic Load Balancers and target groups to attach to 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() |
FleetType |
type()
The type of request.
|
String |
typeString()
The type of request.
|
Instant |
validFrom()
The start date and time of the request, in UTC format (for example,
YYYY-MM-DDTHH:MM:SSZ).
|
Instant |
validUntil()
The end date and time of the request, in UTC format (for example,
YYYY-MM-DDTHH:MM:SSZ).
|
copy
public AllocationStrategy allocationStrategy()
Indicates how to allocate the target capacity across the Spot pools specified by the Spot fleet request. The
default is lowestPrice
.
If the service returns an enum value that is not available in the current SDK version,
allocationStrategy
will return AllocationStrategy.UNKNOWN_TO_SDK_VERSION
. The raw value returned
by the service is available from allocationStrategyString()
.
lowestPrice
.AllocationStrategy
public String allocationStrategyString()
Indicates how to allocate the target capacity across the Spot pools specified by the Spot fleet request. The
default is lowestPrice
.
If the service returns an enum value that is not available in the current SDK version,
allocationStrategy
will return AllocationStrategy.UNKNOWN_TO_SDK_VERSION
. The raw value returned
by the service is available from allocationStrategyString()
.
lowestPrice
.AllocationStrategy
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.
public ExcessCapacityTerminationPolicy 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.
If the service returns an enum value that is not available in the current SDK version,
excessCapacityTerminationPolicy
will return
ExcessCapacityTerminationPolicy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is
available from excessCapacityTerminationPolicyString()
.
ExcessCapacityTerminationPolicy
public String excessCapacityTerminationPolicyString()
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.
If the service returns an enum value that is not available in the current SDK version,
excessCapacityTerminationPolicy
will return
ExcessCapacityTerminationPolicy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is
available from excessCapacityTerminationPolicyString()
.
ExcessCapacityTerminationPolicy
public Double fulfilledCapacity()
The number of units fulfilled by this request compared to the set target capacity.
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
.
terminateInstancesWithExpiration
.public List<SpotFleetLaunchSpecification> launchSpecifications()
Information about the launch specifications for the Spot fleet request.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public String spotPrice()
The bid price per unit hour.
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.
public Boolean terminateInstancesWithExpiration()
Indicates whether running Spot instances should be terminated when the Spot fleet request expires.
public FleetType 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
.
If the service returns an enum value that is not available in the current SDK version, type
will return
FleetType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
typeString()
.
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
.FleetType
public String typeString()
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
.
If the service returns an enum value that is not available in the current SDK version, type
will return
FleetType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
typeString()
.
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
.FleetType
public Instant 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.
public Instant 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.
public Boolean replaceUnhealthyInstances()
Indicates whether Spot fleet should replace unhealthy instances.
public InstanceInterruptionBehavior instanceInterruptionBehavior()
Indicates whether a Spot instance stops or terminates when it is interrupted.
If the service returns an enum value that is not available in the current SDK version,
instanceInterruptionBehavior
will return InstanceInterruptionBehavior.UNKNOWN_TO_SDK_VERSION
.
The raw value returned by the service is available from instanceInterruptionBehaviorString()
.
InstanceInterruptionBehavior
public String instanceInterruptionBehaviorString()
Indicates whether a Spot instance stops or terminates when it is interrupted.
If the service returns an enum value that is not available in the current SDK version,
instanceInterruptionBehavior
will return InstanceInterruptionBehavior.UNKNOWN_TO_SDK_VERSION
.
The raw value returned by the service is available from instanceInterruptionBehaviorString()
.
InstanceInterruptionBehavior
public LoadBalancersConfig loadBalancersConfig()
One or more Classic Load Balancers and target groups to attach to the Spot fleet request. Spot fleet registers the running Spot instances with the specified Classic Load Balancers and target groups.
With Network Load Balancers, Spot fleet cannot register instances that have the following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1.
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.
public SpotFleetRequestConfigData.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<SpotFleetRequestConfigData.Builder,SpotFleetRequestConfigData>
public static SpotFleetRequestConfigData.Builder builder()
public static Class<? extends SpotFleetRequestConfigData.Builder> serializableBuilderClass()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.