software.amazon.awssdk.services.ec2.model

Class SpotInstanceRequest

java.lang.Object

software.amazon.awssdk.services.ec2.model.SpotInstanceRequest

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SpotInstanceRequest.Builder,SpotInstanceRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class SpotInstanceRequest
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SpotInstanceRequest.Builder,SpotInstanceRequest>

Describes a Spot Instance request.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SpotInstanceRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	actualBlockHourlyPrice() If you specified a duration and your Spot Instance request was fulfilled, this is the fixed hourly price in effect for the Spot Instance while it runs.
String	availabilityZoneGroup() The Availability Zone group.
Integer	blockDurationMinutes() The duration for the Spot Instance, in minutes.
static SpotInstanceRequest.Builder	builder()
Instant	createTime() The date and time when the Spot Instance request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
SpotInstanceStateFault	fault() The fault codes for the Spot Instance request, if any.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	instanceId() The instance ID, if an instance has been launched to fulfill the Spot Instance request.
InstanceInterruptionBehavior	instanceInterruptionBehavior() The behavior when a Spot Instance is interrupted.
String	instanceInterruptionBehaviorAsString() The behavior when a Spot Instance is interrupted.
String	launchedAvailabilityZone() The Availability Zone in which the request is launched.
String	launchGroup() The instance launch group.
LaunchSpecification	launchSpecification() Additional information for launching instances.
RIProductDescription	productDescription() The product description associated with the Spot Instance.
String	productDescriptionAsString() The product description associated with the Spot Instance.
List<SdkField<?>>	sdkFields()
static Class<? extends SpotInstanceRequest.Builder>	serializableBuilderClass()
String	spotInstanceRequestId() The ID of the Spot Instance request.
String	spotPrice() The maximum price per hour that you are willing to pay for a Spot Instance.
SpotInstanceState	state() The state of the Spot Instance request.
String	stateAsString() The state of the Spot Instance request.
SpotInstanceStatus	status() The status code and status message describing the Spot Instance request.
List<Tag>	tags() Any tags assigned to the resource.
SpotInstanceRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
SpotInstanceType	type() The Spot Instance request type.
String	typeAsString() The Spot Instance request type.
Instant	validFrom() The start date of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
Instant	validUntil() The end date of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

actualBlockHourlyPrice

public String actualBlockHourlyPrice()

If you specified a duration and your Spot Instance request was fulfilled, this is the fixed hourly price in effect for the Spot Instance while it runs.

Returns:

If you specified a duration and your Spot Instance request was fulfilled, this is the fixed hourly price in effect for the Spot Instance while it runs.

availabilityZoneGroup

public String availabilityZoneGroup()

The Availability Zone group. If you specify the same Availability Zone group for all Spot Instance requests, all Spot Instances are launched in the same Availability Zone.

Returns:

The Availability Zone group. If you specify the same Availability Zone group for all Spot Instance requests, all Spot Instances are launched in the same Availability Zone.

blockDurationMinutes

public Integer blockDurationMinutes()

The duration for the Spot Instance, in minutes.

Returns:

The duration for the Spot Instance, in minutes.

createTime

public Instant createTime()

The date and time when the Spot Instance request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

Returns:

The date and time when the Spot Instance request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

fault

public SpotInstanceStateFault fault()

The fault codes for the Spot Instance request, if any.

Returns:

The fault codes for the Spot Instance request, if any.

instanceId

public String instanceId()

The instance ID, if an instance has been launched to fulfill the Spot Instance request.

Returns:

The instance ID, if an instance has been launched to fulfill the Spot Instance request.

launchGroup

public String launchGroup()

The instance launch group. Launch groups are Spot Instances that launch together and terminate together.

Returns:

The instance launch group. Launch groups are Spot Instances that launch together and terminate together.

launchSpecification

public LaunchSpecification launchSpecification()

Additional information for launching instances.

Returns:

Additional information for launching instances.

launchedAvailabilityZone

public String launchedAvailabilityZone()

The Availability Zone in which the request is launched.

Returns:

The Availability Zone in which the request is launched.

productDescription

public RIProductDescription productDescription()

The product description associated with the Spot Instance.

If the service returns an enum value that is not available in the current SDK version, productDescription will return RIProductDescription.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from productDescriptionAsString().

Returns:

The product description associated with the Spot Instance.

See Also:

RIProductDescription

productDescriptionAsString

public String productDescriptionAsString()

The product description associated with the Spot Instance.

If the service returns an enum value that is not available in the current SDK version, productDescription will return RIProductDescription.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from productDescriptionAsString().

Returns:

The product description associated with the Spot Instance.

See Also:

RIProductDescription

spotInstanceRequestId

public String spotInstanceRequestId()

The ID of the Spot Instance request.

Returns:

The ID of the Spot Instance request.

spotPrice

public String spotPrice()

The maximum price per hour that you are willing to pay for a Spot Instance.

Returns:

The maximum price per hour that you are willing to pay for a Spot Instance.

state

public SpotInstanceState state()

The state of the Spot Instance request. Spot status information helps track your Spot Instance requests. For more information, see Spot Status in the Amazon EC2 User Guide for Linux Instances.

If the service returns an enum value that is not available in the current SDK version, state will return SpotInstanceState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

Returns:

The state of the Spot Instance request. Spot status information helps track your Spot Instance requests. For more information, see Spot Status in the Amazon EC2 User Guide for Linux Instances.

See Also:

SpotInstanceState

stateAsString

public String stateAsString()

The state of the Spot Instance request. Spot status information helps track your Spot Instance requests. For more information, see Spot Status in the Amazon EC2 User Guide for Linux Instances.

If the service returns an enum value that is not available in the current SDK version, state will return SpotInstanceState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

Returns:

The state of the Spot Instance request. Spot status information helps track your Spot Instance requests. For more information, see Spot Status in the Amazon EC2 User Guide for Linux Instances.

See Also:

SpotInstanceState

status

public SpotInstanceStatus status()

The status code and status message describing the Spot Instance request.

Returns:

The status code and status message describing the Spot Instance request.

tags

public List<Tag> tags()

Any tags assigned to the resource.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

Any tags assigned to the resource.

type

public SpotInstanceType type()

The Spot Instance request type.

If the service returns an enum value that is not available in the current SDK version, type will return SpotInstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The Spot Instance request type.

See Also:

SpotInstanceType

typeAsString

public String typeAsString()

The Spot Instance request type.

If the service returns an enum value that is not available in the current SDK version, type will return SpotInstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The Spot Instance request type.

See Also:

SpotInstanceType

validFrom

public Instant validFrom()

The start date of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The request becomes active at this date and time.

Returns:

The start date of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The request becomes active at this date and time.

validUntil

public Instant validUntil()

The end date of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). If this is a one-time request, it remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date is reached. The default end date is 7 days from the current date.

Returns:

The end date of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). If this is a one-time request, it remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date is reached. The default end date is 7 days from the current date.

instanceInterruptionBehavior

public InstanceInterruptionBehavior instanceInterruptionBehavior()

The behavior when a Spot Instance 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 instanceInterruptionBehaviorAsString().

Returns:

The behavior when a Spot Instance is interrupted.

See Also:

InstanceInterruptionBehavior

instanceInterruptionBehaviorAsString

public String instanceInterruptionBehaviorAsString()

The behavior when a Spot Instance 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 instanceInterruptionBehaviorAsString().

Returns:

The behavior when a Spot Instance is interrupted.

See Also:

InstanceInterruptionBehavior

toBuilder

public SpotInstanceRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SpotInstanceRequest.Builder,SpotInstanceRequest>

builder

public static SpotInstanceRequest.Builder builder()

serializableBuilderClass

public static Class<? extends SpotInstanceRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo