Aws::EC2::Model::StopInstancesRequest Class Reference

#include <StopInstancesRequest.h>

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

Public Member Functions

AWS_EC2_API StopInstancesRequest ()=default

 

virtual const char * GetServiceRequestName () const override

 

AWS_EC2_API Aws::String SerializePayload () const override

 

const Aws::Vector< Aws::String > & GetInstanceIds () const

 

bool InstanceIdsHasBeenSet () const

 

template<typename InstanceIdsT = Aws::Vector<Aws::String>>

void SetInstanceIds (InstanceIdsT &&value)

 

template<typename InstanceIdsT = Aws::Vector<Aws::String>>

StopInstancesRequest & WithInstanceIds (InstanceIdsT &&value)

 

template<typename InstanceIdsT = Aws::String>

StopInstancesRequest & AddInstanceIds (InstanceIdsT &&value)

 

bool GetHibernate () const

 

bool HibernateHasBeenSet () const

 

void SetHibernate (bool value)

 

StopInstancesRequest & WithHibernate (bool value)

 

bool GetSkipOsShutdown () const

 

bool SkipOsShutdownHasBeenSet () const

 

void SetSkipOsShutdown (bool value)

 

StopInstancesRequest & WithSkipOsShutdown (bool value)

 

bool GetDryRun () const

 

bool DryRunHasBeenSet () const

 

void SetDryRun (bool value)

 

StopInstancesRequest & WithDryRun (bool value)

 

bool GetForce () const

 

bool ForceHasBeenSet () const

 

void SetForce (bool value)

 

StopInstancesRequest & WithForce (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::IOStream > GetBody () const override

 

Public Member Functions inherited from Aws::AmazonWebServiceRequest

 AmazonWebServiceRequest ()

 

virtual ~AmazonWebServiceRequest ()=default

 

virtual const Aws::Http::HeaderValueCollection & GetAdditionalCustomHeaders () const

 

virtual void SetAdditionalCustomHeaderValue (const Aws::String &headerName, const Aws::String &headerValue)

 

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 HasEventStreamResponse () const

 

virtual bool SignBody () const

 

virtual bool HasEmbeddedError (Aws::IOStream &body, const Aws::Http::HeaderValueCollection &header) const

 

virtual bool IsChunked () const

 

virtual bool IsLongPollingOperation () const

 

virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)

 

virtual const RequestSignedHandler & GetRequestSignedHandler () const

 

const Aws::IOStreamFactory & GetResponseStreamFactory () const

 

void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)

 

virtual const Aws::Http::HeadersReceivedEventHandler & GetHeadersReceivedEventHandler () const

 

virtual const Aws::Http::DataReceivedEventHandler & GetDataReceivedEventHandler () const

 

virtual const Aws::Http::DataSentEventHandler & GetDataSentEventHandler () const

 

virtual const Aws::Http::ContinueRequestHandler & GetContinueRequestHandler () const

 

virtual const RequestRetryHandler & GetRequestRetryHandler () const

 

virtual bool ShouldComputeContentMd5 () const

 

virtual bool ShouldValidateResponseChecksum () const

 

virtual Aws::Vector< Aws::String > GetResponseChecksumAlgorithmNames () const

 

virtual Aws::String GetChecksumAlgorithmName () const

 

virtual void SetServiceSpecificParameters (const std::shared_ptr< Http::ServiceSpecificParameters > &serviceSpecificParameters) const

 

virtual std::shared_ptr< Http::ServiceSpecificParameters > GetServiceSpecificParameters () const

 

virtual EndpointParameters GetEndpointContextParams () const

 

virtual Aws::Client::CompressionAlgorithm GetSelectedCompressionAlgorithm (Aws::Client::RequestCompressionConfig) const

 

void AddUserAgentFeature (Aws::Client::UserAgentFeature feature) const

 

Aws::Set< Aws::Client::UserAgentFeature > GetUserAgentFeatures () const

 

virtual bool RequestChecksumRequired () const

 

RetryContext GetRetryContext () const

 

void SetRetryContext (const RetryContext &context) const

 

virtual Aws::Vector< smithy::AuthSchemeOption > GetRequestSpecificSupportedAuth () const

 

virtual bool ChecksumAlgorithmIsSet () const

 

virtual void SetHeadersReceivedEventHandler (const Aws::Http::HeadersReceivedEventHandler &headersReceivedEventHandler)

 

virtual void SetHeadersReceivedEventHandler (Aws::Http::HeadersReceivedEventHandler &&headersReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)

 

virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)

 

virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)

 

virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)

 

virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)

 

virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)

 

virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)

 

virtual void SetHeadersReceivedEventHandler (const Aws::Http::HeadersReceivedEventHandler &headersReceivedEventHandler)

 

virtual void SetHeadersReceivedEventHandler (Aws::Http::HeadersReceivedEventHandler &&headersReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)

 

virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)

 

virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)

 

virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)

 

virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)

 

virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)

 

virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)

 

Protected Member Functions

AWS_EC2_API void DumpBodyToUrl (Aws::Http::URI &uri) const override

 

Protected Member Functions inherited from Aws::EC2::EC2Request

virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const

 

Additional Inherited Members

Public Types inherited from Aws::EC2::EC2Request

using EndpointParameter = Aws::Endpoint::EndpointParameter

 

using EndpointParameters = Aws::Endpoint::EndpointParameters

 

Public Types inherited from Aws::AmazonWebServiceRequest

typedef Aws::Vector< Aws::Endpoint::EndpointParameter > EndpointParameters

 

Protected Attributes inherited from Aws::AmazonWebServiceRequest

Aws::Http::HeaderValueCollection m_additionalCustomHeaders

 

Detailed Description

Definition at line 20 of file StopInstancesRequest.h.

Constructor & Destructor Documentation

StopInstancesRequest()

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

default

Member Function Documentation

AddInstanceIds()

template<typename InstanceIdsT = Aws::String>

StopInstancesRequest & Aws::EC2::Model::StopInstancesRequest::AddInstanceIds ( InstanceIdsT &&  value)

inline

The IDs of the instances.

Definition at line 53 of file StopInstancesRequest.h.

DryRunHasBeenSet()

bool Aws::EC2::Model::StopInstancesRequest::DryRunHasBeenSet ( ) const

inline

Checks whether you have the required permissions for the operation, 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 109 of file StopInstancesRequest.h.

DumpBodyToUrl()

AWS_EC2_API void Aws::EC2::Model::StopInstancesRequest::DumpBodyToUrl ( Aws::Http::URI &  uri) const

overrideprotectedvirtual

Reimplemented from Aws::AmazonWebServiceRequest.

ForceHasBeenSet()

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

inline

Forces the instance to stop. The instance will first attempt a graceful shutdown, which includes flushing file system caches and metadata. If the graceful shutdown fails to complete within the timeout period, the instance shuts down forcibly without flushing the file system caches and metadata.

After using this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances. For more information, see Troubleshoot Amazon EC2 instance stop issues in the Amazon EC2 User Guide.

Default: false

Definition at line 134 of file StopInstancesRequest.h.

GetDryRun()

bool Aws::EC2::Model::StopInstancesRequest::GetDryRun ( ) const

inline

Checks whether you have the required permissions for the operation, 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 108 of file StopInstancesRequest.h.

GetForce()

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

inline

Forces the instance to stop. The instance will first attempt a graceful shutdown, which includes flushing file system caches and metadata. If the graceful shutdown fails to complete within the timeout period, the instance shuts down forcibly without flushing the file system caches and metadata.

After using this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances. For more information, see Troubleshoot Amazon EC2 instance stop issues in the Amazon EC2 User Guide.

Default: false

Definition at line 133 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 Amazon EC2 instance in the Amazon EC2 User Guide.

Default: false

Definition at line 69 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 40 of file StopInstancesRequest.h.

GetServiceRequestName()

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

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 28 of file StopInstancesRequest.h.

GetSkipOsShutdown()

bool Aws::EC2::Model::StopInstancesRequest::GetSkipOsShutdown ( ) const

inline

Specifies whether to bypass the graceful OS shutdown process when the instance is stopped.

Bypassing the graceful OS shutdown might result in data loss or corruption (for example, memory contents not flushed to disk or loss of in-flight IOs) or skipped shutdown scripts.

Default: false

Definition at line 89 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 Amazon EC2 instance in the Amazon EC2 User Guide.

Default: false

Definition at line 70 of file StopInstancesRequest.h.

InstanceIdsHasBeenSet()

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

inline

The IDs of the instances.

Definition at line 41 of file StopInstancesRequest.h.

SerializePayload()

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

overridevirtual

Implements Aws::AmazonSerializableWebServiceRequest.

SetDryRun()

void Aws::EC2::Model::StopInstancesRequest::SetDryRun ( bool  value)

inline

Checks whether you have the required permissions for the operation, 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 110 of file StopInstancesRequest.h.

SetForce()

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

inline

Forces the instance to stop. The instance will first attempt a graceful shutdown, which includes flushing file system caches and metadata. If the graceful shutdown fails to complete within the timeout period, the instance shuts down forcibly without flushing the file system caches and metadata.

After using this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances. For more information, see Troubleshoot Amazon EC2 instance stop issues in the Amazon EC2 User Guide.

Default: false

Definition at line 135 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 Amazon EC2 instance in the Amazon EC2 User Guide.

Default: false

Definition at line 71 of file StopInstancesRequest.h.

SetInstanceIds()

template<typename InstanceIdsT = Aws::Vector<Aws::String>>

void Aws::EC2::Model::StopInstancesRequest::SetInstanceIds ( InstanceIdsT &&  value)

inline

The IDs of the instances.

Definition at line 43 of file StopInstancesRequest.h.

SetSkipOsShutdown()

void Aws::EC2::Model::StopInstancesRequest::SetSkipOsShutdown ( bool  value)

inline

Specifies whether to bypass the graceful OS shutdown process when the instance is stopped.

Bypassing the graceful OS shutdown might result in data loss or corruption (for example, memory contents not flushed to disk or loss of in-flight IOs) or skipped shutdown scripts.

Default: false

Definition at line 91 of file StopInstancesRequest.h.

SkipOsShutdownHasBeenSet()

bool Aws::EC2::Model::StopInstancesRequest::SkipOsShutdownHasBeenSet ( ) const

inline

Specifies whether to bypass the graceful OS shutdown process when the instance is stopped.

Bypassing the graceful OS shutdown might result in data loss or corruption (for example, memory contents not flushed to disk or loss of in-flight IOs) or skipped shutdown scripts.

Default: false

Definition at line 90 of file StopInstancesRequest.h.

WithDryRun()

StopInstancesRequest & Aws::EC2::Model::StopInstancesRequest::WithDryRun ( bool  value)

inline

Checks whether you have the required permissions for the operation, 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 114 of file StopInstancesRequest.h.

WithForce()

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

inline

Forces the instance to stop. The instance will first attempt a graceful shutdown, which includes flushing file system caches and metadata. If the graceful shutdown fails to complete within the timeout period, the instance shuts down forcibly without flushing the file system caches and metadata.

After using this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances. For more information, see Troubleshoot Amazon EC2 instance stop issues in the Amazon EC2 User Guide.

Default: false

Definition at line 139 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 Amazon EC2 instance in the Amazon EC2 User Guide.

Default: false

Definition at line 75 of file StopInstancesRequest.h.

WithInstanceIds()

template<typename InstanceIdsT = Aws::Vector<Aws::String>>

StopInstancesRequest & Aws::EC2::Model::StopInstancesRequest::WithInstanceIds ( InstanceIdsT &&  value)

inline

The IDs of the instances.

Definition at line 48 of file StopInstancesRequest.h.

WithSkipOsShutdown()

StopInstancesRequest & Aws::EC2::Model::StopInstancesRequest::WithSkipOsShutdown ( bool  value)

inline

Specifies whether to bypass the graceful OS shutdown process when the instance is stopped.

Bypassing the graceful OS shutdown might result in data loss or corruption (for example, memory contents not flushed to disk or loss of in-flight IOs) or skipped shutdown scripts.

Default: false

Definition at line 95 of file StopInstancesRequest.h.

---

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

• generated/src/aws-cpp-sdk-ec2/include/aws/ec2/model/StopInstancesRequest.h