AWS SDK for C++  1.9.108
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::EC2::Model::RequestSpotInstancesRequest Class Reference

#include <RequestSpotInstancesRequest.h>

+ Inheritance diagram for Aws::EC2::Model::RequestSpotInstancesRequest:

Public Member Functions

 RequestSpotInstancesRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetAvailabilityZoneGroup () const
 
bool AvailabilityZoneGroupHasBeenSet () const
 
void SetAvailabilityZoneGroup (const Aws::String &value)
 
void SetAvailabilityZoneGroup (Aws::String &&value)
 
void SetAvailabilityZoneGroup (const char *value)
 
RequestSpotInstancesRequestWithAvailabilityZoneGroup (const Aws::String &value)
 
RequestSpotInstancesRequestWithAvailabilityZoneGroup (Aws::String &&value)
 
RequestSpotInstancesRequestWithAvailabilityZoneGroup (const char *value)
 
int GetBlockDurationMinutes () const
 
bool BlockDurationMinutesHasBeenSet () const
 
void SetBlockDurationMinutes (int value)
 
RequestSpotInstancesRequestWithBlockDurationMinutes (int value)
 
const Aws::StringGetClientToken () const
 
bool ClientTokenHasBeenSet () const
 
void SetClientToken (const Aws::String &value)
 
void SetClientToken (Aws::String &&value)
 
void SetClientToken (const char *value)
 
RequestSpotInstancesRequestWithClientToken (const Aws::String &value)
 
RequestSpotInstancesRequestWithClientToken (Aws::String &&value)
 
RequestSpotInstancesRequestWithClientToken (const char *value)
 
bool GetDryRun () const
 
bool DryRunHasBeenSet () const
 
void SetDryRun (bool value)
 
RequestSpotInstancesRequestWithDryRun (bool value)
 
int GetInstanceCount () const
 
bool InstanceCountHasBeenSet () const
 
void SetInstanceCount (int value)
 
RequestSpotInstancesRequestWithInstanceCount (int value)
 
const Aws::StringGetLaunchGroup () const
 
bool LaunchGroupHasBeenSet () const
 
void SetLaunchGroup (const Aws::String &value)
 
void SetLaunchGroup (Aws::String &&value)
 
void SetLaunchGroup (const char *value)
 
RequestSpotInstancesRequestWithLaunchGroup (const Aws::String &value)
 
RequestSpotInstancesRequestWithLaunchGroup (Aws::String &&value)
 
RequestSpotInstancesRequestWithLaunchGroup (const char *value)
 
const RequestSpotLaunchSpecificationGetLaunchSpecification () const
 
bool LaunchSpecificationHasBeenSet () const
 
void SetLaunchSpecification (const RequestSpotLaunchSpecification &value)
 
void SetLaunchSpecification (RequestSpotLaunchSpecification &&value)
 
RequestSpotInstancesRequestWithLaunchSpecification (const RequestSpotLaunchSpecification &value)
 
RequestSpotInstancesRequestWithLaunchSpecification (RequestSpotLaunchSpecification &&value)
 
const Aws::StringGetSpotPrice () const
 
bool SpotPriceHasBeenSet () const
 
void SetSpotPrice (const Aws::String &value)
 
void SetSpotPrice (Aws::String &&value)
 
void SetSpotPrice (const char *value)
 
RequestSpotInstancesRequestWithSpotPrice (const Aws::String &value)
 
RequestSpotInstancesRequestWithSpotPrice (Aws::String &&value)
 
RequestSpotInstancesRequestWithSpotPrice (const char *value)
 
const SpotInstanceTypeGetType () const
 
bool TypeHasBeenSet () const
 
void SetType (const SpotInstanceType &value)
 
void SetType (SpotInstanceType &&value)
 
RequestSpotInstancesRequestWithType (const SpotInstanceType &value)
 
RequestSpotInstancesRequestWithType (SpotInstanceType &&value)
 
const Aws::Utils::DateTimeGetValidFrom () const
 
bool ValidFromHasBeenSet () const
 
void SetValidFrom (const Aws::Utils::DateTime &value)
 
void SetValidFrom (Aws::Utils::DateTime &&value)
 
RequestSpotInstancesRequestWithValidFrom (const Aws::Utils::DateTime &value)
 
RequestSpotInstancesRequestWithValidFrom (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetValidUntil () const
 
bool ValidUntilHasBeenSet () const
 
void SetValidUntil (const Aws::Utils::DateTime &value)
 
void SetValidUntil (Aws::Utils::DateTime &&value)
 
RequestSpotInstancesRequestWithValidUntil (const Aws::Utils::DateTime &value)
 
RequestSpotInstancesRequestWithValidUntil (Aws::Utils::DateTime &&value)
 
const Aws::Vector< TagSpecification > & GetTagSpecifications () const
 
bool TagSpecificationsHasBeenSet () const
 
void SetTagSpecifications (const Aws::Vector< TagSpecification > &value)
 
void SetTagSpecifications (Aws::Vector< TagSpecification > &&value)
 
RequestSpotInstancesRequestWithTagSpecifications (const Aws::Vector< TagSpecification > &value)
 
RequestSpotInstancesRequestWithTagSpecifications (Aws::Vector< TagSpecification > &&value)
 
RequestSpotInstancesRequestAddTagSpecifications (const TagSpecification &value)
 
RequestSpotInstancesRequestAddTagSpecifications (TagSpecification &&value)
 
const InstanceInterruptionBehaviorGetInstanceInterruptionBehavior () const
 
bool InstanceInterruptionBehaviorHasBeenSet () const
 
void SetInstanceInterruptionBehavior (const InstanceInterruptionBehavior &value)
 
void SetInstanceInterruptionBehavior (InstanceInterruptionBehavior &&value)
 
RequestSpotInstancesRequestWithInstanceInterruptionBehavior (const InstanceInterruptionBehavior &value)
 
RequestSpotInstancesRequestWithInstanceInterruptionBehavior (InstanceInterruptionBehavior &&value)
 
- Public Member Functions inherited from Aws::EC2::EC2Request
virtual ~EC2Request ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Protected Member Functions

void DumpBodyToUrl (Aws::Http::URI &uri) const override
 
- Protected Member Functions inherited from Aws::EC2::EC2Request
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

Contains the parameters for RequestSpotInstances.

See Also:


AWS API Reference

Definition at line 31 of file RequestSpotInstancesRequest.h.

Constructor & Destructor Documentation

◆ RequestSpotInstancesRequest()

Aws::EC2::Model::RequestSpotInstancesRequest::RequestSpotInstancesRequest ( )

Member Function Documentation

◆ AddTagSpecifications() [1/2]

RequestSpotInstancesRequest& Aws::EC2::Model::RequestSpotInstancesRequest::AddTagSpecifications ( const TagSpecification value)
inline

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.

Definition at line 734 of file RequestSpotInstancesRequest.h.

◆ AddTagSpecifications() [2/2]

RequestSpotInstancesRequest& Aws::EC2::Model::RequestSpotInstancesRequest::AddTagSpecifications ( TagSpecification &&  value)
inline

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.

Definition at line 744 of file RequestSpotInstancesRequest.h.

◆ AvailabilityZoneGroupHasBeenSet()

bool Aws::EC2::Model::RequestSpotInstancesRequest::AvailabilityZoneGroupHasBeenSet ( ) const
inline

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.

Definition at line 87 of file RequestSpotInstancesRequest.h.

◆ BlockDurationMinutesHasBeenSet()

bool Aws::EC2::Model::RequestSpotInstancesRequest::BlockDurationMinutesHasBeenSet ( ) const
inline

Deprecated.

Definition at line 218 of file RequestSpotInstancesRequest.h.

◆ ClientTokenHasBeenSet()

bool Aws::EC2::Model::RequestSpotInstancesRequest::ClientTokenHasBeenSet ( ) const
inline

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.

Definition at line 247 of file RequestSpotInstancesRequest.h.

◆ DryRunHasBeenSet()

bool Aws::EC2::Model::RequestSpotInstancesRequest::DryRunHasBeenSet ( ) const
inline

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Definition at line 318 of file RequestSpotInstancesRequest.h.

◆ DumpBodyToUrl()

void Aws::EC2::Model::RequestSpotInstancesRequest::DumpBodyToUrl ( Aws::Http::URI uri) const
overrideprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Reimplemented from Aws::AmazonWebServiceRequest.

◆ GetAvailabilityZoneGroup()

const Aws::String& Aws::EC2::Model::RequestSpotInstancesRequest::GetAvailabilityZoneGroup ( ) const
inline

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.

Definition at line 67 of file RequestSpotInstancesRequest.h.

◆ GetBlockDurationMinutes()

int Aws::EC2::Model::RequestSpotInstancesRequest::GetBlockDurationMinutes ( ) const
inline

Deprecated.

Definition at line 213 of file RequestSpotInstancesRequest.h.

◆ GetClientToken()

const Aws::String& Aws::EC2::Model::RequestSpotInstancesRequest::GetClientToken ( ) const
inline

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.

Definition at line 238 of file RequestSpotInstancesRequest.h.

◆ GetDryRun()

bool Aws::EC2::Model::RequestSpotInstancesRequest::GetDryRun ( ) const
inline

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Definition at line 310 of file RequestSpotInstancesRequest.h.

◆ GetInstanceCount()

int Aws::EC2::Model::RequestSpotInstancesRequest::GetInstanceCount ( ) const
inline

The maximum number of Spot Instances to launch.

Default: 1

Definition at line 340 of file RequestSpotInstancesRequest.h.

◆ GetInstanceInterruptionBehavior()

const InstanceInterruptionBehavior& Aws::EC2::Model::RequestSpotInstancesRequest::GetInstanceInterruptionBehavior ( ) const
inline

The behavior when a Spot Instance is interrupted. The default is terminate.

Definition at line 751 of file RequestSpotInstancesRequest.h.

◆ GetLaunchGroup()

const Aws::String& Aws::EC2::Model::RequestSpotInstancesRequest::GetLaunchGroup ( ) const
inline

The instance launch group. Launch groups are Spot Instances that launch together and terminate together.

Default: Instances are launched and terminated individually

Definition at line 363 of file RequestSpotInstancesRequest.h.

◆ GetLaunchSpecification()

const RequestSpotLaunchSpecification& Aws::EC2::Model::RequestSpotInstancesRequest::GetLaunchSpecification ( ) const
inline

The launch specification.

Definition at line 418 of file RequestSpotInstancesRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::EC2::Model::RequestSpotInstancesRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 40 of file RequestSpotInstancesRequest.h.

◆ GetSpotPrice()

const Aws::String& Aws::EC2::Model::RequestSpotInstancesRequest::GetSpotPrice ( ) const
inline

The maximum price per hour that you are willing to pay for a Spot Instance. The default is the On-Demand price.

Definition at line 450 of file RequestSpotInstancesRequest.h.

◆ GetTagSpecifications()

const Aws::Vector<TagSpecification>& Aws::EC2::Model::RequestSpotInstancesRequest::GetTagSpecifications ( ) const
inline

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.

Definition at line 674 of file RequestSpotInstancesRequest.h.

◆ GetType()

const SpotInstanceType& Aws::EC2::Model::RequestSpotInstancesRequest::GetType ( ) const
inline

The Spot Instance request type.

Default: one-time

Definition at line 498 of file RequestSpotInstancesRequest.h.

◆ GetValidFrom()

const Aws::Utils::DateTime& Aws::EC2::Model::RequestSpotInstancesRequest::GetValidFrom ( ) const
inline

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.

Definition at line 535 of file RequestSpotInstancesRequest.h.

◆ GetValidUntil()

const Aws::Utils::DateTime& Aws::EC2::Model::RequestSpotInstancesRequest::GetValidUntil ( ) const
inline

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.

Definition at line 603 of file RequestSpotInstancesRequest.h.

◆ InstanceCountHasBeenSet()

bool Aws::EC2::Model::RequestSpotInstancesRequest::InstanceCountHasBeenSet ( ) const
inline

The maximum number of Spot Instances to launch.

Default: 1

Definition at line 345 of file RequestSpotInstancesRequest.h.

◆ InstanceInterruptionBehaviorHasBeenSet()

bool Aws::EC2::Model::RequestSpotInstancesRequest::InstanceInterruptionBehaviorHasBeenSet ( ) const
inline

The behavior when a Spot Instance is interrupted. The default is terminate.

Definition at line 757 of file RequestSpotInstancesRequest.h.

◆ LaunchGroupHasBeenSet()

bool Aws::EC2::Model::RequestSpotInstancesRequest::LaunchGroupHasBeenSet ( ) const
inline

The instance launch group. Launch groups are Spot Instances that launch together and terminate together.

Default: Instances are launched and terminated individually

Definition at line 370 of file RequestSpotInstancesRequest.h.

◆ LaunchSpecificationHasBeenSet()

bool Aws::EC2::Model::RequestSpotInstancesRequest::LaunchSpecificationHasBeenSet ( ) const
inline

The launch specification.

Definition at line 423 of file RequestSpotInstancesRequest.h.

◆ SerializePayload()

Aws::String Aws::EC2::Model::RequestSpotInstancesRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAvailabilityZoneGroup() [1/3]

void Aws::EC2::Model::RequestSpotInstancesRequest::SetAvailabilityZoneGroup ( Aws::String &&  value)
inline

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.

Definition at line 127 of file RequestSpotInstancesRequest.h.

◆ SetAvailabilityZoneGroup() [2/3]

void Aws::EC2::Model::RequestSpotInstancesRequest::SetAvailabilityZoneGroup ( const Aws::String value)
inline

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.

Definition at line 107 of file RequestSpotInstancesRequest.h.

◆ SetAvailabilityZoneGroup() [3/3]

void Aws::EC2::Model::RequestSpotInstancesRequest::SetAvailabilityZoneGroup ( const char *  value)
inline

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.

Definition at line 147 of file RequestSpotInstancesRequest.h.

◆ SetBlockDurationMinutes()

void Aws::EC2::Model::RequestSpotInstancesRequest::SetBlockDurationMinutes ( int  value)
inline

Deprecated.

Definition at line 223 of file RequestSpotInstancesRequest.h.

◆ SetClientToken() [1/3]

void Aws::EC2::Model::RequestSpotInstancesRequest::SetClientToken ( Aws::String &&  value)
inline

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.

Definition at line 265 of file RequestSpotInstancesRequest.h.

◆ SetClientToken() [2/3]

void Aws::EC2::Model::RequestSpotInstancesRequest::SetClientToken ( const Aws::String value)
inline

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.

Definition at line 256 of file RequestSpotInstancesRequest.h.

◆ SetClientToken() [3/3]

void Aws::EC2::Model::RequestSpotInstancesRequest::SetClientToken ( const char *  value)
inline

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.

Definition at line 274 of file RequestSpotInstancesRequest.h.

◆ SetDryRun()

void Aws::EC2::Model::RequestSpotInstancesRequest::SetDryRun ( bool  value)
inline

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Definition at line 326 of file RequestSpotInstancesRequest.h.

◆ SetInstanceCount()

void Aws::EC2::Model::RequestSpotInstancesRequest::SetInstanceCount ( int  value)
inline

The maximum number of Spot Instances to launch.

Default: 1

Definition at line 350 of file RequestSpotInstancesRequest.h.

◆ SetInstanceInterruptionBehavior() [1/2]

void Aws::EC2::Model::RequestSpotInstancesRequest::SetInstanceInterruptionBehavior ( const InstanceInterruptionBehavior value)
inline

The behavior when a Spot Instance is interrupted. The default is terminate.

Definition at line 763 of file RequestSpotInstancesRequest.h.

◆ SetInstanceInterruptionBehavior() [2/2]

void Aws::EC2::Model::RequestSpotInstancesRequest::SetInstanceInterruptionBehavior ( InstanceInterruptionBehavior &&  value)
inline

The behavior when a Spot Instance is interrupted. The default is terminate.

Definition at line 769 of file RequestSpotInstancesRequest.h.

◆ SetLaunchGroup() [1/3]

void Aws::EC2::Model::RequestSpotInstancesRequest::SetLaunchGroup ( Aws::String &&  value)
inline

The instance launch group. Launch groups are Spot Instances that launch together and terminate together.

Default: Instances are launched and terminated individually

Definition at line 384 of file RequestSpotInstancesRequest.h.

◆ SetLaunchGroup() [2/3]

void Aws::EC2::Model::RequestSpotInstancesRequest::SetLaunchGroup ( const Aws::String value)
inline

The instance launch group. Launch groups are Spot Instances that launch together and terminate together.

Default: Instances are launched and terminated individually

Definition at line 377 of file RequestSpotInstancesRequest.h.

◆ SetLaunchGroup() [3/3]

void Aws::EC2::Model::RequestSpotInstancesRequest::SetLaunchGroup ( const char *  value)
inline

The instance launch group. Launch groups are Spot Instances that launch together and terminate together.

Default: Instances are launched and terminated individually

Definition at line 391 of file RequestSpotInstancesRequest.h.

◆ SetLaunchSpecification() [1/2]

void Aws::EC2::Model::RequestSpotInstancesRequest::SetLaunchSpecification ( const RequestSpotLaunchSpecification value)
inline

The launch specification.

Definition at line 428 of file RequestSpotInstancesRequest.h.

◆ SetLaunchSpecification() [2/2]

void Aws::EC2::Model::RequestSpotInstancesRequest::SetLaunchSpecification ( RequestSpotLaunchSpecification &&  value)
inline

The launch specification.

Definition at line 433 of file RequestSpotInstancesRequest.h.

◆ SetSpotPrice() [1/3]

void Aws::EC2::Model::RequestSpotInstancesRequest::SetSpotPrice ( Aws::String &&  value)
inline

The maximum price per hour that you are willing to pay for a Spot Instance. The default is the On-Demand price.

Definition at line 468 of file RequestSpotInstancesRequest.h.

◆ SetSpotPrice() [2/3]

void Aws::EC2::Model::RequestSpotInstancesRequest::SetSpotPrice ( const Aws::String value)
inline

The maximum price per hour that you are willing to pay for a Spot Instance. The default is the On-Demand price.

Definition at line 462 of file RequestSpotInstancesRequest.h.

◆ SetSpotPrice() [3/3]

void Aws::EC2::Model::RequestSpotInstancesRequest::SetSpotPrice ( const char *  value)
inline

The maximum price per hour that you are willing to pay for a Spot Instance. The default is the On-Demand price.

Definition at line 474 of file RequestSpotInstancesRequest.h.

◆ SetTagSpecifications() [1/2]

void Aws::EC2::Model::RequestSpotInstancesRequest::SetTagSpecifications ( Aws::Vector< TagSpecification > &&  value)
inline

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.

Definition at line 704 of file RequestSpotInstancesRequest.h.

◆ SetTagSpecifications() [2/2]

void Aws::EC2::Model::RequestSpotInstancesRequest::SetTagSpecifications ( const Aws::Vector< TagSpecification > &  value)
inline

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.

Definition at line 694 of file RequestSpotInstancesRequest.h.

◆ SetType() [1/2]

void Aws::EC2::Model::RequestSpotInstancesRequest::SetType ( const SpotInstanceType value)
inline

The Spot Instance request type.

Default: one-time

Definition at line 508 of file RequestSpotInstancesRequest.h.

◆ SetType() [2/2]

void Aws::EC2::Model::RequestSpotInstancesRequest::SetType ( SpotInstanceType &&  value)
inline

The Spot Instance request type.

Default: one-time

Definition at line 513 of file RequestSpotInstancesRequest.h.

◆ SetValidFrom() [1/2]

void Aws::EC2::Model::RequestSpotInstancesRequest::SetValidFrom ( Aws::Utils::DateTime &&  value)
inline

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.

Definition at line 568 of file RequestSpotInstancesRequest.h.

◆ SetValidFrom() [2/2]

void Aws::EC2::Model::RequestSpotInstancesRequest::SetValidFrom ( const Aws::Utils::DateTime value)
inline

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.

Definition at line 557 of file RequestSpotInstancesRequest.h.

◆ SetValidUntil() [1/2]

void Aws::EC2::Model::RequestSpotInstancesRequest::SetValidUntil ( Aws::Utils::DateTime &&  value)
inline

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.

Definition at line 639 of file RequestSpotInstancesRequest.h.

◆ SetValidUntil() [2/2]

void Aws::EC2::Model::RequestSpotInstancesRequest::SetValidUntil ( const Aws::Utils::DateTime value)
inline

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.

Definition at line 627 of file RequestSpotInstancesRequest.h.

◆ SpotPriceHasBeenSet()

bool Aws::EC2::Model::RequestSpotInstancesRequest::SpotPriceHasBeenSet ( ) const
inline

The maximum price per hour that you are willing to pay for a Spot Instance. The default is the On-Demand price.

Definition at line 456 of file RequestSpotInstancesRequest.h.

◆ TagSpecificationsHasBeenSet()

bool Aws::EC2::Model::RequestSpotInstancesRequest::TagSpecificationsHasBeenSet ( ) const
inline

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.

Definition at line 684 of file RequestSpotInstancesRequest.h.

◆ TypeHasBeenSet()

bool Aws::EC2::Model::RequestSpotInstancesRequest::TypeHasBeenSet ( ) const
inline

The Spot Instance request type.

Default: one-time

Definition at line 503 of file RequestSpotInstancesRequest.h.

◆ ValidFromHasBeenSet()

bool Aws::EC2::Model::RequestSpotInstancesRequest::ValidFromHasBeenSet ( ) const
inline

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.

Definition at line 546 of file RequestSpotInstancesRequest.h.

◆ ValidUntilHasBeenSet()

bool Aws::EC2::Model::RequestSpotInstancesRequest::ValidUntilHasBeenSet ( ) const
inline

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.

Definition at line 615 of file RequestSpotInstancesRequest.h.

◆ WithAvailabilityZoneGroup() [1/3]

RequestSpotInstancesRequest& Aws::EC2::Model::RequestSpotInstancesRequest::WithAvailabilityZoneGroup ( Aws::String &&  value)
inline

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.

Definition at line 187 of file RequestSpotInstancesRequest.h.

◆ WithAvailabilityZoneGroup() [2/3]

RequestSpotInstancesRequest& Aws::EC2::Model::RequestSpotInstancesRequest::WithAvailabilityZoneGroup ( const Aws::String value)
inline

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.

Definition at line 167 of file RequestSpotInstancesRequest.h.

◆ WithAvailabilityZoneGroup() [3/3]

RequestSpotInstancesRequest& Aws::EC2::Model::RequestSpotInstancesRequest::WithAvailabilityZoneGroup ( const char *  value)
inline

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.

Definition at line 207 of file RequestSpotInstancesRequest.h.

◆ WithBlockDurationMinutes()

RequestSpotInstancesRequest& Aws::EC2::Model::RequestSpotInstancesRequest::WithBlockDurationMinutes ( int  value)
inline

Deprecated.

Definition at line 228 of file RequestSpotInstancesRequest.h.

◆ WithClientToken() [1/3]

RequestSpotInstancesRequest& Aws::EC2::Model::RequestSpotInstancesRequest::WithClientToken ( Aws::String &&  value)
inline

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.

Definition at line 292 of file RequestSpotInstancesRequest.h.

◆ WithClientToken() [2/3]

RequestSpotInstancesRequest& Aws::EC2::Model::RequestSpotInstancesRequest::WithClientToken ( const Aws::String value)
inline

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.

Definition at line 283 of file RequestSpotInstancesRequest.h.

◆ WithClientToken() [3/3]

RequestSpotInstancesRequest& Aws::EC2::Model::RequestSpotInstancesRequest::WithClientToken ( const char *  value)
inline

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.

Definition at line 301 of file RequestSpotInstancesRequest.h.

◆ WithDryRun()

RequestSpotInstancesRequest& Aws::EC2::Model::RequestSpotInstancesRequest::WithDryRun ( bool  value)
inline

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Definition at line 334 of file RequestSpotInstancesRequest.h.

◆ WithInstanceCount()

RequestSpotInstancesRequest& Aws::EC2::Model::RequestSpotInstancesRequest::WithInstanceCount ( int  value)
inline

The maximum number of Spot Instances to launch.

Default: 1

Definition at line 355 of file RequestSpotInstancesRequest.h.

◆ WithInstanceInterruptionBehavior() [1/2]

RequestSpotInstancesRequest& Aws::EC2::Model::RequestSpotInstancesRequest::WithInstanceInterruptionBehavior ( const InstanceInterruptionBehavior value)
inline

The behavior when a Spot Instance is interrupted. The default is terminate.

Definition at line 775 of file RequestSpotInstancesRequest.h.

◆ WithInstanceInterruptionBehavior() [2/2]

RequestSpotInstancesRequest& Aws::EC2::Model::RequestSpotInstancesRequest::WithInstanceInterruptionBehavior ( InstanceInterruptionBehavior &&  value)
inline

The behavior when a Spot Instance is interrupted. The default is terminate.

Definition at line 781 of file RequestSpotInstancesRequest.h.

◆ WithLaunchGroup() [1/3]

RequestSpotInstancesRequest& Aws::EC2::Model::RequestSpotInstancesRequest::WithLaunchGroup ( Aws::String &&  value)
inline

The instance launch group. Launch groups are Spot Instances that launch together and terminate together.

Default: Instances are launched and terminated individually

Definition at line 405 of file RequestSpotInstancesRequest.h.

◆ WithLaunchGroup() [2/3]

RequestSpotInstancesRequest& Aws::EC2::Model::RequestSpotInstancesRequest::WithLaunchGroup ( const Aws::String value)
inline

The instance launch group. Launch groups are Spot Instances that launch together and terminate together.

Default: Instances are launched and terminated individually

Definition at line 398 of file RequestSpotInstancesRequest.h.

◆ WithLaunchGroup() [3/3]

RequestSpotInstancesRequest& Aws::EC2::Model::RequestSpotInstancesRequest::WithLaunchGroup ( const char *  value)
inline

The instance launch group. Launch groups are Spot Instances that launch together and terminate together.

Default: Instances are launched and terminated individually

Definition at line 412 of file RequestSpotInstancesRequest.h.

◆ WithLaunchSpecification() [1/2]

RequestSpotInstancesRequest& Aws::EC2::Model::RequestSpotInstancesRequest::WithLaunchSpecification ( const RequestSpotLaunchSpecification value)
inline

The launch specification.

Definition at line 438 of file RequestSpotInstancesRequest.h.

◆ WithLaunchSpecification() [2/2]

RequestSpotInstancesRequest& Aws::EC2::Model::RequestSpotInstancesRequest::WithLaunchSpecification ( RequestSpotLaunchSpecification &&  value)
inline

The launch specification.

Definition at line 443 of file RequestSpotInstancesRequest.h.

◆ WithSpotPrice() [1/3]

RequestSpotInstancesRequest& Aws::EC2::Model::RequestSpotInstancesRequest::WithSpotPrice ( Aws::String &&  value)
inline

The maximum price per hour that you are willing to pay for a Spot Instance. The default is the On-Demand price.

Definition at line 486 of file RequestSpotInstancesRequest.h.

◆ WithSpotPrice() [2/3]

RequestSpotInstancesRequest& Aws::EC2::Model::RequestSpotInstancesRequest::WithSpotPrice ( const Aws::String value)
inline

The maximum price per hour that you are willing to pay for a Spot Instance. The default is the On-Demand price.

Definition at line 480 of file RequestSpotInstancesRequest.h.

◆ WithSpotPrice() [3/3]

RequestSpotInstancesRequest& Aws::EC2::Model::RequestSpotInstancesRequest::WithSpotPrice ( const char *  value)
inline

The maximum price per hour that you are willing to pay for a Spot Instance. The default is the On-Demand price.

Definition at line 492 of file RequestSpotInstancesRequest.h.

◆ WithTagSpecifications() [1/2]

RequestSpotInstancesRequest& Aws::EC2::Model::RequestSpotInstancesRequest::WithTagSpecifications ( Aws::Vector< TagSpecification > &&  value)
inline

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.

Definition at line 724 of file RequestSpotInstancesRequest.h.

◆ WithTagSpecifications() [2/2]

RequestSpotInstancesRequest& Aws::EC2::Model::RequestSpotInstancesRequest::WithTagSpecifications ( const Aws::Vector< TagSpecification > &  value)
inline

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.

Definition at line 714 of file RequestSpotInstancesRequest.h.

◆ WithType() [1/2]

RequestSpotInstancesRequest& Aws::EC2::Model::RequestSpotInstancesRequest::WithType ( const SpotInstanceType value)
inline

The Spot Instance request type.

Default: one-time

Definition at line 518 of file RequestSpotInstancesRequest.h.

◆ WithType() [2/2]

RequestSpotInstancesRequest& Aws::EC2::Model::RequestSpotInstancesRequest::WithType ( SpotInstanceType &&  value)
inline

The Spot Instance request type.

Default: one-time

Definition at line 523 of file RequestSpotInstancesRequest.h.

◆ WithValidFrom() [1/2]

RequestSpotInstancesRequest& Aws::EC2::Model::RequestSpotInstancesRequest::WithValidFrom ( Aws::Utils::DateTime &&  value)
inline

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.

Definition at line 590 of file RequestSpotInstancesRequest.h.

◆ WithValidFrom() [2/2]

RequestSpotInstancesRequest& Aws::EC2::Model::RequestSpotInstancesRequest::WithValidFrom ( const Aws::Utils::DateTime value)
inline

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.

Definition at line 579 of file RequestSpotInstancesRequest.h.

◆ WithValidUntil() [1/2]

RequestSpotInstancesRequest& Aws::EC2::Model::RequestSpotInstancesRequest::WithValidUntil ( Aws::Utils::DateTime &&  value)
inline

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.

Definition at line 663 of file RequestSpotInstancesRequest.h.

◆ WithValidUntil() [2/2]

RequestSpotInstancesRequest& Aws::EC2::Model::RequestSpotInstancesRequest::WithValidUntil ( const Aws::Utils::DateTime value)
inline

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.

Definition at line 651 of file RequestSpotInstancesRequest.h.


The documentation for this class was generated from the following file: