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

#include <StopInstancesRequest.h>

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

Public Member Functions

 StopInstancesRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::Vector< Aws::String > & GetInstanceIds () const
 
bool InstanceIdsHasBeenSet () const
 
void SetInstanceIds (const Aws::Vector< Aws::String > &value)
 
void SetInstanceIds (Aws::Vector< Aws::String > &&value)
 
StopInstancesRequestWithInstanceIds (const Aws::Vector< Aws::String > &value)
 
StopInstancesRequestWithInstanceIds (Aws::Vector< Aws::String > &&value)
 
StopInstancesRequestAddInstanceIds (const Aws::String &value)
 
StopInstancesRequestAddInstanceIds (Aws::String &&value)
 
StopInstancesRequestAddInstanceIds (const char *value)
 
bool GetHibernate () const
 
bool HibernateHasBeenSet () const
 
void SetHibernate (bool value)
 
StopInstancesRequestWithHibernate (bool value)
 
bool GetDryRun () const
 
bool DryRunHasBeenSet () const
 
void SetDryRun (bool value)
 
StopInstancesRequestWithDryRun (bool value)
 
bool GetForce () const
 
bool ForceHasBeenSet () const
 
void SetForce (bool value)
 
StopInstancesRequestWithForce (bool 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

Definition at line 32 of file StopInstancesRequest.h.

Constructor & Destructor Documentation

◆ StopInstancesRequest()

Aws::EC2::Model::StopInstancesRequest::StopInstancesRequest ( )

Member Function Documentation

◆ AddInstanceIds() [1/3]

StopInstancesRequest& Aws::EC2::Model::StopInstancesRequest::AddInstanceIds ( const Aws::String value)
inline

The IDs of the instances.

Definition at line 83 of file StopInstancesRequest.h.

◆ AddInstanceIds() [2/3]

StopInstancesRequest& Aws::EC2::Model::StopInstancesRequest::AddInstanceIds ( Aws::String &&  value)
inline

The IDs of the instances.

Definition at line 88 of file StopInstancesRequest.h.

◆ AddInstanceIds() [3/3]

StopInstancesRequest& Aws::EC2::Model::StopInstancesRequest::AddInstanceIds ( const char *  value)
inline

The IDs of the instances.

Definition at line 93 of file StopInstancesRequest.h.

◆ DryRunHasBeenSet()

bool Aws::EC2::Model::StopInstancesRequest::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 151 of file StopInstancesRequest.h.

◆ DumpBodyToUrl()

void Aws::EC2::Model::StopInstancesRequest::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.

◆ ForceHasBeenSet()

bool Aws::EC2::Model::StopInstancesRequest::ForceHasBeenSet ( ) const
inline

Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.

Default: false

Definition at line 184 of file StopInstancesRequest.h.

◆ GetDryRun()

bool Aws::EC2::Model::StopInstancesRequest::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 143 of file StopInstancesRequest.h.

◆ GetForce()

bool Aws::EC2::Model::StopInstancesRequest::GetForce ( ) const
inline

Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.

Default: false

Definition at line 176 of file StopInstancesRequest.h.

◆ GetHibernate()

bool Aws::EC2::Model::StopInstancesRequest::GetHibernate ( ) const
inline

Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot hibernate successfully, a normal shutdown occurs. For more information, see Hibernate Your Instance in the Amazon Elastic Compute Cloud User Guide.

Default: false

Definition at line 104 of file StopInstancesRequest.h.

◆ GetInstanceIds()

const Aws::Vector<Aws::String>& Aws::EC2::Model::StopInstancesRequest::GetInstanceIds ( ) const
inline

The IDs of the instances.

Definition at line 53 of file StopInstancesRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 41 of file StopInstancesRequest.h.

◆ HibernateHasBeenSet()

bool Aws::EC2::Model::StopInstancesRequest::HibernateHasBeenSet ( ) const
inline

Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot hibernate successfully, a normal shutdown occurs. For more information, see Hibernate Your Instance in the Amazon Elastic Compute Cloud User Guide.

Default: false

Definition at line 114 of file StopInstancesRequest.h.

◆ InstanceIdsHasBeenSet()

bool Aws::EC2::Model::StopInstancesRequest::InstanceIdsHasBeenSet ( ) const
inline

The IDs of the instances.

Definition at line 58 of file StopInstancesRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDryRun()

void Aws::EC2::Model::StopInstancesRequest::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 159 of file StopInstancesRequest.h.

◆ SetForce()

void Aws::EC2::Model::StopInstancesRequest::SetForce ( bool  value)
inline

Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.

Default: false

Definition at line 192 of file StopInstancesRequest.h.

◆ SetHibernate()

void Aws::EC2::Model::StopInstancesRequest::SetHibernate ( bool  value)
inline

Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot hibernate successfully, a normal shutdown occurs. For more information, see Hibernate Your Instance in the Amazon Elastic Compute Cloud User Guide.

Default: false

Definition at line 124 of file StopInstancesRequest.h.

◆ SetInstanceIds() [1/2]

void Aws::EC2::Model::StopInstancesRequest::SetInstanceIds ( const Aws::Vector< Aws::String > &  value)
inline

The IDs of the instances.

Definition at line 63 of file StopInstancesRequest.h.

◆ SetInstanceIds() [2/2]

void Aws::EC2::Model::StopInstancesRequest::SetInstanceIds ( Aws::Vector< Aws::String > &&  value)
inline

The IDs of the instances.

Definition at line 68 of file StopInstancesRequest.h.

◆ WithDryRun()

StopInstancesRequest& Aws::EC2::Model::StopInstancesRequest::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 167 of file StopInstancesRequest.h.

◆ WithForce()

StopInstancesRequest& Aws::EC2::Model::StopInstancesRequest::WithForce ( bool  value)
inline

Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.

Default: false

Definition at line 200 of file StopInstancesRequest.h.

◆ WithHibernate()

StopInstancesRequest& Aws::EC2::Model::StopInstancesRequest::WithHibernate ( bool  value)
inline

Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot hibernate successfully, a normal shutdown occurs. For more information, see Hibernate Your Instance in the Amazon Elastic Compute Cloud User Guide.

Default: false

Definition at line 134 of file StopInstancesRequest.h.

◆ WithInstanceIds() [1/2]

StopInstancesRequest& Aws::EC2::Model::StopInstancesRequest::WithInstanceIds ( const Aws::Vector< Aws::String > &  value)
inline

The IDs of the instances.

Definition at line 73 of file StopInstancesRequest.h.

◆ WithInstanceIds() [2/2]

StopInstancesRequest& Aws::EC2::Model::StopInstancesRequest::WithInstanceIds ( Aws::Vector< Aws::String > &&  value)
inline

The IDs of the instances.

Definition at line 78 of file StopInstancesRequest.h.


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