AWS SDK for C++  1.9.106
AWS SDK for C++
Public Member Functions | List of all members
Aws::EC2::Model::LaunchTemplateEbsBlockDeviceRequest Class Reference

#include <LaunchTemplateEbsBlockDeviceRequest.h>

Public Member Functions

 LaunchTemplateEbsBlockDeviceRequest ()
 
 LaunchTemplateEbsBlockDeviceRequest (const Aws::Utils::Xml::XmlNode &xmlNode)
 
LaunchTemplateEbsBlockDeviceRequestoperator= (const Aws::Utils::Xml::XmlNode &xmlNode)
 
void OutputToStream (Aws::OStream &ostream, const char *location, unsigned index, const char *locationValue) const
 
void OutputToStream (Aws::OStream &oStream, const char *location) const
 
bool GetEncrypted () const
 
bool EncryptedHasBeenSet () const
 
void SetEncrypted (bool value)
 
LaunchTemplateEbsBlockDeviceRequestWithEncrypted (bool value)
 
bool GetDeleteOnTermination () const
 
bool DeleteOnTerminationHasBeenSet () const
 
void SetDeleteOnTermination (bool value)
 
LaunchTemplateEbsBlockDeviceRequestWithDeleteOnTermination (bool value)
 
int GetIops () const
 
bool IopsHasBeenSet () const
 
void SetIops (int value)
 
LaunchTemplateEbsBlockDeviceRequestWithIops (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)
 
LaunchTemplateEbsBlockDeviceRequestWithKmsKeyId (const Aws::String &value)
 
LaunchTemplateEbsBlockDeviceRequestWithKmsKeyId (Aws::String &&value)
 
LaunchTemplateEbsBlockDeviceRequestWithKmsKeyId (const char *value)
 
const Aws::StringGetSnapshotId () const
 
bool SnapshotIdHasBeenSet () const
 
void SetSnapshotId (const Aws::String &value)
 
void SetSnapshotId (Aws::String &&value)
 
void SetSnapshotId (const char *value)
 
LaunchTemplateEbsBlockDeviceRequestWithSnapshotId (const Aws::String &value)
 
LaunchTemplateEbsBlockDeviceRequestWithSnapshotId (Aws::String &&value)
 
LaunchTemplateEbsBlockDeviceRequestWithSnapshotId (const char *value)
 
int GetVolumeSize () const
 
bool VolumeSizeHasBeenSet () const
 
void SetVolumeSize (int value)
 
LaunchTemplateEbsBlockDeviceRequestWithVolumeSize (int value)
 
const VolumeTypeGetVolumeType () const
 
bool VolumeTypeHasBeenSet () const
 
void SetVolumeType (const VolumeType &value)
 
void SetVolumeType (VolumeType &&value)
 
LaunchTemplateEbsBlockDeviceRequestWithVolumeType (const VolumeType &value)
 
LaunchTemplateEbsBlockDeviceRequestWithVolumeType (VolumeType &&value)
 
int GetThroughput () const
 
bool ThroughputHasBeenSet () const
 
void SetThroughput (int value)
 
LaunchTemplateEbsBlockDeviceRequestWithThroughput (int value)
 

Detailed Description

The parameters for a block device for an EBS volume.

See Also:

AWS API Reference

Definition at line 33 of file LaunchTemplateEbsBlockDeviceRequest.h.

Constructor & Destructor Documentation

◆ LaunchTemplateEbsBlockDeviceRequest() [1/2]

Aws::EC2::Model::LaunchTemplateEbsBlockDeviceRequest::LaunchTemplateEbsBlockDeviceRequest ( )

◆ LaunchTemplateEbsBlockDeviceRequest() [2/2]

Aws::EC2::Model::LaunchTemplateEbsBlockDeviceRequest::LaunchTemplateEbsBlockDeviceRequest ( const Aws::Utils::Xml::XmlNode xmlNode)

Member Function Documentation

◆ DeleteOnTerminationHasBeenSet()

bool Aws::EC2::Model::LaunchTemplateEbsBlockDeviceRequest::DeleteOnTerminationHasBeenSet ( ) const
inline

Indicates whether the EBS volume is deleted on instance termination.

Definition at line 81 of file LaunchTemplateEbsBlockDeviceRequest.h.

◆ EncryptedHasBeenSet()

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

Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value.

Definition at line 56 of file LaunchTemplateEbsBlockDeviceRequest.h.

◆ GetDeleteOnTermination()

bool Aws::EC2::Model::LaunchTemplateEbsBlockDeviceRequest::GetDeleteOnTermination ( ) const
inline

Indicates whether the EBS volume is deleted on instance termination.

Definition at line 76 of file LaunchTemplateEbsBlockDeviceRequest.h.

◆ GetEncrypted()

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

Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value.

Definition at line 49 of file LaunchTemplateEbsBlockDeviceRequest.h.

◆ GetIops()

int Aws::EC2::Model::LaunchTemplateEbsBlockDeviceRequest::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

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

This parameter is supported for io1, io2, and gp3 volumes only. This parameter is not supported for gp2, st1, sc1, or standard volumes.

Definition at line 112 of file LaunchTemplateEbsBlockDeviceRequest.h.

◆ GetKmsKeyId()

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

The ARN of the symmetric Key Management Service (KMS) CMK used for encryption.

Definition at line 179 of file LaunchTemplateEbsBlockDeviceRequest.h.

◆ GetSnapshotId()

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

The ID of the snapshot.

Definition at line 227 of file LaunchTemplateEbsBlockDeviceRequest.h.

◆ GetThroughput()

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

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

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

Definition at line 354 of file LaunchTemplateEbsBlockDeviceRequest.h.

◆ GetVolumeSize()

int Aws::EC2::Model::LaunchTemplateEbsBlockDeviceRequest::GetVolumeSize ( ) const
inline

The size of the volume, in GiBs. You must specify either a snapshot ID or a volume 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 273 of file LaunchTemplateEbsBlockDeviceRequest.h.

◆ GetVolumeType()

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

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

Definition at line 311 of file LaunchTemplateEbsBlockDeviceRequest.h.

◆ IopsHasBeenSet()

bool Aws::EC2::Model::LaunchTemplateEbsBlockDeviceRequest::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

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

This parameter is supported for io1, io2, and gp3 volumes only. This parameter is not supported for gp2, st1, sc1, or standard volumes.

Definition at line 132 of file LaunchTemplateEbsBlockDeviceRequest.h.

◆ KmsKeyIdHasBeenSet()

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

The ARN of the symmetric Key Management Service (KMS) CMK used for encryption.

Definition at line 185 of file LaunchTemplateEbsBlockDeviceRequest.h.

◆ operator=()

LaunchTemplateEbsBlockDeviceRequest& Aws::EC2::Model::LaunchTemplateEbsBlockDeviceRequest::operator= ( const Aws::Utils::Xml::XmlNode xmlNode)

◆ OutputToStream() [1/2]

void Aws::EC2::Model::LaunchTemplateEbsBlockDeviceRequest::OutputToStream ( Aws::OStream oStream,
const char *  location 
) const

◆ OutputToStream() [2/2]

void Aws::EC2::Model::LaunchTemplateEbsBlockDeviceRequest::OutputToStream ( Aws::OStream ostream,
const char *  location,
unsigned  index,
const char *  locationValue 
) const

◆ SetDeleteOnTermination()

void Aws::EC2::Model::LaunchTemplateEbsBlockDeviceRequest::SetDeleteOnTermination ( bool  value)
inline

Indicates whether the EBS volume is deleted on instance termination.

Definition at line 86 of file LaunchTemplateEbsBlockDeviceRequest.h.

◆ SetEncrypted()

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

Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value.

Definition at line 63 of file LaunchTemplateEbsBlockDeviceRequest.h.

◆ SetIops()

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

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

This parameter is supported for io1, io2, and gp3 volumes only. This parameter is not supported for gp2, st1, sc1, or standard volumes.

Definition at line 152 of file LaunchTemplateEbsBlockDeviceRequest.h.

◆ SetKmsKeyId() [1/3]

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

The ARN of the symmetric Key Management Service (KMS) CMK used for encryption.

Definition at line 197 of file LaunchTemplateEbsBlockDeviceRequest.h.

◆ SetKmsKeyId() [2/3]

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

The ARN of the symmetric Key Management Service (KMS) CMK used for encryption.

Definition at line 191 of file LaunchTemplateEbsBlockDeviceRequest.h.

◆ SetKmsKeyId() [3/3]

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

The ARN of the symmetric Key Management Service (KMS) CMK used for encryption.

Definition at line 203 of file LaunchTemplateEbsBlockDeviceRequest.h.

◆ SetSnapshotId() [1/3]

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

The ID of the snapshot.

Definition at line 242 of file LaunchTemplateEbsBlockDeviceRequest.h.

◆ SetSnapshotId() [2/3]

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

The ID of the snapshot.

Definition at line 237 of file LaunchTemplateEbsBlockDeviceRequest.h.

◆ SetSnapshotId() [3/3]

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

The ID of the snapshot.

Definition at line 247 of file LaunchTemplateEbsBlockDeviceRequest.h.

◆ SetThroughput()

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

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

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

Definition at line 368 of file LaunchTemplateEbsBlockDeviceRequest.h.

◆ SetVolumeSize()

void Aws::EC2::Model::LaunchTemplateEbsBlockDeviceRequest::SetVolumeSize ( int  value)
inline

The size of the volume, in GiBs. You must specify either a snapshot ID or a volume 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 293 of file LaunchTemplateEbsBlockDeviceRequest.h.

◆ SetVolumeType() [1/2]

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

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

Definition at line 325 of file LaunchTemplateEbsBlockDeviceRequest.h.

◆ SetVolumeType() [2/2]

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

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

Definition at line 332 of file LaunchTemplateEbsBlockDeviceRequest.h.

◆ SnapshotIdHasBeenSet()

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

The ID of the snapshot.

Definition at line 232 of file LaunchTemplateEbsBlockDeviceRequest.h.

◆ ThroughputHasBeenSet()

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

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

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

Definition at line 361 of file LaunchTemplateEbsBlockDeviceRequest.h.

◆ VolumeSizeHasBeenSet()

bool Aws::EC2::Model::LaunchTemplateEbsBlockDeviceRequest::VolumeSizeHasBeenSet ( ) const
inline

The size of the volume, in GiBs. You must specify either a snapshot ID or a volume 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 283 of file LaunchTemplateEbsBlockDeviceRequest.h.

◆ VolumeTypeHasBeenSet()

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

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

Definition at line 318 of file LaunchTemplateEbsBlockDeviceRequest.h.

◆ WithDeleteOnTermination()

LaunchTemplateEbsBlockDeviceRequest& Aws::EC2::Model::LaunchTemplateEbsBlockDeviceRequest::WithDeleteOnTermination ( bool  value)
inline

Indicates whether the EBS volume is deleted on instance termination.

Definition at line 91 of file LaunchTemplateEbsBlockDeviceRequest.h.

◆ WithEncrypted()

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

Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value.

Definition at line 70 of file LaunchTemplateEbsBlockDeviceRequest.h.

◆ WithIops()

LaunchTemplateEbsBlockDeviceRequest& Aws::EC2::Model::LaunchTemplateEbsBlockDeviceRequest::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

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

This parameter is supported for io1, io2, and gp3 volumes only. This parameter is not supported for gp2, st1, sc1, or standard volumes.

Definition at line 172 of file LaunchTemplateEbsBlockDeviceRequest.h.

◆ WithKmsKeyId() [1/3]

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

The ARN of the symmetric Key Management Service (KMS) CMK used for encryption.

Definition at line 215 of file LaunchTemplateEbsBlockDeviceRequest.h.

◆ WithKmsKeyId() [2/3]

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

The ARN of the symmetric Key Management Service (KMS) CMK used for encryption.

Definition at line 209 of file LaunchTemplateEbsBlockDeviceRequest.h.

◆ WithKmsKeyId() [3/3]

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

The ARN of the symmetric Key Management Service (KMS) CMK used for encryption.

Definition at line 221 of file LaunchTemplateEbsBlockDeviceRequest.h.

◆ WithSnapshotId() [1/3]

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

The ID of the snapshot.

Definition at line 257 of file LaunchTemplateEbsBlockDeviceRequest.h.

◆ WithSnapshotId() [2/3]

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

The ID of the snapshot.

Definition at line 252 of file LaunchTemplateEbsBlockDeviceRequest.h.

◆ WithSnapshotId() [3/3]

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

The ID of the snapshot.

Definition at line 262 of file LaunchTemplateEbsBlockDeviceRequest.h.

◆ WithThroughput()

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

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

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

Definition at line 375 of file LaunchTemplateEbsBlockDeviceRequest.h.

◆ WithVolumeSize()

LaunchTemplateEbsBlockDeviceRequest& Aws::EC2::Model::LaunchTemplateEbsBlockDeviceRequest::WithVolumeSize ( int  value)
inline

The size of the volume, in GiBs. You must specify either a snapshot ID or a volume 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 303 of file LaunchTemplateEbsBlockDeviceRequest.h.

◆ WithVolumeType() [1/2]

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

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

Definition at line 339 of file LaunchTemplateEbsBlockDeviceRequest.h.

◆ WithVolumeType() [2/2]

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

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

Definition at line 346 of file LaunchTemplateEbsBlockDeviceRequest.h.


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