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

#include <ModifyVolumeRequest.h>

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

Public Member Functions

 ModifyVolumeRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
bool GetDryRun () const
 
bool DryRunHasBeenSet () const
 
void SetDryRun (bool value)
 
ModifyVolumeRequestWithDryRun (bool value)
 
const Aws::StringGetVolumeId () const
 
bool VolumeIdHasBeenSet () const
 
void SetVolumeId (const Aws::String &value)
 
void SetVolumeId (Aws::String &&value)
 
void SetVolumeId (const char *value)
 
ModifyVolumeRequestWithVolumeId (const Aws::String &value)
 
ModifyVolumeRequestWithVolumeId (Aws::String &&value)
 
ModifyVolumeRequestWithVolumeId (const char *value)
 
int GetSize () const
 
bool SizeHasBeenSet () const
 
void SetSize (int value)
 
ModifyVolumeRequestWithSize (int value)
 
const VolumeTypeGetVolumeType () const
 
bool VolumeTypeHasBeenSet () const
 
void SetVolumeType (const VolumeType &value)
 
void SetVolumeType (VolumeType &&value)
 
ModifyVolumeRequestWithVolumeType (const VolumeType &value)
 
ModifyVolumeRequestWithVolumeType (VolumeType &&value)
 
int GetIops () const
 
bool IopsHasBeenSet () const
 
void SetIops (int value)
 
ModifyVolumeRequestWithIops (int value)
 
int GetThroughput () const
 
bool ThroughputHasBeenSet () const
 
void SetThroughput (int value)
 
ModifyVolumeRequestWithThroughput (int value)
 
bool GetMultiAttachEnabled () const
 
bool MultiAttachEnabledHasBeenSet () const
 
void SetMultiAttachEnabled (bool value)
 
ModifyVolumeRequestWithMultiAttachEnabled (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 22 of file ModifyVolumeRequest.h.

Constructor & Destructor Documentation

◆ ModifyVolumeRequest()

Aws::EC2::Model::ModifyVolumeRequest::ModifyVolumeRequest ( )

Member Function Documentation

◆ DryRunHasBeenSet()

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

◆ DumpBodyToUrl()

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

◆ GetDryRun()

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

◆ GetIops()

int Aws::EC2::Model::ModifyVolumeRequest::GetIops ( ) const
inline

The target IOPS rate of the volume. This parameter is valid only for gp3, io1, and io2 volumes.

The following are the supported values for each volume type:

  • gp3: 3,000-16,000 IOPS

  • io1: 100-64,000 IOPS

  • io2: 100-64,000 IOPS

Default: If no IOPS value is specified, the existing value is retained, unless a volume type is modified that supports different values.

Definition at line 221 of file ModifyVolumeRequest.h.

◆ GetMultiAttachEnabled()

bool Aws::EC2::Model::ModifyVolumeRequest::GetMultiAttachEnabled ( ) const
inline

Specifies whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the volume to up to 16 Nitro-based instances in the same Availability Zone. This parameter is supported with io1 and io2 volumes only. For more information, see Amazon EBS Multi-Attach in the Amazon Elastic Compute Cloud User Guide.

Definition at line 301 of file ModifyVolumeRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 31 of file ModifyVolumeRequest.h.

◆ GetSize()

int Aws::EC2::Model::ModifyVolumeRequest::GetSize ( ) const
inline

The target size of the volume, in GiB. The target volume size must be greater than or equal to the existing size of the volume.

The following are the supported volumes sizes for each volume type:

  • gp2 and gp3: 1-16,384

  • io1 and io2: 4-16,384

  • st1 and sc1: 125-16,384

  • standard: 1-1,024

Default: If no size is specified, the existing size is retained.

Definition at line 124 of file ModifyVolumeRequest.h.

◆ GetThroughput()

int Aws::EC2::Model::ModifyVolumeRequest::GetThroughput ( ) const
inline

The target throughput of the volume, in MiB/s. This parameter is valid only for gp3 volumes. The maximum value is 1,000.

Default: If no throughput value is specified, the existing value is retained.

Valid Range: Minimum value of 125. Maximum value of 1000.

Definition at line 263 of file ModifyVolumeRequest.h.

◆ GetVolumeId()

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

The ID of the volume.

Definition at line 76 of file ModifyVolumeRequest.h.

◆ GetVolumeType()

const VolumeType& Aws::EC2::Model::ModifyVolumeRequest::GetVolumeType ( ) const
inline

The target EBS volume type of the volume. For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide.

Default: If no type is specified, the existing type is retained.

Definition at line 169 of file ModifyVolumeRequest.h.

◆ IopsHasBeenSet()

bool Aws::EC2::Model::ModifyVolumeRequest::IopsHasBeenSet ( ) const
inline

The target IOPS rate of the volume. This parameter is valid only for gp3, io1, and io2 volumes.

The following are the supported values for each volume type:

  • gp3: 3,000-16,000 IOPS

  • io1: 100-64,000 IOPS

  • io2: 100-64,000 IOPS

Default: If no IOPS value is specified, the existing value is retained, unless a volume type is modified that supports different values.

Definition at line 232 of file ModifyVolumeRequest.h.

◆ MultiAttachEnabledHasBeenSet()

bool Aws::EC2::Model::ModifyVolumeRequest::MultiAttachEnabledHasBeenSet ( ) const
inline

Specifies whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the volume to up to 16 Nitro-based instances in the same Availability Zone. This parameter is supported with io1 and io2 volumes only. For more information, see Amazon EBS Multi-Attach in the Amazon Elastic Compute Cloud User Guide.

Definition at line 314 of file ModifyVolumeRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDryRun()

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

◆ SetIops()

void Aws::EC2::Model::ModifyVolumeRequest::SetIops ( int  value)
inline

The target IOPS rate of the volume. This parameter is valid only for gp3, io1, and io2 volumes.

The following are the supported values for each volume type:

  • gp3: 3,000-16,000 IOPS

  • io1: 100-64,000 IOPS

  • io2: 100-64,000 IOPS

Default: If no IOPS value is specified, the existing value is retained, unless a volume type is modified that supports different values.

Definition at line 243 of file ModifyVolumeRequest.h.

◆ SetMultiAttachEnabled()

void Aws::EC2::Model::ModifyVolumeRequest::SetMultiAttachEnabled ( bool  value)
inline

Specifies whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the volume to up to 16 Nitro-based instances in the same Availability Zone. This parameter is supported with io1 and io2 volumes only. For more information, see Amazon EBS Multi-Attach in the Amazon Elastic Compute Cloud User Guide.

Definition at line 327 of file ModifyVolumeRequest.h.

◆ SetSize()

void Aws::EC2::Model::ModifyVolumeRequest::SetSize ( int  value)
inline

The target size of the volume, in GiB. The target volume size must be greater than or equal to the existing size of the volume.

The following are the supported volumes sizes for each volume type:

  • gp2 and gp3: 1-16,384

  • io1 and io2: 4-16,384

  • st1 and sc1: 125-16,384

  • standard: 1-1,024

Default: If no size is specified, the existing size is retained.

Definition at line 148 of file ModifyVolumeRequest.h.

◆ SetThroughput()

void Aws::EC2::Model::ModifyVolumeRequest::SetThroughput ( int  value)
inline

The target throughput of the volume, in MiB/s. This parameter is valid only for gp3 volumes. The maximum value is 1,000.

Default: If no throughput value is specified, the existing value is retained.

Valid Range: Minimum value of 125. Maximum value of 1000.

Definition at line 279 of file ModifyVolumeRequest.h.

◆ SetVolumeId() [1/3]

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

The ID of the volume.

Definition at line 91 of file ModifyVolumeRequest.h.

◆ SetVolumeId() [2/3]

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

The ID of the volume.

Definition at line 86 of file ModifyVolumeRequest.h.

◆ SetVolumeId() [3/3]

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

The ID of the volume.

Definition at line 96 of file ModifyVolumeRequest.h.

◆ SetVolumeType() [1/2]

void Aws::EC2::Model::ModifyVolumeRequest::SetVolumeType ( const VolumeType value)
inline

The target EBS volume type of the volume. For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide.

Default: If no type is specified, the existing type is retained.

Definition at line 185 of file ModifyVolumeRequest.h.

◆ SetVolumeType() [2/2]

void Aws::EC2::Model::ModifyVolumeRequest::SetVolumeType ( VolumeType &&  value)
inline

The target EBS volume type of the volume. For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide.

Default: If no type is specified, the existing type is retained.

Definition at line 193 of file ModifyVolumeRequest.h.

◆ SizeHasBeenSet()

bool Aws::EC2::Model::ModifyVolumeRequest::SizeHasBeenSet ( ) const
inline

The target size of the volume, in GiB. The target volume size must be greater than or equal to the existing size of the volume.

The following are the supported volumes sizes for each volume type:

  • gp2 and gp3: 1-16,384

  • io1 and io2: 4-16,384

  • st1 and sc1: 125-16,384

  • standard: 1-1,024

Default: If no size is specified, the existing size is retained.

Definition at line 136 of file ModifyVolumeRequest.h.

◆ ThroughputHasBeenSet()

bool Aws::EC2::Model::ModifyVolumeRequest::ThroughputHasBeenSet ( ) const
inline

The target throughput of the volume, in MiB/s. This parameter is valid only for gp3 volumes. The maximum value is 1,000.

Default: If no throughput value is specified, the existing value is retained.

Valid Range: Minimum value of 125. Maximum value of 1000.

Definition at line 271 of file ModifyVolumeRequest.h.

◆ VolumeIdHasBeenSet()

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

The ID of the volume.

Definition at line 81 of file ModifyVolumeRequest.h.

◆ VolumeTypeHasBeenSet()

bool Aws::EC2::Model::ModifyVolumeRequest::VolumeTypeHasBeenSet ( ) const
inline

The target EBS volume type of the volume. For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide.

Default: If no type is specified, the existing type is retained.

Definition at line 177 of file ModifyVolumeRequest.h.

◆ WithDryRun()

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

◆ WithIops()

ModifyVolumeRequest& Aws::EC2::Model::ModifyVolumeRequest::WithIops ( int  value)
inline

The target IOPS rate of the volume. This parameter is valid only for gp3, io1, and io2 volumes.

The following are the supported values for each volume type:

  • gp3: 3,000-16,000 IOPS

  • io1: 100-64,000 IOPS

  • io2: 100-64,000 IOPS

Default: If no IOPS value is specified, the existing value is retained, unless a volume type is modified that supports different values.

Definition at line 254 of file ModifyVolumeRequest.h.

◆ WithMultiAttachEnabled()

ModifyVolumeRequest& Aws::EC2::Model::ModifyVolumeRequest::WithMultiAttachEnabled ( bool  value)
inline

Specifies whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the volume to up to 16 Nitro-based instances in the same Availability Zone. This parameter is supported with io1 and io2 volumes only. For more information, see Amazon EBS Multi-Attach in the Amazon Elastic Compute Cloud User Guide.

Definition at line 340 of file ModifyVolumeRequest.h.

◆ WithSize()

ModifyVolumeRequest& Aws::EC2::Model::ModifyVolumeRequest::WithSize ( int  value)
inline

The target size of the volume, in GiB. The target volume size must be greater than or equal to the existing size of the volume.

The following are the supported volumes sizes for each volume type:

  • gp2 and gp3: 1-16,384

  • io1 and io2: 4-16,384

  • st1 and sc1: 125-16,384

  • standard: 1-1,024

Default: If no size is specified, the existing size is retained.

Definition at line 160 of file ModifyVolumeRequest.h.

◆ WithThroughput()

ModifyVolumeRequest& Aws::EC2::Model::ModifyVolumeRequest::WithThroughput ( int  value)
inline

The target throughput of the volume, in MiB/s. This parameter is valid only for gp3 volumes. The maximum value is 1,000.

Default: If no throughput value is specified, the existing value is retained.

Valid Range: Minimum value of 125. Maximum value of 1000.

Definition at line 287 of file ModifyVolumeRequest.h.

◆ WithVolumeId() [1/3]

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

The ID of the volume.

Definition at line 106 of file ModifyVolumeRequest.h.

◆ WithVolumeId() [2/3]

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

The ID of the volume.

Definition at line 101 of file ModifyVolumeRequest.h.

◆ WithVolumeId() [3/3]

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

The ID of the volume.

Definition at line 111 of file ModifyVolumeRequest.h.

◆ WithVolumeType() [1/2]

ModifyVolumeRequest& Aws::EC2::Model::ModifyVolumeRequest::WithVolumeType ( const VolumeType value)
inline

The target EBS volume type of the volume. For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide.

Default: If no type is specified, the existing type is retained.

Definition at line 201 of file ModifyVolumeRequest.h.

◆ WithVolumeType() [2/2]

ModifyVolumeRequest& Aws::EC2::Model::ModifyVolumeRequest::WithVolumeType ( VolumeType &&  value)
inline

The target EBS volume type of the volume. For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide.

Default: If no type is specified, the existing type is retained.

Definition at line 209 of file ModifyVolumeRequest.h.


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