Class SpotMarketOptions
- java.lang.Object
-
- software.amazon.awssdk.services.ec2.model.SpotMarketOptions
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<SpotMarketOptions.Builder,SpotMarketOptions>
@Generated("software.amazon.awssdk:codegen") public final class SpotMarketOptions extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SpotMarketOptions.Builder,SpotMarketOptions>
The options for Spot Instances.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
SpotMarketOptions.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Integer
blockDurationMinutes()
Deprecated.static SpotMarketOptions.Builder
builder()
boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
InstanceInterruptionBehavior
instanceInterruptionBehavior()
The behavior when a Spot Instance is interrupted.String
instanceInterruptionBehaviorAsString()
The behavior when a Spot Instance is interrupted.String
maxPrice()
The maximum hourly price that you're willing to pay for a Spot Instance.List<SdkField<?>>
sdkFields()
static Class<? extends SpotMarketOptions.Builder>
serializableBuilderClass()
SpotInstanceType
spotInstanceType()
The Spot Instance request type.String
spotInstanceTypeAsString()
The Spot Instance request type.SpotMarketOptions.Builder
toBuilder()
String
toString()
Returns a string representation of this object.Instant
validUntil()
The end date of the request, in UTC format (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
-
maxPrice
public final String maxPrice()
The maximum hourly price that you're willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
If you specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter.
- Returns:
- The maximum hourly price that you're willing to pay for a Spot Instance. We do not recommend using this
parameter because it can lead to increased interruptions. If you do not specify this parameter, you will
pay the current Spot price.
If you specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter.
-
spotInstanceType
public final SpotInstanceType spotInstanceType()
The Spot Instance request type. For RunInstances, persistent Spot Instance requests are only supported when the instance interruption behavior is either
hibernate
orstop
.If the service returns an enum value that is not available in the current SDK version,
spotInstanceType
will returnSpotInstanceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromspotInstanceTypeAsString()
.- Returns:
- The Spot Instance request type. For RunInstances,
persistent Spot Instance requests are only supported when the instance interruption behavior is either
hibernate
orstop
. - See Also:
SpotInstanceType
-
spotInstanceTypeAsString
public final String spotInstanceTypeAsString()
The Spot Instance request type. For RunInstances, persistent Spot Instance requests are only supported when the instance interruption behavior is either
hibernate
orstop
.If the service returns an enum value that is not available in the current SDK version,
spotInstanceType
will returnSpotInstanceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromspotInstanceTypeAsString()
.- Returns:
- The Spot Instance request type. For RunInstances,
persistent Spot Instance requests are only supported when the instance interruption behavior is either
hibernate
orstop
. - See Also:
SpotInstanceType
-
blockDurationMinutes
public final Integer blockDurationMinutes()
Deprecated.
- Returns:
- Deprecated.
-
validUntil
public final Instant validUntil()
The end date of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ). Supported only for persistent requests.
-
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,
ValidUntil
is not supported. The request remains active until all instances launch or you cancel the request.
- Returns:
- The end date of the request, in UTC format
(YYYY-MM-DDTHH:MM:SSZ). Supported only for persistent
requests.
-
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,
ValidUntil
is not supported. The request remains active until all instances launch or you cancel the request.
-
-
-
instanceInterruptionBehavior
public final InstanceInterruptionBehavior instanceInterruptionBehavior()
The behavior when a Spot Instance is interrupted.
If
Configured
(forHibernationOptions
) is set totrue
, theInstanceInterruptionBehavior
parameter is automatically set tohibernate
. If you set it tostop
orterminate
, you'll get an error.If
Configured
(forHibernationOptions
) is set tofalse
ornull
, theInstanceInterruptionBehavior
parameter is automatically set toterminate
. You can also set it tostop
orhibernate
.For more information, see Interruption behavior in the Amazon EC2 User Guide.
If the service returns an enum value that is not available in the current SDK version,
instanceInterruptionBehavior
will returnInstanceInterruptionBehavior.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceInterruptionBehaviorAsString()
.- Returns:
- The behavior when a Spot Instance is interrupted.
If
Configured
(forHibernationOptions
) is set totrue
, theInstanceInterruptionBehavior
parameter is automatically set tohibernate
. If you set it tostop
orterminate
, you'll get an error.If
Configured
(forHibernationOptions
) is set tofalse
ornull
, theInstanceInterruptionBehavior
parameter is automatically set toterminate
. You can also set it tostop
orhibernate
.For more information, see Interruption behavior in the Amazon EC2 User Guide.
- See Also:
InstanceInterruptionBehavior
-
instanceInterruptionBehaviorAsString
public final String instanceInterruptionBehaviorAsString()
The behavior when a Spot Instance is interrupted.
If
Configured
(forHibernationOptions
) is set totrue
, theInstanceInterruptionBehavior
parameter is automatically set tohibernate
. If you set it tostop
orterminate
, you'll get an error.If
Configured
(forHibernationOptions
) is set tofalse
ornull
, theInstanceInterruptionBehavior
parameter is automatically set toterminate
. You can also set it tostop
orhibernate
.For more information, see Interruption behavior in the Amazon EC2 User Guide.
If the service returns an enum value that is not available in the current SDK version,
instanceInterruptionBehavior
will returnInstanceInterruptionBehavior.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceInterruptionBehaviorAsString()
.- Returns:
- The behavior when a Spot Instance is interrupted.
If
Configured
(forHibernationOptions
) is set totrue
, theInstanceInterruptionBehavior
parameter is automatically set tohibernate
. If you set it tostop
orterminate
, you'll get an error.If
Configured
(forHibernationOptions
) is set tofalse
ornull
, theInstanceInterruptionBehavior
parameter is automatically set toterminate
. You can also set it tostop
orhibernate
.For more information, see Interruption behavior in the Amazon EC2 User Guide.
- See Also:
InstanceInterruptionBehavior
-
toBuilder
public SpotMarketOptions.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<SpotMarketOptions.Builder,SpotMarketOptions>
-
builder
public static SpotMarketOptions.Builder builder()
-
serializableBuilderClass
public static Class<? extends SpotMarketOptions.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-