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	getClientToken() A unique, case-sensitive identifier you provide to ensure idempotency of your listings.
String	getIamFleetRole() Grants the Spot fleet service permission to terminate instances on your behalf when you cancel a Spot fleet request using CancelSpotFleetRequests or when the Spot fleet request expires, if you set terminateInstancesWithExpiration.
List<LaunchSpecification>	getLaunchSpecifications() Information about the launch specifications for the instances.
String	getSpotPrice() The maximum hourly price (bid) for any Spot Instance launched to fulfill the request.
Integer	getTargetCapacity() The maximum number of Spot Instances to launch.
Boolean	getTerminateInstancesWithExpiration() Indicates whether running 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 instances should be terminated when the Spot fleet request expires.
void	setClientToken(String clientToken) A unique, case-sensitive identifier you provide to ensure idempotency of your listings.
void	setIamFleetRole(String iamFleetRole) Grants the Spot fleet service permission to terminate instances on your behalf when you cancel a Spot fleet request using CancelSpotFleetRequests or when the Spot fleet request expires, if you set terminateInstancesWithExpiration.
void	setLaunchSpecifications(Collection<LaunchSpecification> launchSpecifications) Information about the launch specifications for the instances.
void	setSpotPrice(String spotPrice) The maximum hourly price (bid) for any Spot Instance launched to fulfill the request.
void	setTargetCapacity(Integer targetCapacity) The maximum number of Spot Instances to launch.
void	setTerminateInstancesWithExpiration(Boolean terminateInstancesWithExpiration) Indicates whether running 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	withClientToken(String clientToken) A unique, case-sensitive identifier you provide to ensure idempotency of your listings.
SpotFleetRequestConfigData	withIamFleetRole(String iamFleetRole) Grants the Spot fleet service permission to terminate instances on your behalf when you cancel a Spot fleet request using CancelSpotFleetRequests or when the Spot fleet request expires, if you set terminateInstancesWithExpiration.
SpotFleetRequestConfigData	withLaunchSpecifications(Collection<LaunchSpecification> launchSpecifications) Information about the launch specifications for the instances.
SpotFleetRequestConfigData	withLaunchSpecifications(LaunchSpecification... launchSpecifications) Information about the launch specifications for the instances.
SpotFleetRequestConfigData	withSpotPrice(String spotPrice) The maximum hourly price (bid) for any Spot Instance launched to fulfill the request.
SpotFleetRequestConfigData	withTargetCapacity(Integer targetCapacity) The maximum number of Spot Instances to launch.
SpotFleetRequestConfigData	withTerminateInstancesWithExpiration(Boolean terminateInstancesWithExpiration) Indicates whether running 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 maximum hourly price (bid) for any Spot Instance launched to fulfill the request.

Returns:

The maximum hourly price (bid) for any Spot Instance launched to fulfill the request.

setSpotPrice

public void setSpotPrice(String spotPrice)

The maximum hourly price (bid) for any Spot Instance launched to fulfill the request.

Parameters:

spotPrice - The maximum hourly price (bid) for any Spot Instance launched to fulfill the request.

withSpotPrice

public SpotFleetRequestConfigData withSpotPrice(String spotPrice)

The maximum hourly price (bid) for any Spot Instance launched to fulfill the request.

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

Parameters:

spotPrice - The maximum hourly price (bid) for any Spot Instance launched to fulfill the request.

Returns:

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

getTargetCapacity

public Integer getTargetCapacity()

The maximum number of Spot Instances to launch.

Returns:

The maximum number of Spot Instances to launch.

setTargetCapacity

public void setTargetCapacity(Integer targetCapacity)

The maximum number of Spot Instances to launch.

Parameters:

targetCapacity - The maximum number of Spot Instances to launch.

withTargetCapacity

public SpotFleetRequestConfigData withTargetCapacity(Integer targetCapacity)

The maximum number of Spot Instances to launch.

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

Parameters:

targetCapacity - The maximum number of Spot Instances to launch.

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 instances should be terminated when the Spot fleet request expires.

Returns:

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

setTerminateInstancesWithExpiration

public void setTerminateInstancesWithExpiration(Boolean terminateInstancesWithExpiration)

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

Parameters:

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

withTerminateInstancesWithExpiration

public SpotFleetRequestConfigData withTerminateInstancesWithExpiration(Boolean terminateInstancesWithExpiration)

Indicates whether running 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 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 instances should be terminated when the Spot fleet request expires.

Returns:

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

getIamFleetRole

public String getIamFleetRole()

Grants the Spot fleet service permission to terminate instances on your behalf when you cancel a Spot fleet request using CancelSpotFleetRequests or when the Spot fleet request expires, if you set terminateInstancesWithExpiration.

Returns:

Grants the Spot fleet service permission to terminate instances on your behalf when you cancel a 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 service permission to terminate instances on your behalf when you cancel a Spot fleet request using CancelSpotFleetRequests or when the Spot fleet request expires, if you set terminateInstancesWithExpiration.

Parameters:

iamFleetRole - Grants the Spot fleet service permission to terminate instances on your behalf when you cancel a 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 service permission to terminate instances on your behalf when you cancel a 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 service permission to terminate instances on your behalf when you cancel a 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<LaunchSpecification> getLaunchSpecifications()

Information about the launch specifications for the instances.

Constraints:
Length: 1 -

Returns:

Information about the launch specifications for the instances.

setLaunchSpecifications

public void setLaunchSpecifications(Collection<LaunchSpecification> launchSpecifications)

Information about the launch specifications for the instances.

Constraints:
Length: 1 -

Parameters:

launchSpecifications - Information about the launch specifications for the instances.

withLaunchSpecifications

public SpotFleetRequestConfigData withLaunchSpecifications(LaunchSpecification... launchSpecifications)

Information about the launch specifications for the instances.

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

Returns:

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

withLaunchSpecifications

public SpotFleetRequestConfigData withLaunchSpecifications(Collection<LaunchSpecification> launchSpecifications)

Information about the launch specifications for the instances.

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

Returns:

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

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