Class SpotFleetRequestConfigData
- java.lang.Object
-
- com.amazonaws.services.ec2.model.SpotFleetRequestConfigData
-
- All Implemented Interfaces:
Serializable
,Cloneable
public class SpotFleetRequestConfigData extends Object implements Serializable, Cloneable
Describes the configuration of a Spot fleet request.
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description SpotFleetRequestConfigData()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SpotFleetRequestConfigData
clone()
boolean
equals(Object obj)
String
getAllocationStrategy()
Indicates how to allocate the target capacity across the Spot pools specified by the Spot fleet request.String
getClientToken()
A unique, case-sensitive identifier you provide to ensure idempotency of your listings.String
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.String
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 setterminateInstancesWithExpiration
.List<SpotFleetLaunchSpecification>
getLaunchSpecifications()
Information about the launch specifications for the Spot fleet request.String
getSpotPrice()
The bid price per unit hour.Integer
getTargetCapacity()
The number of units to request.Boolean
getTerminateInstancesWithExpiration()
Indicates whether running Spot instances should be terminated when the Spot fleet request expires.Date
getValidFrom()
The start date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).Date
getValidUntil()
The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).int
hashCode()
Boolean
isTerminateInstancesWithExpiration()
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).String
toString()
Returns a string representation of this object; useful for testing and debugging.SpotFleetRequestConfigData
withAllocationStrategy(AllocationStrategy allocationStrategy)
Indicates how to allocate the target capacity across the Spot pools specified by the Spot fleet request.SpotFleetRequestConfigData
withAllocationStrategy(String allocationStrategy)
Indicates how to allocate the target capacity across the Spot pools specified by the Spot fleet request.SpotFleetRequestConfigData
withClientToken(String clientToken)
A unique, case-sensitive identifier you provide to ensure idempotency of your listings.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.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.SpotFleetRequestConfigData
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
.SpotFleetRequestConfigData
withLaunchSpecifications(SpotFleetLaunchSpecification... launchSpecifications)
Information about the launch specifications for the Spot fleet request.SpotFleetRequestConfigData
withLaunchSpecifications(Collection<SpotFleetLaunchSpecification> launchSpecifications)
Information about the launch specifications for the Spot fleet request.SpotFleetRequestConfigData
withSpotPrice(String spotPrice)
The bid price per unit hour.SpotFleetRequestConfigData
withTargetCapacity(Integer targetCapacity)
The number of units to request.SpotFleetRequestConfigData
withTerminateInstancesWithExpiration(Boolean terminateInstancesWithExpiration)
Indicates whether running Spot instances should be terminated when the Spot fleet request expires.SpotFleetRequestConfigData
withValidFrom(Date validFrom)
The start date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).SpotFleetRequestConfigData
withValidUntil(Date validUntil)
The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
-
-
-
Method Detail
-
setClientToken
public void setClientToken(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.
- 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
public String 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
public SpotFleetRequestConfigData withClientToken(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.
- 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
public void setSpotPrice(String spotPrice)
The bid price per unit hour.
- Parameters:
spotPrice
- The bid price per unit hour.
-
getSpotPrice
public String getSpotPrice()
The bid price per unit hour.
- Returns:
- The bid price per unit hour.
-
withSpotPrice
public SpotFleetRequestConfigData withSpotPrice(String spotPrice)
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
public void setTargetCapacity(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.
- 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
public Integer 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
public SpotFleetRequestConfigData withTargetCapacity(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.
- 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
public void setValidFrom(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.
- 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
public Date 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
public SpotFleetRequestConfigData withValidFrom(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.
- 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
public void setValidUntil(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.
- 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
public Date 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
public SpotFleetRequestConfigData withValidUntil(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.
- 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
public void setTerminateInstancesWithExpiration(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.
-
getTerminateInstancesWithExpiration
public Boolean 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
public Boolean 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
public 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 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
public String 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
public SpotFleetRequestConfigData 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 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
public List<SpotFleetLaunchSpecification> getLaunchSpecifications()
Information about the launch specifications for the Spot fleet request.
- Returns:
- Information about the launch specifications for the Spot fleet request.
-
setLaunchSpecifications
public void setLaunchSpecifications(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.
-
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
public 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.
- 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:
ExcessCapacityTerminationPolicy
-
getExcessCapacityTerminationPolicy
public String 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:
ExcessCapacityTerminationPolicy
-
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:
ExcessCapacityTerminationPolicy
-
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:
ExcessCapacityTerminationPolicy
-
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:
ExcessCapacityTerminationPolicy
-
setAllocationStrategy
public void setAllocationStrategy(String allocationStrategy)
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:
AllocationStrategy
-
getAllocationStrategy
public String 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:
AllocationStrategy
-
withAllocationStrategy
public SpotFleetRequestConfigData withAllocationStrategy(String allocationStrategy)
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:
AllocationStrategy
-
setAllocationStrategy
public void setAllocationStrategy(AllocationStrategy allocationStrategy)
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:
AllocationStrategy
-
withAllocationStrategy
public SpotFleetRequestConfigData withAllocationStrategy(AllocationStrategy allocationStrategy)
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:
AllocationStrategy
-
toString
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public SpotFleetRequestConfigData clone()
-
-