com.amazonaws.services.ec2.model.RequestSpotInstancesRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
* Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.ec2.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
import com.amazonaws.Request;
import com.amazonaws.services.ec2.model.transform.RequestSpotInstancesRequestMarshaller;
/**
*
* Contains the parameters for RequestSpotInstances.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class RequestSpotInstancesRequest extends AmazonWebServiceRequest implements Serializable, Cloneable,
DryRunSupportedRequest {
/**
*
* 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.
*
*/
private String availabilityZoneGroup;
/**
*
* Deprecated.
*
*/
private Integer blockDurationMinutes;
/**
*
* 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.
*
*/
private String clientToken;
/**
*
* The maximum number of Spot Instances to launch.
*
*
* Default: 1
*
*/
private Integer instanceCount;
/**
*
* The instance launch group. Launch groups are Spot Instances that launch together and terminate together.
*
*
* Default: Instances are launched and terminated individually
*
*/
private String launchGroup;
/**
*
* The launch specification.
*
*/
private LaunchSpecification launchSpecification;
/**
*
* The maximum price per unit hour that you are 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 instances will be interrupted more frequently than if you do not specify
* this parameter.
*
*
*/
private String spotPrice;
/**
*
* The Spot Instance request type.
*
*
* Default: one-time
*
*/
private String type;
/**
*
* 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.
*
*/
private java.util.Date validFrom;
/**
*
* 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.
*
*
*
*/
private java.util.Date validUntil;
/**
*
* 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.
*
*/
private com.amazonaws.internal.SdkInternalList tagSpecifications;
/**
*
* The behavior when a Spot Instance is interrupted. The default is terminate.
*
*/
private String instanceInterruptionBehavior;
/**
* Default constructor for RequestSpotInstancesRequest object. Callers should use the setter or fluent setter
* (with...) methods to initialize the object after creating it.
*/
public RequestSpotInstancesRequest() {
}
/**
* Constructs a new RequestSpotInstancesRequest object. Callers should use the setter or fluent setter (with...)
* methods to initialize any additional object members.
*
* @param spotPrice
* The maximum price per unit hour that you are 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 instances will be interrupted more frequently than if you do not
* specify this parameter.
*
*/
public RequestSpotInstancesRequest(String spotPrice) {
setSpotPrice(spotPrice);
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setAvailabilityZoneGroup(String availabilityZoneGroup) {
this.availabilityZoneGroup = 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.
*
*
* @return 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.
*/
public String getAvailabilityZoneGroup() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RequestSpotInstancesRequest withAvailabilityZoneGroup(String availabilityZoneGroup) {
setAvailabilityZoneGroup(availabilityZoneGroup);
return this;
}
/**
*
* Deprecated.
*
*
* @param blockDurationMinutes
* Deprecated.
*/
public void setBlockDurationMinutes(Integer blockDurationMinutes) {
this.blockDurationMinutes = blockDurationMinutes;
}
/**
*
* Deprecated.
*
*
* @return Deprecated.
*/
public Integer getBlockDurationMinutes() {
return this.blockDurationMinutes;
}
/**
*
* Deprecated.
*
*
* @param blockDurationMinutes
* Deprecated.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RequestSpotInstancesRequest withBlockDurationMinutes(Integer blockDurationMinutes) {
setBlockDurationMinutes(blockDurationMinutes);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setClientToken(String clientToken) {
this.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 EC2 User Guide for Linux Instances.
*
*
* @return 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.
*/
public String getClientToken() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RequestSpotInstancesRequest withClientToken(String clientToken) {
setClientToken(clientToken);
return this;
}
/**
*
* The maximum number of Spot Instances to launch.
*
*
* Default: 1
*
*
* @param instanceCount
* The maximum number of Spot Instances to launch.
*
* Default: 1
*/
public void setInstanceCount(Integer instanceCount) {
this.instanceCount = instanceCount;
}
/**
*
* The maximum number of Spot Instances to launch.
*
*
* Default: 1
*
*
* @return The maximum number of Spot Instances to launch.
*
* Default: 1
*/
public Integer getInstanceCount() {
return this.instanceCount;
}
/**
*
* The maximum number of Spot Instances to launch.
*
*
* Default: 1
*
*
* @param instanceCount
* The maximum number of Spot Instances to launch.
*
* Default: 1
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RequestSpotInstancesRequest withInstanceCount(Integer instanceCount) {
setInstanceCount(instanceCount);
return this;
}
/**
*
* The instance launch group. Launch groups are Spot Instances that launch together and terminate together.
*
*
* Default: Instances are launched and terminated individually
*
*
* @param 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 setLaunchGroup(String launchGroup) {
this.launchGroup = launchGroup;
}
/**
*
* The instance launch group. Launch groups are Spot Instances that launch together and terminate together.
*
*
* Default: Instances are launched and terminated individually
*
*
* @return 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() {
return this.launchGroup;
}
/**
*
* The instance launch group. Launch groups are Spot Instances that launch together and terminate together.
*
*
* Default: Instances are launched and terminated individually
*
*
* @param launchGroup
* The instance launch group. Launch groups are Spot Instances that launch together and terminate
* together.
*
* Default: Instances are launched and terminated individually
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RequestSpotInstancesRequest withLaunchGroup(String launchGroup) {
setLaunchGroup(launchGroup);
return this;
}
/**
*
* The launch specification.
*
*
* @param launchSpecification
* The launch specification.
*/
public void setLaunchSpecification(LaunchSpecification launchSpecification) {
this.launchSpecification = launchSpecification;
}
/**
*
* The launch specification.
*
*
* @return The launch specification.
*/
public LaunchSpecification getLaunchSpecification() {
return this.launchSpecification;
}
/**
*
* The launch specification.
*
*
* @param launchSpecification
* The launch specification.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RequestSpotInstancesRequest withLaunchSpecification(LaunchSpecification launchSpecification) {
setLaunchSpecification(launchSpecification);
return this;
}
/**
*
* The maximum price per unit hour that you are 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 instances will be interrupted more frequently than if you do not specify
* this parameter.
*
*
*
* @param spotPrice
* The maximum price per unit hour that you are 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 instances will be interrupted more frequently than if you do not
* specify this parameter.
*
*/
public void setSpotPrice(String spotPrice) {
this.spotPrice = spotPrice;
}
/**
*
* The maximum price per unit hour that you are 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 instances will be interrupted more frequently than if you do not specify
* this parameter.
*
*
*
* @return The maximum price per unit hour that you are 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 instances will be interrupted more frequently than if you do not
* specify this parameter.
*
*/
public String getSpotPrice() {
return this.spotPrice;
}
/**
*
* The maximum price per unit hour that you are 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 instances will be interrupted more frequently than if you do not specify
* this parameter.
*
*
*
* @param spotPrice
* The maximum price per unit hour that you are 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 instances will be interrupted more frequently than if you do not
* specify this parameter.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RequestSpotInstancesRequest withSpotPrice(String spotPrice) {
setSpotPrice(spotPrice);
return this;
}
/**
*
* The Spot Instance request type.
*
*
* Default: one-time
*
*
* @param type
* The Spot Instance request type.
*
* Default: one-time
* @see SpotInstanceType
*/
public void setType(String type) {
this.type = type;
}
/**
*
* The Spot Instance request type.
*
*
* Default: one-time
*
*
* @return The Spot Instance request type.
*
* Default: one-time
* @see SpotInstanceType
*/
public String getType() {
return this.type;
}
/**
*
* The Spot Instance request type.
*
*
* Default: one-time
*
*
* @param type
* The Spot Instance request type.
*
* Default: one-time
* @return Returns a reference to this object so that method calls can be chained together.
* @see SpotInstanceType
*/
public RequestSpotInstancesRequest withType(String type) {
setType(type);
return this;
}
/**
*
* The Spot Instance request type.
*
*
* Default: one-time
*
*
* @param type
* The Spot Instance request type.
*
* Default: one-time
* @see SpotInstanceType
*/
public void setType(SpotInstanceType type) {
withType(type);
}
/**
*
* The Spot Instance request type.
*
*
* Default: one-time
*
*
* @param type
* The Spot Instance request type.
*
* Default: one-time
* @return Returns a reference to this object so that method calls can be chained together.
* @see SpotInstanceType
*/
public RequestSpotInstancesRequest withType(SpotInstanceType type) {
this.type = type.toString();
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setValidFrom(java.util.Date validFrom) {
this.validFrom = 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.
*
*
* @return 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.
*/
public java.util.Date getValidFrom() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RequestSpotInstancesRequest withValidFrom(java.util.Date validFrom) {
setValidFrom(validFrom);
return this;
}
/**
*
* 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.
*
*
*
*
* @param 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.
*
*
*/
public void setValidUntil(java.util.Date validUntil) {
this.validUntil = 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.
*
*
*
*
* @return 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.
*
*
*/
public java.util.Date getValidUntil() {
return this.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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RequestSpotInstancesRequest withValidUntil(java.util.Date validUntil) {
setValidUntil(validUntil);
return this;
}
/**
*
* 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.
*
*
* @return 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.
*/
public java.util.List getTagSpecifications() {
if (tagSpecifications == null) {
tagSpecifications = new com.amazonaws.internal.SdkInternalList();
}
return 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.
*
*
* @param 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.
*/
public void setTagSpecifications(java.util.Collection tagSpecifications) {
if (tagSpecifications == null) {
this.tagSpecifications = null;
return;
}
this.tagSpecifications = new com.amazonaws.internal.SdkInternalList(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.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTagSpecifications(java.util.Collection)} or {@link #withTagSpecifications(java.util.Collection)} if
* you want to override the existing values.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RequestSpotInstancesRequest withTagSpecifications(TagSpecification... tagSpecifications) {
if (this.tagSpecifications == null) {
setTagSpecifications(new com.amazonaws.internal.SdkInternalList(tagSpecifications.length));
}
for (TagSpecification ele : tagSpecifications) {
this.tagSpecifications.add(ele);
}
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RequestSpotInstancesRequest withTagSpecifications(java.util.Collection tagSpecifications) {
setTagSpecifications(tagSpecifications);
return this;
}
/**
*
* The behavior when a Spot Instance is interrupted. The default is terminate.
*
*
* @param instanceInterruptionBehavior
* The behavior when a Spot Instance is interrupted. The default is terminate.
* @see InstanceInterruptionBehavior
*/
public void setInstanceInterruptionBehavior(String instanceInterruptionBehavior) {
this.instanceInterruptionBehavior = instanceInterruptionBehavior;
}
/**
*
* The behavior when a Spot Instance is interrupted. The default is terminate.
*
*
* @return The behavior when a Spot Instance is interrupted. The default is terminate.
* @see InstanceInterruptionBehavior
*/
public String getInstanceInterruptionBehavior() {
return this.instanceInterruptionBehavior;
}
/**
*
* The behavior when a Spot Instance is interrupted. The default is terminate.
*
*
* @param instanceInterruptionBehavior
* The behavior when a Spot Instance is interrupted. The default is terminate.
* @return Returns a reference to this object so that method calls can be chained together.
* @see InstanceInterruptionBehavior
*/
public RequestSpotInstancesRequest withInstanceInterruptionBehavior(String instanceInterruptionBehavior) {
setInstanceInterruptionBehavior(instanceInterruptionBehavior);
return this;
}
/**
*
* The behavior when a Spot Instance is interrupted. The default is terminate.
*
*
* @param instanceInterruptionBehavior
* The behavior when a Spot Instance is interrupted. The default is terminate.
* @see InstanceInterruptionBehavior
*/
public void setInstanceInterruptionBehavior(InstanceInterruptionBehavior instanceInterruptionBehavior) {
withInstanceInterruptionBehavior(instanceInterruptionBehavior);
}
/**
*
* The behavior when a Spot Instance is interrupted. The default is terminate.
*
*
* @param instanceInterruptionBehavior
* The behavior when a Spot Instance is interrupted. The default is terminate.
* @return Returns a reference to this object so that method calls can be chained together.
* @see InstanceInterruptionBehavior
*/
public RequestSpotInstancesRequest withInstanceInterruptionBehavior(InstanceInterruptionBehavior instanceInterruptionBehavior) {
this.instanceInterruptionBehavior = instanceInterruptionBehavior.toString();
return this;
}
/**
* This method is intended for internal use only. Returns the marshaled request configured with additional
* parameters to enable operation dry-run.
*/
@Override
public Request getDryRunRequest() {
Request request = new RequestSpotInstancesRequestMarshaller().marshall(this);
request.addParameter("DryRun", Boolean.toString(true));
return request;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getAvailabilityZoneGroup() != null)
sb.append("AvailabilityZoneGroup: ").append(getAvailabilityZoneGroup()).append(",");
if (getBlockDurationMinutes() != null)
sb.append("BlockDurationMinutes: ").append(getBlockDurationMinutes()).append(",");
if (getClientToken() != null)
sb.append("ClientToken: ").append(getClientToken()).append(",");
if (getInstanceCount() != null)
sb.append("InstanceCount: ").append(getInstanceCount()).append(",");
if (getLaunchGroup() != null)
sb.append("LaunchGroup: ").append(getLaunchGroup()).append(",");
if (getLaunchSpecification() != null)
sb.append("LaunchSpecification: ").append(getLaunchSpecification()).append(",");
if (getSpotPrice() != null)
sb.append("SpotPrice: ").append(getSpotPrice()).append(",");
if (getType() != null)
sb.append("Type: ").append(getType()).append(",");
if (getValidFrom() != null)
sb.append("ValidFrom: ").append(getValidFrom()).append(",");
if (getValidUntil() != null)
sb.append("ValidUntil: ").append(getValidUntil()).append(",");
if (getTagSpecifications() != null)
sb.append("TagSpecifications: ").append(getTagSpecifications()).append(",");
if (getInstanceInterruptionBehavior() != null)
sb.append("InstanceInterruptionBehavior: ").append(getInstanceInterruptionBehavior());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof RequestSpotInstancesRequest == false)
return false;
RequestSpotInstancesRequest other = (RequestSpotInstancesRequest) obj;
if (other.getAvailabilityZoneGroup() == null ^ this.getAvailabilityZoneGroup() == null)
return false;
if (other.getAvailabilityZoneGroup() != null && other.getAvailabilityZoneGroup().equals(this.getAvailabilityZoneGroup()) == false)
return false;
if (other.getBlockDurationMinutes() == null ^ this.getBlockDurationMinutes() == null)
return false;
if (other.getBlockDurationMinutes() != null && other.getBlockDurationMinutes().equals(this.getBlockDurationMinutes()) == false)
return false;
if (other.getClientToken() == null ^ this.getClientToken() == null)
return false;
if (other.getClientToken() != null && other.getClientToken().equals(this.getClientToken()) == false)
return false;
if (other.getInstanceCount() == null ^ this.getInstanceCount() == null)
return false;
if (other.getInstanceCount() != null && other.getInstanceCount().equals(this.getInstanceCount()) == false)
return false;
if (other.getLaunchGroup() == null ^ this.getLaunchGroup() == null)
return false;
if (other.getLaunchGroup() != null && other.getLaunchGroup().equals(this.getLaunchGroup()) == false)
return false;
if (other.getLaunchSpecification() == null ^ this.getLaunchSpecification() == null)
return false;
if (other.getLaunchSpecification() != null && other.getLaunchSpecification().equals(this.getLaunchSpecification()) == false)
return false;
if (other.getSpotPrice() == null ^ this.getSpotPrice() == null)
return false;
if (other.getSpotPrice() != null && other.getSpotPrice().equals(this.getSpotPrice()) == false)
return false;
if (other.getType() == null ^ this.getType() == null)
return false;
if (other.getType() != null && other.getType().equals(this.getType()) == false)
return false;
if (other.getValidFrom() == null ^ this.getValidFrom() == null)
return false;
if (other.getValidFrom() != null && other.getValidFrom().equals(this.getValidFrom()) == false)
return false;
if (other.getValidUntil() == null ^ this.getValidUntil() == null)
return false;
if (other.getValidUntil() != null && other.getValidUntil().equals(this.getValidUntil()) == false)
return false;
if (other.getTagSpecifications() == null ^ this.getTagSpecifications() == null)
return false;
if (other.getTagSpecifications() != null && other.getTagSpecifications().equals(this.getTagSpecifications()) == false)
return false;
if (other.getInstanceInterruptionBehavior() == null ^ this.getInstanceInterruptionBehavior() == null)
return false;
if (other.getInstanceInterruptionBehavior() != null && other.getInstanceInterruptionBehavior().equals(this.getInstanceInterruptionBehavior()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAvailabilityZoneGroup() == null) ? 0 : getAvailabilityZoneGroup().hashCode());
hashCode = prime * hashCode + ((getBlockDurationMinutes() == null) ? 0 : getBlockDurationMinutes().hashCode());
hashCode = prime * hashCode + ((getClientToken() == null) ? 0 : getClientToken().hashCode());
hashCode = prime * hashCode + ((getInstanceCount() == null) ? 0 : getInstanceCount().hashCode());
hashCode = prime * hashCode + ((getLaunchGroup() == null) ? 0 : getLaunchGroup().hashCode());
hashCode = prime * hashCode + ((getLaunchSpecification() == null) ? 0 : getLaunchSpecification().hashCode());
hashCode = prime * hashCode + ((getSpotPrice() == null) ? 0 : getSpotPrice().hashCode());
hashCode = prime * hashCode + ((getType() == null) ? 0 : getType().hashCode());
hashCode = prime * hashCode + ((getValidFrom() == null) ? 0 : getValidFrom().hashCode());
hashCode = prime * hashCode + ((getValidUntil() == null) ? 0 : getValidUntil().hashCode());
hashCode = prime * hashCode + ((getTagSpecifications() == null) ? 0 : getTagSpecifications().hashCode());
hashCode = prime * hashCode + ((getInstanceInterruptionBehavior() == null) ? 0 : getInstanceInterruptionBehavior().hashCode());
return hashCode;
}
@Override
public RequestSpotInstancesRequest clone() {
return (RequestSpotInstancesRequest) super.clone();
}
}