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

#include <DetachVolumeRequest.h>

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

Public Member Functions

 DetachVolumeRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetDevice () const
 
bool DeviceHasBeenSet () const
 
void SetDevice (const Aws::String &value)
 
void SetDevice (Aws::String &&value)
 
void SetDevice (const char *value)
 
DetachVolumeRequestWithDevice (const Aws::String &value)
 
DetachVolumeRequestWithDevice (Aws::String &&value)
 
DetachVolumeRequestWithDevice (const char *value)
 
bool GetForce () const
 
bool ForceHasBeenSet () const
 
void SetForce (bool value)
 
DetachVolumeRequestWithForce (bool value)
 
const Aws::StringGetInstanceId () const
 
bool InstanceIdHasBeenSet () const
 
void SetInstanceId (const Aws::String &value)
 
void SetInstanceId (Aws::String &&value)
 
void SetInstanceId (const char *value)
 
DetachVolumeRequestWithInstanceId (const Aws::String &value)
 
DetachVolumeRequestWithInstanceId (Aws::String &&value)
 
DetachVolumeRequestWithInstanceId (const char *value)
 
const Aws::StringGetVolumeId () const
 
bool VolumeIdHasBeenSet () const
 
void SetVolumeId (const Aws::String &value)
 
void SetVolumeId (Aws::String &&value)
 
void SetVolumeId (const char *value)
 
DetachVolumeRequestWithVolumeId (const Aws::String &value)
 
DetachVolumeRequestWithVolumeId (Aws::String &&value)
 
DetachVolumeRequestWithVolumeId (const char *value)
 
bool GetDryRun () const
 
bool DryRunHasBeenSet () const
 
void SetDryRun (bool value)
 
DetachVolumeRequestWithDryRun (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

Contains the parameters for DetachVolume.

See Also:

AWS API Reference

Definition at line 34 of file DetachVolumeRequest.h.

Constructor & Destructor Documentation

◆ DetachVolumeRequest()

Aws::EC2::Model::DetachVolumeRequest::DetachVolumeRequest ( )

Member Function Documentation

◆ DeviceHasBeenSet()

bool Aws::EC2::Model::DetachVolumeRequest::DeviceHasBeenSet ( ) const
inline

The device name.

Definition at line 60 of file DetachVolumeRequest.h.

◆ DryRunHasBeenSet()

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

◆ DumpBodyToUrl()

void Aws::EC2::Model::DetachVolumeRequest::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::DetachVolumeRequest::ForceHasBeenSet ( ) const
inline

Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance won't 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.

Definition at line 113 of file DetachVolumeRequest.h.

◆ GetDevice()

const Aws::String& Aws::EC2::Model::DetachVolumeRequest::GetDevice ( ) const
inline

The device name.

Definition at line 55 of file DetachVolumeRequest.h.

◆ GetDryRun()

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

◆ GetForce()

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

Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance won't 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.

Definition at line 102 of file DetachVolumeRequest.h.

◆ GetInstanceId()

const Aws::String& Aws::EC2::Model::DetachVolumeRequest::GetInstanceId ( ) const
inline

The ID of the instance.

Definition at line 141 of file DetachVolumeRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 43 of file DetachVolumeRequest.h.

◆ GetVolumeId()

const Aws::String& Aws::EC2::Model::DetachVolumeRequest::GetVolumeId ( ) const
inline

The ID of the volume.

Definition at line 182 of file DetachVolumeRequest.h.

◆ InstanceIdHasBeenSet()

bool Aws::EC2::Model::DetachVolumeRequest::InstanceIdHasBeenSet ( ) const
inline

The ID of the instance.

Definition at line 146 of file DetachVolumeRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDevice() [1/3]

void Aws::EC2::Model::DetachVolumeRequest::SetDevice ( const Aws::String value)
inline

The device name.

Definition at line 65 of file DetachVolumeRequest.h.

◆ SetDevice() [2/3]

void Aws::EC2::Model::DetachVolumeRequest::SetDevice ( Aws::String &&  value)
inline

The device name.

Definition at line 70 of file DetachVolumeRequest.h.

◆ SetDevice() [3/3]

void Aws::EC2::Model::DetachVolumeRequest::SetDevice ( const char *  value)
inline

The device name.

Definition at line 75 of file DetachVolumeRequest.h.

◆ SetDryRun()

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

◆ SetForce()

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

Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance won't 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.

Definition at line 124 of file DetachVolumeRequest.h.

◆ SetInstanceId() [1/3]

void Aws::EC2::Model::DetachVolumeRequest::SetInstanceId ( const Aws::String value)
inline

The ID of the instance.

Definition at line 151 of file DetachVolumeRequest.h.

◆ SetInstanceId() [2/3]

void Aws::EC2::Model::DetachVolumeRequest::SetInstanceId ( Aws::String &&  value)
inline

The ID of the instance.

Definition at line 156 of file DetachVolumeRequest.h.

◆ SetInstanceId() [3/3]

void Aws::EC2::Model::DetachVolumeRequest::SetInstanceId ( const char *  value)
inline

The ID of the instance.

Definition at line 161 of file DetachVolumeRequest.h.

◆ SetVolumeId() [1/3]

void Aws::EC2::Model::DetachVolumeRequest::SetVolumeId ( const Aws::String value)
inline

The ID of the volume.

Definition at line 192 of file DetachVolumeRequest.h.

◆ SetVolumeId() [2/3]

void Aws::EC2::Model::DetachVolumeRequest::SetVolumeId ( Aws::String &&  value)
inline

The ID of the volume.

Definition at line 197 of file DetachVolumeRequest.h.

◆ SetVolumeId() [3/3]

void Aws::EC2::Model::DetachVolumeRequest::SetVolumeId ( const char *  value)
inline

The ID of the volume.

Definition at line 202 of file DetachVolumeRequest.h.

◆ VolumeIdHasBeenSet()

bool Aws::EC2::Model::DetachVolumeRequest::VolumeIdHasBeenSet ( ) const
inline

The ID of the volume.

Definition at line 187 of file DetachVolumeRequest.h.

◆ WithDevice() [1/3]

DetachVolumeRequest& Aws::EC2::Model::DetachVolumeRequest::WithDevice ( const Aws::String value)
inline

The device name.

Definition at line 80 of file DetachVolumeRequest.h.

◆ WithDevice() [2/3]

DetachVolumeRequest& Aws::EC2::Model::DetachVolumeRequest::WithDevice ( Aws::String &&  value)
inline

The device name.

Definition at line 85 of file DetachVolumeRequest.h.

◆ WithDevice() [3/3]

DetachVolumeRequest& Aws::EC2::Model::DetachVolumeRequest::WithDevice ( const char *  value)
inline

The device name.

Definition at line 90 of file DetachVolumeRequest.h.

◆ WithDryRun()

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

◆ WithForce()

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

Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance won't 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.

Definition at line 135 of file DetachVolumeRequest.h.

◆ WithInstanceId() [1/3]

DetachVolumeRequest& Aws::EC2::Model::DetachVolumeRequest::WithInstanceId ( const Aws::String value)
inline

The ID of the instance.

Definition at line 166 of file DetachVolumeRequest.h.

◆ WithInstanceId() [2/3]

DetachVolumeRequest& Aws::EC2::Model::DetachVolumeRequest::WithInstanceId ( Aws::String &&  value)
inline

The ID of the instance.

Definition at line 171 of file DetachVolumeRequest.h.

◆ WithInstanceId() [3/3]

DetachVolumeRequest& Aws::EC2::Model::DetachVolumeRequest::WithInstanceId ( const char *  value)
inline

The ID of the instance.

Definition at line 176 of file DetachVolumeRequest.h.

◆ WithVolumeId() [1/3]

DetachVolumeRequest& Aws::EC2::Model::DetachVolumeRequest::WithVolumeId ( const Aws::String value)
inline

The ID of the volume.

Definition at line 207 of file DetachVolumeRequest.h.

◆ WithVolumeId() [2/3]

DetachVolumeRequest& Aws::EC2::Model::DetachVolumeRequest::WithVolumeId ( Aws::String &&  value)
inline

The ID of the volume.

Definition at line 212 of file DetachVolumeRequest.h.

◆ WithVolumeId() [3/3]

DetachVolumeRequest& Aws::EC2::Model::DetachVolumeRequest::WithVolumeId ( const char *  value)
inline

The ID of the volume.

Definition at line 217 of file DetachVolumeRequest.h.


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