com.amazonaws.services.ec2.model

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 and Description
SpotFleetRequestConfigData()

Method Summary

Methods

Modifier and Type	Method and 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 set terminateInstancesWithExpiration.
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 set terminateInstancesWithExpiration.
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 set terminateInstancesWithExpiration.
SpotFleetRequestConfigData	withLaunchSpecifications(Collection<SpotFleetLaunchSpecification> launchSpecifications) Information about the launch specifications for the Spot fleet request.
SpotFleetRequestConfigData	withLaunchSpecifications(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).

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SpotFleetRequestConfigData

public SpotFleetRequestConfigData()

Method Detail

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.

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.

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.

Returns a reference to this object so that method calls can be chained together.

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:

A reference to this updated object so that method calls can be chained together.

getSpotPrice

public String getSpotPrice()

The bid price per unit hour.

Returns:

The bid price per unit hour.

setSpotPrice

public void setSpotPrice(String spotPrice)

The bid price per unit hour.

Parameters:

spotPrice - The bid price per unit hour.

withSpotPrice

public SpotFleetRequestConfigData withSpotPrice(String spotPrice)

The bid price per unit hour.

Returns a reference to this object so that method calls can be chained together.

Parameters:

spotPrice - The bid price per unit hour.

Returns:

A reference to this updated object so that method calls can be chained together.

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.

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.

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.

Returns a reference to this object so that method calls can be chained together.

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:

A reference to this updated object so that method calls can be chained together.

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.

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.

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.

Returns a reference to this object so that method calls can be chained together.

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:

A reference to this updated object so that method calls can be chained together.

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.

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.

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.

Returns a reference to this object so that method calls can be chained together.

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:

A reference to this updated 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.

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.

withTerminateInstancesWithExpiration

public SpotFleetRequestConfigData withTerminateInstancesWithExpiration(Boolean terminateInstancesWithExpiration)

Indicates whether running Spot instances should be terminated when the Spot fleet request expires.

Returns a reference to this object so that method calls can be chained together.

Parameters:

terminateInstancesWithExpiration - Indicates whether running Spot instances should be terminated when the Spot fleet request expires.

Returns:

A reference to this updated object so that method calls can be chained together.

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.

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.

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 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.

Returns a reference to this object so that method calls can be chained together.

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 set terminateInstancesWithExpiration.

Returns:

A reference to this updated object so that method calls can be chained together.

getLaunchSpecifications

public List<SpotFleetLaunchSpecification> getLaunchSpecifications()

Information about the launch specifications for the Spot fleet request.

Constraints:
Length: 1 -

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.

Constraints:
Length: 1 -

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) or withLaunchSpecifications(java.util.Collection) if you want to override the existing values.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 -

Parameters:

launchSpecifications - Information about the launch specifications for the Spot fleet request.

Returns:

A reference to this updated 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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 -

Parameters:

launchSpecifications - Information about the launch specifications for the Spot fleet request.

Returns:

A reference to this updated object so that method calls can be chained together.

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.

Constraints:
Allowed Values: noTermination, default

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

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.

Constraints:
Allowed Values: noTermination, default

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(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 a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: noTermination, default

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:

A reference to this updated 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.

Constraints:
Allowed Values: noTermination, default

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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: noTermination, default

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:

A reference to this updated object so that method calls can be chained together.

See Also:

ExcessCapacityTerminationPolicy

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.

Constraints:
Allowed Values: lowestPrice, diversified

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

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.

Constraints:
Allowed Values: lowestPrice, diversified

Parameters:

allocationStrategy - 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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: lowestPrice, diversified

Parameters:

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

Returns:

A reference to this updated 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.

Constraints:
Allowed Values: lowestPrice, diversified

Parameters:

allocationStrategy - 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(AllocationStrategy allocationStrategy)

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

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: lowestPrice, diversified

Parameters:

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

Returns:

A reference to this updated 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 class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public SpotFleetRequestConfigData clone()

Overrides:

clone in class Object