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() The required duration for the Spot Instances (also known as Spot blocks), in minutes.
static RequestSpotInstancesRequest.Builder	builder()
String	clientToken() Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
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.
RequestSpotInstancesRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
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.

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

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

availabilityZoneGroup

public 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 Integer blockDurationMinutes()

The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).

The duration period starts as soon as your Spot Instance receives its instance ID. At the end of the duration period, Amazon EC2 marks the Spot Instance for termination and provides a Spot Instance termination notice, which gives the instance a two-minute warning before it terminates.

You can't specify an Availability Zone group or a launch group if you specify a duration.

Returns:

The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).

The duration period starts as soon as your Spot Instance receives its instance ID. At the end of the duration period, Amazon EC2 marks the Spot Instance for termination and provides a Spot Instance termination notice, which gives the instance a two-minute warning before it terminates.

You can't specify an Availability Zone group or a launch group if you specify a duration.

clientToken

public 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 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 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 RequestSpotLaunchSpecification launchSpecification()

The launch specification.

Returns:

The launch specification.

spotPrice

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

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.

validUntil

public Instant validUntil()

The end date of the request. If this is a one-time request, the request 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. If this is a one-time request, the request 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. 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 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()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<RequestSpotInstancesRequest.Builder,RequestSpotInstancesRequest>

Specified by:

toBuilder in class Ec2Request

Returns:

a builder for type T

builder

public static RequestSpotInstancesRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.