software.amazon.awssdk.services.ec2.model

Class RequestSpotInstancesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ec2.model.Ec2Request

software.amazon.awssdk.services.ec2.model.RequestSpotInstancesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<RequestSpotInstancesRequest.Builder,RequestSpotInstancesRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class RequestSpotInstancesRequest
extends Ec2Request
implements ToCopyableBuilder<RequestSpotInstancesRequest.Builder,RequestSpotInstancesRequest>

Contains the parameters for RequestSpotInstances.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RequestSpotInstancesRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	availabilityZoneGroup() The user-specified name for a logical grouping of requests.
Integer	blockDurationMinutes() Deprecated.
static RequestSpotInstancesRequest.Builder	builder()
String	clientToken() Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTagSpecifications() For responses, this returns true if the service returned a value for the TagSpecifications property.
Integer	instanceCount() The maximum number of Spot Instances to launch.
InstanceInterruptionBehavior	instanceInterruptionBehavior() The behavior when a Spot Instance is interrupted.
String	instanceInterruptionBehaviorAsString() The behavior when a Spot Instance is interrupted.
String	launchGroup() The instance launch group.
RequestSpotLaunchSpecification	launchSpecification() The launch specification.
List<SdkField<?>>	sdkFields()
static Class<? extends RequestSpotInstancesRequest.Builder>	serializableBuilderClass()
String	spotPrice() The maximum price per hour that you are willing to pay for a Spot Instance.
List<TagSpecification>	tagSpecifications() The key-value pair for tagging the Spot Instance request on creation.
RequestSpotInstancesRequest.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.
Instant	validUntil() The end date of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ).

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

availabilityZoneGroup

public final String availabilityZoneGroup()

The user-specified name for a logical grouping of requests.

When you specify an Availability Zone group in a Spot Instance request, all Spot Instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to requests for Spot Instances of the same instance type. Any additional Spot Instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active.

If there is no active instance running in the Availability Zone group that you specify for a new Spot Instance request (all instances are terminated, the request is expired, or the maximum price you specified falls below current Spot price), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot Instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group.

Default: Instances are launched in any available Availability Zone.

Returns:

The user-specified name for a logical grouping of requests.

When you specify an Availability Zone group in a Spot Instance request, all Spot Instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to requests for Spot Instances of the same instance type. Any additional Spot Instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active.

If there is no active instance running in the Availability Zone group that you specify for a new Spot Instance request (all instances are terminated, the request is expired, or the maximum price you specified falls below current Spot price), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot Instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group.

Default: Instances are launched in any available Availability Zone.

blockDurationMinutes

public final Integer blockDurationMinutes()

Deprecated.

Returns:

Deprecated.

clientToken

public final String clientToken()

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon EC2 User Guide for Linux Instances.

Returns:

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon EC2 User Guide for Linux Instances.

instanceCount

public final Integer instanceCount()

The maximum number of Spot Instances to launch.

Default: 1

Returns:

The maximum number of Spot Instances to launch.

Default: 1

launchGroup

public final String launchGroup()

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

Default: Instances are launched and terminated individually

Returns:

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

Default: Instances are launched and terminated individually

launchSpecification

public final RequestSpotLaunchSpecification launchSpecification()

The launch specification.

Returns:

The launch specification.

spotPrice

public final String spotPrice()

The maximum price per hour that you are willing to pay for a Spot Instance. The default is the On-Demand price.

Returns:

The maximum price per hour that you are willing to pay for a Spot Instance. The default is the On-Demand price.

type

public final SpotInstanceType type()

The Spot Instance request type.

Default: one-time

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.

Default: one-time

See Also:

SpotInstanceType

typeAsString

public final String typeAsString()

The Spot Instance request type.

Default: one-time

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.

Default: one-time

See Also:

SpotInstanceType

validFrom

public final Instant validFrom()

The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.

The specified start date and time cannot be equal to the current date and time. You must specify a start date and time that occurs after the current date and time.

Returns:

The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.

The specified start date and time cannot be equal to the current date and time. You must specify a start date and time that occurs after the current date and time.

validUntil

public final Instant validUntil()

The end date of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ).

• For a persistent request, the request remains active until the ValidUntil date and time is reached. Otherwise, the request remains active until you cancel it.

• For a one-time request, the request remains active until all instances launch, the request is canceled, or the ValidUntil date and time is reached. By default, the request is valid for 7 days from the date the request was created.

Returns:

The end date of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ).

• For a persistent request, the request remains active until the ValidUntil date and time is reached. Otherwise, the request remains active until you cancel it.

• For a one-time request, the request remains active until all instances launch, the request is canceled, or the ValidUntil date and time is reached. By default, the request is valid for 7 days from the date the request was created.

hasTagSpecifications

public final boolean hasTagSpecifications()

For responses, this returns true if the service returned a value for the TagSpecifications property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tagSpecifications

public final List<TagSpecification> tagSpecifications()

The key-value pair for tagging the Spot Instance request on creation. The value for ResourceType must be spot-instances-request, otherwise the Spot Instance request fails. To tag the Spot Instance request after it has been created, see CreateTags.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTagSpecifications() method.

Returns:

The key-value pair for tagging the Spot Instance request on creation. The value for ResourceType must be spot-instances-request, otherwise the Spot Instance request fails. To tag the Spot Instance request after it has been created, see CreateTags.

instanceInterruptionBehavior

public final InstanceInterruptionBehavior instanceInterruptionBehavior()

The behavior when a Spot Instance is interrupted. The default is terminate.

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. The default is terminate.

See Also:

InstanceInterruptionBehavior

instanceInterruptionBehaviorAsString

public final String instanceInterruptionBehaviorAsString()

The behavior when a Spot Instance is interrupted. The default is terminate.

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. The default is terminate.

See Also:

InstanceInterruptionBehavior

toBuilder

public RequestSpotInstancesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RequestSpotInstancesRequest.Builder,RequestSpotInstancesRequest>

Specified by:

toBuilder in class Ec2Request

builder

public static RequestSpotInstancesRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo