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

#include <CreateVolumeRequest.h>

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

Public Member Functions

 CreateVolumeRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetAvailabilityZone () const
 
bool AvailabilityZoneHasBeenSet () const
 
void SetAvailabilityZone (const Aws::String &value)
 
void SetAvailabilityZone (Aws::String &&value)
 
void SetAvailabilityZone (const char *value)
 
CreateVolumeRequestWithAvailabilityZone (const Aws::String &value)
 
CreateVolumeRequestWithAvailabilityZone (Aws::String &&value)
 
CreateVolumeRequestWithAvailabilityZone (const char *value)
 
bool GetEncrypted () const
 
bool EncryptedHasBeenSet () const
 
void SetEncrypted (bool value)
 
CreateVolumeRequestWithEncrypted (bool value)
 
int GetIops () const
 
bool IopsHasBeenSet () const
 
void SetIops (int value)
 
CreateVolumeRequestWithIops (int value)
 
const Aws::StringGetKmsKeyId () const
 
bool KmsKeyIdHasBeenSet () const
 
void SetKmsKeyId (const Aws::String &value)
 
void SetKmsKeyId (Aws::String &&value)
 
void SetKmsKeyId (const char *value)
 
CreateVolumeRequestWithKmsKeyId (const Aws::String &value)
 
CreateVolumeRequestWithKmsKeyId (Aws::String &&value)
 
CreateVolumeRequestWithKmsKeyId (const char *value)
 
int GetSize () const
 
bool SizeHasBeenSet () const
 
void SetSize (int value)
 
CreateVolumeRequestWithSize (int value)
 
const Aws::StringGetSnapshotId () const
 
bool SnapshotIdHasBeenSet () const
 
void SetSnapshotId (const Aws::String &value)
 
void SetSnapshotId (Aws::String &&value)
 
void SetSnapshotId (const char *value)
 
CreateVolumeRequestWithSnapshotId (const Aws::String &value)
 
CreateVolumeRequestWithSnapshotId (Aws::String &&value)
 
CreateVolumeRequestWithSnapshotId (const char *value)
 
const VolumeTypeGetVolumeType () const
 
bool VolumeTypeHasBeenSet () const
 
void SetVolumeType (const VolumeType &value)
 
void SetVolumeType (VolumeType &&value)
 
CreateVolumeRequestWithVolumeType (const VolumeType &value)
 
CreateVolumeRequestWithVolumeType (VolumeType &&value)
 
bool GetDryRun () const
 
bool DryRunHasBeenSet () const
 
void SetDryRun (bool value)
 
CreateVolumeRequestWithDryRun (bool value)
 
const Aws::Vector< TagSpecification > & GetTagSpecifications () const
 
bool TagSpecificationsHasBeenSet () const
 
void SetTagSpecifications (const Aws::Vector< TagSpecification > &value)
 
void SetTagSpecifications (Aws::Vector< TagSpecification > &&value)
 
CreateVolumeRequestWithTagSpecifications (const Aws::Vector< TagSpecification > &value)
 
CreateVolumeRequestWithTagSpecifications (Aws::Vector< TagSpecification > &&value)
 
CreateVolumeRequestAddTagSpecifications (const TagSpecification &value)
 
CreateVolumeRequestAddTagSpecifications (TagSpecification &&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 CreateVolume.

See Also:

AWS API Reference

Definition at line 37 of file CreateVolumeRequest.h.

Constructor & Destructor Documentation

◆ CreateVolumeRequest()

Aws::EC2::Model::CreateVolumeRequest::CreateVolumeRequest ( )

Member Function Documentation

◆ AddTagSpecifications() [1/2]

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

The tags to apply to the volume during creation.

Definition at line 556 of file CreateVolumeRequest.h.

◆ AddTagSpecifications() [2/2]

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

The tags to apply to the volume during creation.

Definition at line 561 of file CreateVolumeRequest.h.

◆ AvailabilityZoneHasBeenSet()

bool Aws::EC2::Model::CreateVolumeRequest::AvailabilityZoneHasBeenSet ( ) const
inline

The Availability Zone in which to create the volume.

Definition at line 63 of file CreateVolumeRequest.h.

◆ DryRunHasBeenSet()

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

◆ DumpBodyToUrl()

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

◆ EncryptedHasBeenSet()

bool Aws::EC2::Model::CreateVolumeRequest::EncryptedHasBeenSet ( ) const
inline

Specifies whether the volume should be encrypted. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Encryption by Default in the Amazon Elastic Compute Cloud User Guide.

Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Supported Instance Types.

Definition at line 122 of file CreateVolumeRequest.h.

◆ GetAvailabilityZone()

const Aws::String& Aws::EC2::Model::CreateVolumeRequest::GetAvailabilityZone ( ) const
inline

The Availability Zone in which to create the volume.

Definition at line 58 of file CreateVolumeRequest.h.

◆ GetDryRun()

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

◆ GetEncrypted()

bool Aws::EC2::Model::CreateVolumeRequest::GetEncrypted ( ) const
inline

Specifies whether the volume should be encrypted. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Encryption by Default in the Amazon Elastic Compute Cloud User Guide.

Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Supported Instance Types.

Definition at line 108 of file CreateVolumeRequest.h.

◆ GetIops()

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

The number of I/O operations per second (IOPS) to provision for the volume, with a maximum ratio of 50 IOPS/GiB. Range is 100 to 64,000 IOPS for volumes in most Regions. Maximum IOPS of 64,000 is guaranteed only on Nitro-based instances. Other instance families guarantee performance up to 32,000 IOPS. For more information, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

This parameter is valid only for Provisioned IOPS SSD (io1) volumes.

Definition at line 164 of file CreateVolumeRequest.h.

◆ GetKmsKeyId()

const Aws::String& Aws::EC2::Model::CreateVolumeRequest::GetKmsKeyId ( ) const
inline

The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is specified, the encrypted state must be true.

You can specify the CMK using any of the following:

  • Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.

  • Key alias. For example, alias/ExampleAlias.

  • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

  • Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.

Definition at line 221 of file CreateVolumeRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 46 of file CreateVolumeRequest.h.

◆ GetSize()

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

The size of the volume, in GiBs.

Constraints: 1-16,384 for gp2, 4-16,384 for io1, 500-16,384 for st1, 500-16,384 for sc1, and 1-1,024 for standard. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

<note>

At least one of Size or SnapshotId is required.

</note>

Definition at line 353 of file CreateVolumeRequest.h.

◆ GetSnapshotId()

const Aws::String& Aws::EC2::Model::CreateVolumeRequest::GetSnapshotId ( ) const
inline

The snapshot from which to create the volume.

<note>

At least one of Size or SnapshotId are required.

</note>

Definition at line 396 of file CreateVolumeRequest.h.

◆ GetTagSpecifications()

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

The tags to apply to the volume during creation.

Definition at line 526 of file CreateVolumeRequest.h.

◆ GetVolumeType()

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

The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

Default: gp2

Definition at line 447 of file CreateVolumeRequest.h.

◆ IopsHasBeenSet()

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

The number of I/O operations per second (IOPS) to provision for the volume, with a maximum ratio of 50 IOPS/GiB. Range is 100 to 64,000 IOPS for volumes in most Regions. Maximum IOPS of 64,000 is guaranteed only on Nitro-based instances. Other instance families guarantee performance up to 32,000 IOPS. For more information, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

This parameter is valid only for Provisioned IOPS SSD (io1) volumes.

Definition at line 177 of file CreateVolumeRequest.h.

◆ KmsKeyIdHasBeenSet()

bool Aws::EC2::Model::CreateVolumeRequest::KmsKeyIdHasBeenSet ( ) const
inline

The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is specified, the encrypted state must be true.

You can specify the CMK using any of the following:

  • Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.

  • Key alias. For example, alias/ExampleAlias.

  • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

  • Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.

Definition at line 238 of file CreateVolumeRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAvailabilityZone() [1/3]

void Aws::EC2::Model::CreateVolumeRequest::SetAvailabilityZone ( const Aws::String value)
inline

The Availability Zone in which to create the volume.

Definition at line 68 of file CreateVolumeRequest.h.

◆ SetAvailabilityZone() [2/3]

void Aws::EC2::Model::CreateVolumeRequest::SetAvailabilityZone ( Aws::String &&  value)
inline

The Availability Zone in which to create the volume.

Definition at line 73 of file CreateVolumeRequest.h.

◆ SetAvailabilityZone() [3/3]

void Aws::EC2::Model::CreateVolumeRequest::SetAvailabilityZone ( const char *  value)
inline

The Availability Zone in which to create the volume.

Definition at line 78 of file CreateVolumeRequest.h.

◆ SetDryRun()

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

◆ SetEncrypted()

void Aws::EC2::Model::CreateVolumeRequest::SetEncrypted ( bool  value)
inline

Specifies whether the volume should be encrypted. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Encryption by Default in the Amazon Elastic Compute Cloud User Guide.

Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Supported Instance Types.

Definition at line 136 of file CreateVolumeRequest.h.

◆ SetIops()

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

The number of I/O operations per second (IOPS) to provision for the volume, with a maximum ratio of 50 IOPS/GiB. Range is 100 to 64,000 IOPS for volumes in most Regions. Maximum IOPS of 64,000 is guaranteed only on Nitro-based instances. Other instance families guarantee performance up to 32,000 IOPS. For more information, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

This parameter is valid only for Provisioned IOPS SSD (io1) volumes.

Definition at line 190 of file CreateVolumeRequest.h.

◆ SetKmsKeyId() [1/3]

void Aws::EC2::Model::CreateVolumeRequest::SetKmsKeyId ( const Aws::String value)
inline

The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is specified, the encrypted state must be true.

You can specify the CMK using any of the following:

  • Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.

  • Key alias. For example, alias/ExampleAlias.

  • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

  • Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.

Definition at line 255 of file CreateVolumeRequest.h.

◆ SetKmsKeyId() [2/3]

void Aws::EC2::Model::CreateVolumeRequest::SetKmsKeyId ( Aws::String &&  value)
inline

The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is specified, the encrypted state must be true.

You can specify the CMK using any of the following:

  • Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.

  • Key alias. For example, alias/ExampleAlias.

  • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

  • Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.

Definition at line 272 of file CreateVolumeRequest.h.

◆ SetKmsKeyId() [3/3]

void Aws::EC2::Model::CreateVolumeRequest::SetKmsKeyId ( const char *  value)
inline

The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is specified, the encrypted state must be true.

You can specify the CMK using any of the following:

  • Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.

  • Key alias. For example, alias/ExampleAlias.

  • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

  • Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.

Definition at line 289 of file CreateVolumeRequest.h.

◆ SetSize()

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

The size of the volume, in GiBs.

Constraints: 1-16,384 for gp2, 4-16,384 for io1, 500-16,384 for st1, 500-16,384 for sc1, and 1-1,024 for standard. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

<note>

At least one of Size or SnapshotId is required.

</note>

Definition at line 377 of file CreateVolumeRequest.h.

◆ SetSnapshotId() [1/3]

void Aws::EC2::Model::CreateVolumeRequest::SetSnapshotId ( const Aws::String value)
inline

The snapshot from which to create the volume.

<note>

At least one of Size or SnapshotId are required.

</note>

Definition at line 408 of file CreateVolumeRequest.h.

◆ SetSnapshotId() [2/3]

void Aws::EC2::Model::CreateVolumeRequest::SetSnapshotId ( Aws::String &&  value)
inline

The snapshot from which to create the volume.

<note>

At least one of Size or SnapshotId are required.

</note>

Definition at line 414 of file CreateVolumeRequest.h.

◆ SetSnapshotId() [3/3]

void Aws::EC2::Model::CreateVolumeRequest::SetSnapshotId ( const char *  value)
inline

The snapshot from which to create the volume.

<note>

At least one of Size or SnapshotId are required.

</note>

Definition at line 420 of file CreateVolumeRequest.h.

◆ SetTagSpecifications() [1/2]

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

The tags to apply to the volume during creation.

Definition at line 536 of file CreateVolumeRequest.h.

◆ SetTagSpecifications() [2/2]

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

The tags to apply to the volume during creation.

Definition at line 541 of file CreateVolumeRequest.h.

◆ SetVolumeType() [1/2]

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

The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

Default: gp2

Definition at line 463 of file CreateVolumeRequest.h.

◆ SetVolumeType() [2/2]

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

The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

Default: gp2

Definition at line 471 of file CreateVolumeRequest.h.

◆ SizeHasBeenSet()

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

The size of the volume, in GiBs.

Constraints: 1-16,384 for gp2, 4-16,384 for io1, 500-16,384 for st1, 500-16,384 for sc1, and 1-1,024 for standard. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

<note>

At least one of Size or SnapshotId is required.

</note>

Definition at line 365 of file CreateVolumeRequest.h.

◆ SnapshotIdHasBeenSet()

bool Aws::EC2::Model::CreateVolumeRequest::SnapshotIdHasBeenSet ( ) const
inline

The snapshot from which to create the volume.

<note>

At least one of Size or SnapshotId are required.

</note>

Definition at line 402 of file CreateVolumeRequest.h.

◆ TagSpecificationsHasBeenSet()

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

The tags to apply to the volume during creation.

Definition at line 531 of file CreateVolumeRequest.h.

◆ VolumeTypeHasBeenSet()

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

The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

Default: gp2

Definition at line 455 of file CreateVolumeRequest.h.

◆ WithAvailabilityZone() [1/3]

CreateVolumeRequest& Aws::EC2::Model::CreateVolumeRequest::WithAvailabilityZone ( const Aws::String value)
inline

The Availability Zone in which to create the volume.

Definition at line 83 of file CreateVolumeRequest.h.

◆ WithAvailabilityZone() [2/3]

CreateVolumeRequest& Aws::EC2::Model::CreateVolumeRequest::WithAvailabilityZone ( Aws::String &&  value)
inline

The Availability Zone in which to create the volume.

Definition at line 88 of file CreateVolumeRequest.h.

◆ WithAvailabilityZone() [3/3]

CreateVolumeRequest& Aws::EC2::Model::CreateVolumeRequest::WithAvailabilityZone ( const char *  value)
inline

The Availability Zone in which to create the volume.

Definition at line 93 of file CreateVolumeRequest.h.

◆ WithDryRun()

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

◆ WithEncrypted()

CreateVolumeRequest& Aws::EC2::Model::CreateVolumeRequest::WithEncrypted ( bool  value)
inline

Specifies whether the volume should be encrypted. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Encryption by Default in the Amazon Elastic Compute Cloud User Guide.

Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Supported Instance Types.

Definition at line 150 of file CreateVolumeRequest.h.

◆ WithIops()

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

The number of I/O operations per second (IOPS) to provision for the volume, with a maximum ratio of 50 IOPS/GiB. Range is 100 to 64,000 IOPS for volumes in most Regions. Maximum IOPS of 64,000 is guaranteed only on Nitro-based instances. Other instance families guarantee performance up to 32,000 IOPS. For more information, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

This parameter is valid only for Provisioned IOPS SSD (io1) volumes.

Definition at line 203 of file CreateVolumeRequest.h.

◆ WithKmsKeyId() [1/3]

CreateVolumeRequest& Aws::EC2::Model::CreateVolumeRequest::WithKmsKeyId ( const Aws::String value)
inline

The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is specified, the encrypted state must be true.

You can specify the CMK using any of the following:

  • Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.

  • Key alias. For example, alias/ExampleAlias.

  • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

  • Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.

Definition at line 306 of file CreateVolumeRequest.h.

◆ WithKmsKeyId() [2/3]

CreateVolumeRequest& Aws::EC2::Model::CreateVolumeRequest::WithKmsKeyId ( Aws::String &&  value)
inline

The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is specified, the encrypted state must be true.

You can specify the CMK using any of the following:

  • Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.

  • Key alias. For example, alias/ExampleAlias.

  • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

  • Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.

Definition at line 323 of file CreateVolumeRequest.h.

◆ WithKmsKeyId() [3/3]

CreateVolumeRequest& Aws::EC2::Model::CreateVolumeRequest::WithKmsKeyId ( const char *  value)
inline

The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is specified, the encrypted state must be true.

You can specify the CMK using any of the following:

  • Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.

  • Key alias. For example, alias/ExampleAlias.

  • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

  • Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.

Definition at line 340 of file CreateVolumeRequest.h.

◆ WithSize()

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

The size of the volume, in GiBs.

Constraints: 1-16,384 for gp2, 4-16,384 for io1, 500-16,384 for st1, 500-16,384 for sc1, and 1-1,024 for standard. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

<note>

At least one of Size or SnapshotId is required.

</note>

Definition at line 389 of file CreateVolumeRequest.h.

◆ WithSnapshotId() [1/3]

CreateVolumeRequest& Aws::EC2::Model::CreateVolumeRequest::WithSnapshotId ( const Aws::String value)
inline

The snapshot from which to create the volume.

<note>

At least one of Size or SnapshotId are required.

</note>

Definition at line 426 of file CreateVolumeRequest.h.

◆ WithSnapshotId() [2/3]

CreateVolumeRequest& Aws::EC2::Model::CreateVolumeRequest::WithSnapshotId ( Aws::String &&  value)
inline

The snapshot from which to create the volume.

<note>

At least one of Size or SnapshotId are required.

</note>

Definition at line 432 of file CreateVolumeRequest.h.

◆ WithSnapshotId() [3/3]

CreateVolumeRequest& Aws::EC2::Model::CreateVolumeRequest::WithSnapshotId ( const char *  value)
inline

The snapshot from which to create the volume.

<note>

At least one of Size or SnapshotId are required.

</note>

Definition at line 438 of file CreateVolumeRequest.h.

◆ WithTagSpecifications() [1/2]

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

The tags to apply to the volume during creation.

Definition at line 546 of file CreateVolumeRequest.h.

◆ WithTagSpecifications() [2/2]

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

The tags to apply to the volume during creation.

Definition at line 551 of file CreateVolumeRequest.h.

◆ WithVolumeType() [1/2]

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

The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

Default: gp2

Definition at line 479 of file CreateVolumeRequest.h.

◆ WithVolumeType() [2/2]

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

The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

Default: gp2

Definition at line 487 of file CreateVolumeRequest.h.


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