public class RequestSpotInstancesRequest extends AmazonWebServiceRequest implements java.io.Serializable, DryRunSupportedRequest<RequestSpotInstancesRequest>
RequestSpotInstances operation
.
Creates a Spot instance request. Spot instances are instances that Amazon EC2 launches when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically sets the Spot price based on available Spot Instance capacity and current Spot instance requests. For more information, see Spot Instance Requests in the Amazon Elastic Compute Cloud User Guide .
Constructor and Description |
---|
RequestSpotInstancesRequest()
Default constructor for a new RequestSpotInstancesRequest object.
|
RequestSpotInstancesRequest(java.lang.String spotPrice)
Constructs a new RequestSpotInstancesRequest object.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getAvailabilityZoneGroup()
The user-specified name for a logical grouping of bids.
|
java.lang.Integer |
getBlockDurationMinutes()
The required duration for the Spot instances (also known as Spot
blocks), in minutes.
|
java.lang.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.
|
java.lang.Integer |
getInstanceCount()
The maximum number of Spot instances to launch.
|
java.lang.String |
getLaunchGroup()
The instance launch group.
|
LaunchSpecification |
getLaunchSpecification()
The launch specification.
|
java.lang.String |
getSpotPrice()
The maximum hourly price (bid) for any Spot instance launched to
fulfill the request.
|
java.lang.String |
getType()
The Spot instance request type.
|
java.util.Date |
getValidFrom()
The start date of the request.
|
java.util.Date |
getValidUntil()
The end date of the request.
|
int |
hashCode() |
void |
setAvailabilityZoneGroup(java.lang.String availabilityZoneGroup)
The user-specified name for a logical grouping of bids.
|
void |
setBlockDurationMinutes(java.lang.Integer blockDurationMinutes)
The required duration for the Spot instances (also known as Spot
blocks), in minutes.
|
void |
setClientToken(java.lang.String clientToken)
Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
|
void |
setInstanceCount(java.lang.Integer instanceCount)
The maximum number of Spot instances to launch.
|
void |
setLaunchGroup(java.lang.String launchGroup)
The instance launch group.
|
void |
setLaunchSpecification(LaunchSpecification launchSpecification)
The launch specification.
|
void |
setSpotPrice(java.lang.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(java.lang.String type)
The Spot instance request type.
|
void |
setValidFrom(java.util.Date validFrom)
The start date of the request.
|
void |
setValidUntil(java.util.Date validUntil)
The end date of the request.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
RequestSpotInstancesRequest |
withAvailabilityZoneGroup(java.lang.String availabilityZoneGroup)
The user-specified name for a logical grouping of bids.
|
RequestSpotInstancesRequest |
withBlockDurationMinutes(java.lang.Integer blockDurationMinutes)
The required duration for the Spot instances (also known as Spot
blocks), in minutes.
|
RequestSpotInstancesRequest |
withClientToken(java.lang.String clientToken)
Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
|
RequestSpotInstancesRequest |
withInstanceCount(java.lang.Integer instanceCount)
The maximum number of Spot instances to launch.
|
RequestSpotInstancesRequest |
withLaunchGroup(java.lang.String launchGroup)
The instance launch group.
|
RequestSpotInstancesRequest |
withLaunchSpecification(LaunchSpecification launchSpecification)
The launch specification.
|
RequestSpotInstancesRequest |
withSpotPrice(java.lang.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(java.lang.String type)
The Spot instance request type.
|
RequestSpotInstancesRequest |
withValidFrom(java.util.Date validFrom)
The start date of the request.
|
RequestSpotInstancesRequest |
withValidUntil(java.util.Date validUntil)
The end date of the request.
|
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public RequestSpotInstancesRequest()
public RequestSpotInstancesRequest(java.lang.String spotPrice)
spotPrice
- The maximum hourly price (bid) for any Spot instance
launched to fulfill the request.public java.lang.String getSpotPrice()
public void setSpotPrice(java.lang.String spotPrice)
spotPrice
- The maximum hourly price (bid) for any Spot instance launched to
fulfill the request.public RequestSpotInstancesRequest withSpotPrice(java.lang.String spotPrice)
Returns a reference to this object so that method calls can be chained together.
spotPrice
- The maximum hourly price (bid) for any Spot instance launched to
fulfill the request.public java.lang.String getClientToken()
public void setClientToken(java.lang.String clientToken)
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 RequestSpotInstancesRequest withClientToken(java.lang.String clientToken)
Returns a reference to this object so that method calls can be chained together.
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 java.lang.Integer getInstanceCount()
Default: 1
Default: 1
public void setInstanceCount(java.lang.Integer instanceCount)
Default: 1
instanceCount
- The maximum number of Spot instances to launch. Default: 1
public RequestSpotInstancesRequest withInstanceCount(java.lang.Integer instanceCount)
Default: 1
Returns a reference to this object so that method calls can be chained together.
instanceCount
- The maximum number of Spot instances to launch. Default: 1
public java.lang.String getType()
Default: one-time
Constraints:
Allowed Values: one-time, persistent
Default: one-time
SpotInstanceType
public void setType(java.lang.String type)
Default: one-time
Constraints:
Allowed Values: one-time, persistent
type
- The Spot instance request type. Default: one-time
SpotInstanceType
public RequestSpotInstancesRequest withType(java.lang.String type)
Default: one-time
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: one-time, persistent
type
- The Spot instance request type. Default: one-time
SpotInstanceType
public void setType(SpotInstanceType type)
Default: one-time
Constraints:
Allowed Values: one-time, persistent
type
- The Spot instance request type. Default: one-time
SpotInstanceType
public RequestSpotInstancesRequest withType(SpotInstanceType type)
Default: one-time
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: one-time, persistent
type
- The Spot instance request type. Default: one-time
SpotInstanceType
public java.util.Date getValidFrom()
Default: The request is effective indefinitely.
Default: The request is effective indefinitely.
public void setValidFrom(java.util.Date validFrom)
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 RequestSpotInstancesRequest withValidFrom(java.util.Date validFrom)
Default: The request is effective indefinitely.
Returns a reference to this object so that method calls can be chained together.
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 java.util.Date getValidUntil()
Default: The request is effective indefinitely.
Default: The request is effective indefinitely.
public void setValidUntil(java.util.Date validUntil)
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 RequestSpotInstancesRequest withValidUntil(java.util.Date validUntil)
Default: The request is effective indefinitely.
Returns a reference to this object so that method calls can be chained together.
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 java.lang.String getLaunchGroup()
Default: Instances are launched and terminated individually
Default: Instances are launched and terminated individually
public void setLaunchGroup(java.lang.String launchGroup)
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 RequestSpotInstancesRequest withLaunchGroup(java.lang.String launchGroup)
Default: Instances are launched and terminated individually
Returns a reference to this object so that method calls can be chained together.
launchGroup
- The instance launch group. Launch groups are Spot instances that
launch together and terminate together. Default: Instances are launched and terminated individually
public java.lang.String getAvailabilityZoneGroup()
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 void setAvailabilityZoneGroup(java.lang.String availabilityZoneGroup)
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 RequestSpotInstancesRequest withAvailabilityZoneGroup(java.lang.String availabilityZoneGroup)
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.
Returns a reference to this object so that method calls can be chained together.
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 java.lang.Integer getBlockDurationMinutes()
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 void setBlockDurationMinutes(java.lang.Integer blockDurationMinutes)
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 RequestSpotInstancesRequest withBlockDurationMinutes(java.lang.Integer blockDurationMinutes)
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.
Returns a reference to this object so that method calls can be chained together.
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 LaunchSpecification getLaunchSpecification()
public void setLaunchSpecification(LaunchSpecification launchSpecification)
launchSpecification
- The launch specification.public RequestSpotInstancesRequest withLaunchSpecification(LaunchSpecification launchSpecification)
Returns a reference to this object so that method calls can be chained together.
launchSpecification
- The launch specification.public Request<RequestSpotInstancesRequest> getDryRunRequest()
getDryRunRequest
in interface DryRunSupportedRequest<RequestSpotInstancesRequest>
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
Copyright © 2018 Amazon Web Services, Inc. All Rights Reserved.