@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class RequestSpotInstancesRequest extends AmazonWebServiceRequest implements Serializable, Cloneable, DryRunSupportedRequest<RequestSpotInstancesRequest>
Contains the parameters for RequestSpotInstances.
NOOP
Constructor and Description |
---|
RequestSpotInstancesRequest()
Default constructor for RequestSpotInstancesRequest object.
|
RequestSpotInstancesRequest(String spotPrice)
Constructs a new RequestSpotInstancesRequest object.
|
Modifier and Type | Method and Description |
---|---|
RequestSpotInstancesRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
String |
getAvailabilityZoneGroup()
The user-specified name for a logical grouping of bids.
|
Integer |
getBlockDurationMinutes()
The required duration for the Spot instances (also known as Spot blocks), in minutes.
|
String |
getClientToken()
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
|
Request<RequestSpotInstancesRequest> |
getDryRunRequest()
This method is intended for internal use only.
|
Integer |
getInstanceCount()
The maximum number of Spot instances to launch.
|
String |
getInstanceInterruptionBehavior()
Indicates whether a Spot instance stops or terminates when it is interrupted.
|
String |
getLaunchGroup()
The instance launch group.
|
LaunchSpecification |
getLaunchSpecification()
The launch specification.
|
String |
getSpotPrice()
The maximum hourly price (bid) for any Spot instance launched to fulfill the request.
|
String |
getType()
The Spot instance request type.
|
Date |
getValidFrom()
The start date of the request.
|
Date |
getValidUntil()
The end date of the request.
|
int |
hashCode() |
void |
setAvailabilityZoneGroup(String availabilityZoneGroup)
The user-specified name for a logical grouping of bids.
|
void |
setBlockDurationMinutes(Integer blockDurationMinutes)
The required duration for the Spot instances (also known as Spot blocks), in minutes.
|
void |
setClientToken(String clientToken)
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
|
void |
setInstanceCount(Integer instanceCount)
The maximum number of Spot instances to launch.
|
void |
setInstanceInterruptionBehavior(InstanceInterruptionBehavior instanceInterruptionBehavior)
Indicates whether a Spot instance stops or terminates when it is interrupted.
|
void |
setInstanceInterruptionBehavior(String instanceInterruptionBehavior)
Indicates whether a Spot instance stops or terminates when it is interrupted.
|
void |
setLaunchGroup(String launchGroup)
The instance launch group.
|
void |
setLaunchSpecification(LaunchSpecification launchSpecification)
The launch specification.
|
void |
setSpotPrice(String spotPrice)
The maximum hourly price (bid) for any Spot instance launched to fulfill the request.
|
void |
setType(SpotInstanceType type)
The Spot instance request type.
|
void |
setType(String type)
The Spot instance request type.
|
void |
setValidFrom(Date validFrom)
The start date of the request.
|
void |
setValidUntil(Date validUntil)
The end date of the request.
|
String |
toString()
Returns a string representation of this object; useful for testing and debugging.
|
RequestSpotInstancesRequest |
withAvailabilityZoneGroup(String availabilityZoneGroup)
The user-specified name for a logical grouping of bids.
|
RequestSpotInstancesRequest |
withBlockDurationMinutes(Integer blockDurationMinutes)
The required duration for the Spot instances (also known as Spot blocks), in minutes.
|
RequestSpotInstancesRequest |
withClientToken(String clientToken)
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
|
RequestSpotInstancesRequest |
withInstanceCount(Integer instanceCount)
The maximum number of Spot instances to launch.
|
RequestSpotInstancesRequest |
withInstanceInterruptionBehavior(InstanceInterruptionBehavior instanceInterruptionBehavior)
Indicates whether a Spot instance stops or terminates when it is interrupted.
|
RequestSpotInstancesRequest |
withInstanceInterruptionBehavior(String instanceInterruptionBehavior)
Indicates whether a Spot instance stops or terminates when it is interrupted.
|
RequestSpotInstancesRequest |
withLaunchGroup(String launchGroup)
The instance launch group.
|
RequestSpotInstancesRequest |
withLaunchSpecification(LaunchSpecification launchSpecification)
The launch specification.
|
RequestSpotInstancesRequest |
withSpotPrice(String spotPrice)
The maximum hourly price (bid) for any Spot instance launched to fulfill the request.
|
RequestSpotInstancesRequest |
withType(SpotInstanceType type)
The Spot instance request type.
|
RequestSpotInstancesRequest |
withType(String type)
The Spot instance request type.
|
RequestSpotInstancesRequest |
withValidFrom(Date validFrom)
The start date of the request.
|
RequestSpotInstancesRequest |
withValidUntil(Date validUntil)
The end date of the request.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public RequestSpotInstancesRequest()
public RequestSpotInstancesRequest(String spotPrice)
spotPrice
- The maximum hourly price (bid) for any Spot instance launched to fulfill the request.public void setAvailabilityZoneGroup(String availabilityZoneGroup)
The user-specified name for a logical grouping of bids.
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 bids 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 bid is expired, or the bid falls below current market), 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.
availabilityZoneGroup
- The user-specified name for a logical grouping of bids.
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 bids 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 bid is expired, or the bid falls below current market), 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.
public String getAvailabilityZoneGroup()
The user-specified name for a logical grouping of bids.
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 bids 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 bid is expired, or the bid falls below current market), 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.
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 bids 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 bid is expired, or the bid falls below current market), 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.
public RequestSpotInstancesRequest withAvailabilityZoneGroup(String availabilityZoneGroup)
The user-specified name for a logical grouping of bids.
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 bids 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 bid is expired, or the bid falls below current market), 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.
availabilityZoneGroup
- The user-specified name for a logical grouping of bids.
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 bids 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 bid is expired, or the bid falls below current market), 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.
public void setBlockDurationMinutes(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.
Note that you can't specify an Availability Zone group or a launch group if you specify a duration.
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.
Note that you can't specify an Availability Zone group or a launch group if you specify a duration.
public Integer getBlockDurationMinutes()
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.
Note that you can't specify an Availability Zone group or a launch group if you specify a duration.
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.
Note that you can't specify an Availability Zone group or a launch group if you specify a duration.
public RequestSpotInstancesRequest withBlockDurationMinutes(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.
Note that you can't specify an Availability Zone group or a launch group if you specify a duration.
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.
Note that you can't specify an Availability Zone group or a launch group if you specify a duration.
public void setClientToken(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 Elastic Compute Cloud User Guide.
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 Elastic Compute Cloud User Guide.public String getClientToken()
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 Elastic Compute Cloud User Guide.
public RequestSpotInstancesRequest withClientToken(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 Elastic Compute Cloud User Guide.
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 Elastic Compute Cloud User Guide.public void setInstanceCount(Integer instanceCount)
The maximum number of Spot instances to launch.
Default: 1
instanceCount
- The maximum number of Spot instances to launch.
Default: 1
public Integer getInstanceCount()
The maximum number of Spot instances to launch.
Default: 1
Default: 1
public RequestSpotInstancesRequest withInstanceCount(Integer instanceCount)
The maximum number of Spot instances to launch.
Default: 1
instanceCount
- The maximum number of Spot instances to launch.
Default: 1
public void setLaunchGroup(String launchGroup)
The instance launch group. Launch groups are Spot instances that launch together and terminate together.
Default: Instances are launched and terminated individually
launchGroup
- The instance launch group. Launch groups are Spot instances that launch together and terminate
together.
Default: Instances are launched and terminated individually
public String getLaunchGroup()
The instance launch group. Launch groups are Spot instances that launch together and terminate together.
Default: Instances are launched and terminated individually
Default: Instances are launched and terminated individually
public RequestSpotInstancesRequest withLaunchGroup(String launchGroup)
The instance launch group. Launch groups are Spot instances that launch together and terminate together.
Default: Instances are launched and terminated individually
launchGroup
- The instance launch group. Launch groups are Spot instances that launch together and terminate
together.
Default: Instances are launched and terminated individually
public void setLaunchSpecification(LaunchSpecification launchSpecification)
The launch specification.
launchSpecification
- The launch specification.public LaunchSpecification getLaunchSpecification()
The launch specification.
public RequestSpotInstancesRequest withLaunchSpecification(LaunchSpecification launchSpecification)
The launch specification.
launchSpecification
- The launch specification.public void setSpotPrice(String spotPrice)
The maximum hourly price (bid) for any Spot instance launched to fulfill the request.
spotPrice
- The maximum hourly price (bid) for any Spot instance launched to fulfill the request.public String getSpotPrice()
The maximum hourly price (bid) for any Spot instance launched to fulfill the request.
public RequestSpotInstancesRequest withSpotPrice(String spotPrice)
The maximum hourly price (bid) for any Spot instance launched to fulfill the request.
spotPrice
- The maximum hourly price (bid) for any Spot instance launched to fulfill the request.public void setType(String type)
The Spot instance request type.
Default: one-time
type
- The Spot instance request type.
Default: one-time
SpotInstanceType
public String getType()
The Spot instance request type.
Default: one-time
Default: one-time
SpotInstanceType
public RequestSpotInstancesRequest withType(String type)
The Spot instance request type.
Default: one-time
type
- The Spot instance request type.
Default: one-time
SpotInstanceType
public void setType(SpotInstanceType type)
The Spot instance request type.
Default: one-time
type
- The Spot instance request type.
Default: one-time
SpotInstanceType
public RequestSpotInstancesRequest withType(SpotInstanceType type)
The Spot instance request type.
Default: one-time
type
- The Spot instance request type.
Default: one-time
SpotInstanceType
public void setValidFrom(Date 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.
Default: The request is effective indefinitely.
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.
Default: The request is effective indefinitely.
public Date getValidFrom()
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.
Default: The request is effective indefinitely.
Default: The request is effective indefinitely.
public RequestSpotInstancesRequest withValidFrom(Date 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.
Default: The request is effective indefinitely.
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.
Default: The request is effective indefinitely.
public void setValidUntil(Date 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 and time is reached.
Default: The request is effective indefinitely.
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 and time is reached.
Default: The request is effective indefinitely.
public Date getValidUntil()
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 and time is reached.
Default: The request is effective indefinitely.
Default: The request is effective indefinitely.
public RequestSpotInstancesRequest withValidUntil(Date 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 and time is reached.
Default: The request is effective indefinitely.
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 and time is reached.
Default: The request is effective indefinitely.
public void setInstanceInterruptionBehavior(String instanceInterruptionBehavior)
Indicates whether a Spot instance stops or terminates when it is interrupted.
instanceInterruptionBehavior
- Indicates whether a Spot instance stops or terminates when it is interrupted.InstanceInterruptionBehavior
public String getInstanceInterruptionBehavior()
Indicates whether a Spot instance stops or terminates when it is interrupted.
InstanceInterruptionBehavior
public RequestSpotInstancesRequest withInstanceInterruptionBehavior(String instanceInterruptionBehavior)
Indicates whether a Spot instance stops or terminates when it is interrupted.
instanceInterruptionBehavior
- Indicates whether a Spot instance stops or terminates when it is interrupted.InstanceInterruptionBehavior
public void setInstanceInterruptionBehavior(InstanceInterruptionBehavior instanceInterruptionBehavior)
Indicates whether a Spot instance stops or terminates when it is interrupted.
instanceInterruptionBehavior
- Indicates whether a Spot instance stops or terminates when it is interrupted.InstanceInterruptionBehavior
public RequestSpotInstancesRequest withInstanceInterruptionBehavior(InstanceInterruptionBehavior instanceInterruptionBehavior)
Indicates whether a Spot instance stops or terminates when it is interrupted.
instanceInterruptionBehavior
- Indicates whether a Spot instance stops or terminates when it is interrupted.InstanceInterruptionBehavior
public Request<RequestSpotInstancesRequest> getDryRunRequest()
getDryRunRequest
in interface DryRunSupportedRequest<RequestSpotInstancesRequest>
public String toString()
toString
in class Object
Object.toString()
public RequestSpotInstancesRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.