AWS SDK for C++  1.9.104
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)
 
const Aws::StringGetOutpostArn () const
 
bool OutpostArnHasBeenSet () const
 
void SetOutpostArn (const Aws::String &value)
 
void SetOutpostArn (Aws::String &&value)
 
void SetOutpostArn (const char *value)
 
CreateVolumeRequestWithOutpostArn (const Aws::String &value)
 
CreateVolumeRequestWithOutpostArn (Aws::String &&value)
 
CreateVolumeRequestWithOutpostArn (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)
 
bool GetMultiAttachEnabled () const
 
bool MultiAttachEnabledHasBeenSet () const
 
void SetMultiAttachEnabled (bool value)
 
CreateVolumeRequestWithMultiAttachEnabled (bool value)
 
int GetThroughput () const
 
bool ThroughputHasBeenSet () const
 
void SetThroughput (int value)
 
CreateVolumeRequestWithThroughput (int value)
 
const Aws::StringGetClientToken () const
 
bool ClientTokenHasBeenSet () const
 
void SetClientToken (const Aws::String &value)
 
void SetClientToken (Aws::String &&value)
 
void SetClientToken (const char *value)
 
CreateVolumeRequestWithClientToken (const Aws::String &value)
 
CreateVolumeRequestWithClientToken (Aws::String &&value)
 
CreateVolumeRequestWithClientToken (const char *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 25 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 639 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 644 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 51 of file CreateVolumeRequest.h.

◆ ClientTokenHasBeenSet()

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

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.

Definition at line 743 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 587 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

Indicates 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 110 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 46 of file CreateVolumeRequest.h.

◆ GetClientToken()

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

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.

Definition at line 735 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 579 of file CreateVolumeRequest.h.

◆ GetEncrypted()

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

Indicates 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 96 of file CreateVolumeRequest.h.

◆ GetIops()

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

The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.

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

io1 and io2 volumes support up to 64,000 IOPS only on Instances built on the Nitro System. Other instance families support performance up to 32,000 IOPS.

This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2, st1, sc1, or standard volumes.

Definition at line 158 of file CreateVolumeRequest.h.

◆ GetKmsKeyId()

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

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

You can specify the KMS key using any of the following:

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

  • Key alias. For example, alias/ExampleAlias.

  • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.

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

Amazon Web Services authenticates the KMS key 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 233 of file CreateVolumeRequest.h.

◆ GetMultiAttachEnabled()

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

Indicates whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the volume to up to 16 Instances built on the Nitro System 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 658 of file CreateVolumeRequest.h.

◆ GetOutpostArn()

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

The Amazon Resource Name (ARN) of the Outpost.

Definition at line 358 of file CreateVolumeRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file CreateVolumeRequest.h.

◆ GetSize()

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

The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.

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

Definition at line 406 of file CreateVolumeRequest.h.

◆ GetSnapshotId()

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

The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.

Definition at line 449 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 609 of file CreateVolumeRequest.h.

◆ GetThroughput()

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

The throughput to provision for a volume, with a maximum of 1,000 MiB/s.

This parameter is valid only for gp3 volumes.

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

Definition at line 705 of file CreateVolumeRequest.h.

◆ GetVolumeType()

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

The volume type. This parameter can be one of the following values:

  • General Purpose SSD: gp2 | gp3

  • Provisioned IOPS SSD: io1 | io2

  • Throughput Optimized HDD: st1

  • Cold HDD: sc1

  • Magnetic: standard

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

Default: gp2

Definition at line 505 of file CreateVolumeRequest.h.

◆ IopsHasBeenSet()

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

The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.

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

io1 and io2 volumes support up to 64,000 IOPS only on Instances built on the Nitro System. Other instance families support performance up to 32,000 IOPS.

This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2, st1, sc1, or standard volumes.

Definition at line 177 of file CreateVolumeRequest.h.

◆ KmsKeyIdHasBeenSet()

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

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

You can specify the KMS key using any of the following:

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

  • Key alias. For example, alias/ExampleAlias.

  • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.

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

Amazon Web Services authenticates the KMS key 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 250 of file CreateVolumeRequest.h.

◆ MultiAttachEnabledHasBeenSet()

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

Indicates whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the volume to up to 16 Instances built on the Nitro System 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 671 of file CreateVolumeRequest.h.

◆ OutpostArnHasBeenSet()

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

The Amazon Resource Name (ARN) of the Outpost.

Definition at line 363 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 ( Aws::String &&  value)
inline

The Availability Zone in which to create the volume.

Definition at line 61 of file CreateVolumeRequest.h.

◆ SetAvailabilityZone() [2/3]

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

The Availability Zone in which to create the volume.

Definition at line 56 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 66 of file CreateVolumeRequest.h.

◆ SetClientToken() [1/3]

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

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.

Definition at line 759 of file CreateVolumeRequest.h.

◆ SetClientToken() [2/3]

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

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.

Definition at line 751 of file CreateVolumeRequest.h.

◆ SetClientToken() [3/3]

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

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.

Definition at line 767 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 595 of file CreateVolumeRequest.h.

◆ SetEncrypted()

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

Indicates 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 124 of file CreateVolumeRequest.h.

◆ SetIops()

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

The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.

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

io1 and io2 volumes support up to 64,000 IOPS only on Instances built on the Nitro System. Other instance families support performance up to 32,000 IOPS.

This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2, st1, sc1, or standard volumes.

Definition at line 196 of file CreateVolumeRequest.h.

◆ SetKmsKeyId() [1/3]

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

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

You can specify the KMS key using any of the following:

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

  • Key alias. For example, alias/ExampleAlias.

  • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.

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

Amazon Web Services authenticates the KMS key 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 284 of file CreateVolumeRequest.h.

◆ SetKmsKeyId() [2/3]

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

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

You can specify the KMS key using any of the following:

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

  • Key alias. For example, alias/ExampleAlias.

  • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.

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

Amazon Web Services authenticates the KMS key 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 267 of file CreateVolumeRequest.h.

◆ SetKmsKeyId() [3/3]

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

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

You can specify the KMS key using any of the following:

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

  • Key alias. For example, alias/ExampleAlias.

  • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.

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

Amazon Web Services authenticates the KMS key 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 301 of file CreateVolumeRequest.h.

◆ SetMultiAttachEnabled()

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

Indicates whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the volume to up to 16 Instances built on the Nitro System 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 684 of file CreateVolumeRequest.h.

◆ SetOutpostArn() [1/3]

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

The Amazon Resource Name (ARN) of the Outpost.

Definition at line 373 of file CreateVolumeRequest.h.

◆ SetOutpostArn() [2/3]

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

The Amazon Resource Name (ARN) of the Outpost.

Definition at line 368 of file CreateVolumeRequest.h.

◆ SetOutpostArn() [3/3]

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

The Amazon Resource Name (ARN) of the Outpost.

Definition at line 378 of file CreateVolumeRequest.h.

◆ SetSize()

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

The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.

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

Definition at line 430 of file CreateVolumeRequest.h.

◆ SetSnapshotId() [1/3]

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

The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.

Definition at line 467 of file CreateVolumeRequest.h.

◆ SetSnapshotId() [2/3]

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

The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.

Definition at line 461 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. You must specify either a snapshot ID or a volume size.

Definition at line 473 of file CreateVolumeRequest.h.

◆ SetTagSpecifications() [1/2]

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

The tags to apply to the volume during creation.

Definition at line 624 of file CreateVolumeRequest.h.

◆ SetTagSpecifications() [2/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 619 of file CreateVolumeRequest.h.

◆ SetThroughput()

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

The throughput to provision for a volume, with a maximum of 1,000 MiB/s.

This parameter is valid only for gp3 volumes.

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

Definition at line 719 of file CreateVolumeRequest.h.

◆ SetVolumeType() [1/2]

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

The volume type. This parameter can be one of the following values:

  • General Purpose SSD: gp2 | gp3

  • Provisioned IOPS SSD: io1 | io2

  • Throughput Optimized HDD: st1

  • Cold HDD: sc1

  • Magnetic: standard

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

Default: gp2

Definition at line 531 of file CreateVolumeRequest.h.

◆ SetVolumeType() [2/2]

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

The volume type. This parameter can be one of the following values:

  • General Purpose SSD: gp2 | gp3

  • Provisioned IOPS SSD: io1 | io2

  • Throughput Optimized HDD: st1

  • Cold HDD: sc1

  • Magnetic: standard

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

Default: gp2

Definition at line 544 of file CreateVolumeRequest.h.

◆ SizeHasBeenSet()

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

The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.

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

Definition at line 418 of file CreateVolumeRequest.h.

◆ SnapshotIdHasBeenSet()

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

The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.

Definition at line 455 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 614 of file CreateVolumeRequest.h.

◆ ThroughputHasBeenSet()

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

The throughput to provision for a volume, with a maximum of 1,000 MiB/s.

This parameter is valid only for gp3 volumes.

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

Definition at line 712 of file CreateVolumeRequest.h.

◆ VolumeTypeHasBeenSet()

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

The volume type. This parameter can be one of the following values:

  • General Purpose SSD: gp2 | gp3

  • Provisioned IOPS SSD: io1 | io2

  • Throughput Optimized HDD: st1

  • Cold HDD: sc1

  • Magnetic: standard

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

Default: gp2

Definition at line 518 of file CreateVolumeRequest.h.

◆ WithAvailabilityZone() [1/3]

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

The Availability Zone in which to create the volume.

Definition at line 76 of file CreateVolumeRequest.h.

◆ WithAvailabilityZone() [2/3]

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

The Availability Zone in which to create the volume.

Definition at line 71 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 81 of file CreateVolumeRequest.h.

◆ WithClientToken() [1/3]

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

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.

Definition at line 783 of file CreateVolumeRequest.h.

◆ WithClientToken() [2/3]

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

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.

Definition at line 775 of file CreateVolumeRequest.h.

◆ WithClientToken() [3/3]

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

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.

Definition at line 791 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 603 of file CreateVolumeRequest.h.

◆ WithEncrypted()

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

Indicates 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 138 of file CreateVolumeRequest.h.

◆ WithIops()

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

The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.

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

io1 and io2 volumes support up to 64,000 IOPS only on Instances built on the Nitro System. Other instance families support performance up to 32,000 IOPS.

This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2, st1, sc1, or standard volumes.

Definition at line 215 of file CreateVolumeRequest.h.

◆ WithKmsKeyId() [1/3]

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

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

You can specify the KMS key using any of the following:

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

  • Key alias. For example, alias/ExampleAlias.

  • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.

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

Amazon Web Services authenticates the KMS key 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 335 of file CreateVolumeRequest.h.

◆ WithKmsKeyId() [2/3]

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

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

You can specify the KMS key using any of the following:

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

  • Key alias. For example, alias/ExampleAlias.

  • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.

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

Amazon Web Services authenticates the KMS key 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 318 of file CreateVolumeRequest.h.

◆ WithKmsKeyId() [3/3]

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

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

You can specify the KMS key using any of the following:

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

  • Key alias. For example, alias/ExampleAlias.

  • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.

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

Amazon Web Services authenticates the KMS key 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 352 of file CreateVolumeRequest.h.

◆ WithMultiAttachEnabled()

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

Indicates whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the volume to up to 16 Instances built on the Nitro System 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 697 of file CreateVolumeRequest.h.

◆ WithOutpostArn() [1/3]

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

The Amazon Resource Name (ARN) of the Outpost.

Definition at line 388 of file CreateVolumeRequest.h.

◆ WithOutpostArn() [2/3]

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

The Amazon Resource Name (ARN) of the Outpost.

Definition at line 383 of file CreateVolumeRequest.h.

◆ WithOutpostArn() [3/3]

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

The Amazon Resource Name (ARN) of the Outpost.

Definition at line 393 of file CreateVolumeRequest.h.

◆ WithSize()

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

The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.

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

Definition at line 442 of file CreateVolumeRequest.h.

◆ WithSnapshotId() [1/3]

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

The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.

Definition at line 485 of file CreateVolumeRequest.h.

◆ WithSnapshotId() [2/3]

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

The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.

Definition at line 479 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. You must specify either a snapshot ID or a volume size.

Definition at line 491 of file CreateVolumeRequest.h.

◆ WithTagSpecifications() [1/2]

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

The tags to apply to the volume during creation.

Definition at line 634 of file CreateVolumeRequest.h.

◆ WithTagSpecifications() [2/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 629 of file CreateVolumeRequest.h.

◆ WithThroughput()

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

The throughput to provision for a volume, with a maximum of 1,000 MiB/s.

This parameter is valid only for gp3 volumes.

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

Definition at line 726 of file CreateVolumeRequest.h.

◆ WithVolumeType() [1/2]

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

The volume type. This parameter can be one of the following values:

  • General Purpose SSD: gp2 | gp3

  • Provisioned IOPS SSD: io1 | io2

  • Throughput Optimized HDD: st1

  • Cold HDD: sc1

  • Magnetic: standard

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

Default: gp2

Definition at line 557 of file CreateVolumeRequest.h.

◆ WithVolumeType() [2/2]

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

The volume type. This parameter can be one of the following values:

  • General Purpose SSD: gp2 | gp3

  • Provisioned IOPS SSD: io1 | io2

  • Throughput Optimized HDD: st1

  • Cold HDD: sc1

  • Magnetic: standard

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

Default: gp2

Definition at line 570 of file CreateVolumeRequest.h.


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