Class SpotFleetRequestConfigData
- All Implemented Interfaces:
Serializable
,Cloneable
Describes the configuration of a Spot fleet request.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
Indicates how to allocate the target capacity across the Spot pools specified by the Spot fleet request.A unique, case-sensitive identifier you provide to ensure idempotency of your listings.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.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 setterminateInstancesWithExpiration
.Information about the launch specifications for the Spot fleet request.The bid price per unit hour.The number of units to request.Indicates whether running Spot instances should be terminated when the Spot fleet request expires.The start date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).int
hashCode()
Indicates whether running Spot instances should be terminated when the Spot fleet request expires.void
setAllocationStrategy
(AllocationStrategy allocationStrategy) Indicates how to allocate the target capacity across the Spot pools specified by the Spot fleet request.void
setAllocationStrategy
(String allocationStrategy) Indicates how to allocate the target capacity across the Spot pools specified by the Spot fleet request.void
setClientToken
(String clientToken) A unique, case-sensitive identifier you provide to ensure idempotency of your listings.void
setExcessCapacityTerminationPolicy
(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.void
setExcessCapacityTerminationPolicy
(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.void
setIamFleetRole
(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 setterminateInstancesWithExpiration
.void
setLaunchSpecifications
(Collection<SpotFleetLaunchSpecification> launchSpecifications) Information about the launch specifications for the Spot fleet request.void
setSpotPrice
(String spotPrice) The bid price per unit hour.void
setTargetCapacity
(Integer targetCapacity) The number of units to request.void
setTerminateInstancesWithExpiration
(Boolean terminateInstancesWithExpiration) Indicates whether running Spot instances should be terminated when the Spot fleet request expires.void
setValidFrom
(Date validFrom) The start date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).void
setValidUntil
(Date validUntil) The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).toString()
Returns a string representation of this object; useful for testing and debugging.withAllocationStrategy
(AllocationStrategy allocationStrategy) Indicates how to allocate the target capacity across the Spot pools specified by the Spot fleet request.withAllocationStrategy
(String allocationStrategy) Indicates how to allocate the target capacity across the Spot pools specified by the Spot fleet request.withClientToken
(String clientToken) A unique, case-sensitive identifier you provide to ensure idempotency of your listings.withExcessCapacityTerminationPolicy
(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.withExcessCapacityTerminationPolicy
(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.withIamFleetRole
(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 setterminateInstancesWithExpiration
.withLaunchSpecifications
(SpotFleetLaunchSpecification... launchSpecifications) Information about the launch specifications for the Spot fleet request.withLaunchSpecifications
(Collection<SpotFleetLaunchSpecification> launchSpecifications) Information about the launch specifications for the Spot fleet request.withSpotPrice
(String spotPrice) The bid price per unit hour.withTargetCapacity
(Integer targetCapacity) The number of units to request.withTerminateInstancesWithExpiration
(Boolean terminateInstancesWithExpiration) Indicates whether running Spot instances should be terminated when the Spot fleet request expires.withValidFrom
(Date validFrom) The start date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).withValidUntil
(Date validUntil) The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
-
Constructor Details
-
SpotFleetRequestConfigData
public SpotFleetRequestConfigData()
-
-
Method Details
-
setClientToken
A unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency.
- Parameters:
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.
-
getClientToken
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.
-
withClientToken
A unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
setSpotPrice
The bid price per unit hour.
- Parameters:
spotPrice
- The bid price per unit hour.
-
getSpotPrice
The bid price per unit hour.
- Returns:
- The bid price per unit hour.
-
withSpotPrice
The bid price per unit hour.
- Parameters:
spotPrice
- The bid price per unit hour.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setTargetCapacity
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.
- Parameters:
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.
-
getTargetCapacity
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.
-
withTargetCapacity
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
setValidFrom
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.
- Parameters:
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.
-
getValidFrom
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.
-
withValidFrom
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
setValidUntil
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.
- Parameters:
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.
-
getValidUntil
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.
-
withValidUntil
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
setTerminateInstancesWithExpiration
Indicates whether running Spot instances should be terminated when the Spot fleet request expires.
- Parameters:
terminateInstancesWithExpiration
- Indicates whether running Spot instances should be terminated when the Spot fleet request expires.
-
getTerminateInstancesWithExpiration
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.
-
withTerminateInstancesWithExpiration
public SpotFleetRequestConfigData withTerminateInstancesWithExpiration(Boolean terminateInstancesWithExpiration) Indicates whether running Spot instances should be terminated when the Spot fleet request expires.
- Parameters:
terminateInstancesWithExpiration
- Indicates whether running Spot instances should be terminated when the Spot fleet request expires.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isTerminateInstancesWithExpiration
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.
-
setIamFleetRole
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
.- Parameters:
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 setterminateInstancesWithExpiration
.
-
getIamFleetRole
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
.
-
withIamFleetRole
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
.- Parameters:
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 setterminateInstancesWithExpiration
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getLaunchSpecifications
Information about the launch specifications for the Spot fleet request.
- Returns:
- Information about the launch specifications for the Spot fleet request.
-
setLaunchSpecifications
Information about the launch specifications for the Spot fleet request.
- Parameters:
launchSpecifications
- Information about the launch specifications for the Spot fleet request.
-
withLaunchSpecifications
public SpotFleetRequestConfigData withLaunchSpecifications(SpotFleetLaunchSpecification... launchSpecifications) Information about the launch specifications for the Spot fleet request.
NOTE: This method appends the values to the existing list (if any). Use
setLaunchSpecifications(java.util.Collection)
orwithLaunchSpecifications(java.util.Collection)
if you want to override the existing values.- Parameters:
launchSpecifications
- Information about the launch specifications for the Spot fleet request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withLaunchSpecifications
public SpotFleetRequestConfigData withLaunchSpecifications(Collection<SpotFleetLaunchSpecification> launchSpecifications) Information about the launch specifications for the Spot fleet request.
- Parameters:
launchSpecifications
- Information about the launch specifications for the Spot fleet request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setExcessCapacityTerminationPolicy
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.
- Parameters:
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.- See Also:
-
getExcessCapacityTerminationPolicy
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:
-
withExcessCapacityTerminationPolicy
public SpotFleetRequestConfigData withExcessCapacityTerminationPolicy(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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setExcessCapacityTerminationPolicy
public void setExcessCapacityTerminationPolicy(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.
- Parameters:
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.- See Also:
-
withExcessCapacityTerminationPolicy
public SpotFleetRequestConfigData withExcessCapacityTerminationPolicy(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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setAllocationStrategy
Indicates how to allocate the target capacity across the Spot pools specified by the Spot fleet request. The default is
lowestPrice
.- Parameters:
allocationStrategy
- Indicates how to allocate the target capacity across the Spot pools specified by the Spot fleet request. The default islowestPrice
.- See Also:
-
getAllocationStrategy
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:
-
withAllocationStrategy
Indicates how to allocate the target capacity across the Spot pools specified by the Spot fleet request. The default is
lowestPrice
.- Parameters:
allocationStrategy
- Indicates how to allocate the target capacity across the Spot pools specified by the Spot fleet request. The default islowestPrice
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setAllocationStrategy
Indicates how to allocate the target capacity across the Spot pools specified by the Spot fleet request. The default is
lowestPrice
.- Parameters:
allocationStrategy
- Indicates how to allocate the target capacity across the Spot pools specified by the Spot fleet request. The default islowestPrice
.- See Also:
-
withAllocationStrategy
Indicates how to allocate the target capacity across the Spot pools specified by the Spot fleet request. The default is
lowestPrice
.- Parameters:
allocationStrategy
- Indicates how to allocate the target capacity across the Spot pools specified by the Spot fleet request. The default islowestPrice
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-