AWS SDK for C++  1.9.73
AWS SDK for C++
Public Member Functions | List of all members
Aws::AutoScaling::Model::Ebs Class Reference

#include <Ebs.h>

Public Member Functions

 Ebs ()
 
 Ebs (const Aws::Utils::Xml::XmlNode &xmlNode)
 
Ebsoperator= (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
 
const Aws::StringGetSnapshotId () const
 
bool SnapshotIdHasBeenSet () const
 
void SetSnapshotId (const Aws::String &value)
 
void SetSnapshotId (Aws::String &&value)
 
void SetSnapshotId (const char *value)
 
EbsWithSnapshotId (const Aws::String &value)
 
EbsWithSnapshotId (Aws::String &&value)
 
EbsWithSnapshotId (const char *value)
 
int GetVolumeSize () const
 
bool VolumeSizeHasBeenSet () const
 
void SetVolumeSize (int value)
 
EbsWithVolumeSize (int value)
 
const Aws::StringGetVolumeType () const
 
bool VolumeTypeHasBeenSet () const
 
void SetVolumeType (const Aws::String &value)
 
void SetVolumeType (Aws::String &&value)
 
void SetVolumeType (const char *value)
 
EbsWithVolumeType (const Aws::String &value)
 
EbsWithVolumeType (Aws::String &&value)
 
EbsWithVolumeType (const char *value)
 
bool GetDeleteOnTermination () const
 
bool DeleteOnTerminationHasBeenSet () const
 
void SetDeleteOnTermination (bool value)
 
EbsWithDeleteOnTermination (bool value)
 
int GetIops () const
 
bool IopsHasBeenSet () const
 
void SetIops (int value)
 
EbsWithIops (int value)
 
bool GetEncrypted () const
 
bool EncryptedHasBeenSet () const
 
void SetEncrypted (bool value)
 
EbsWithEncrypted (bool value)
 
int GetThroughput () const
 
bool ThroughputHasBeenSet () const
 
void SetThroughput (int value)
 
EbsWithThroughput (int value)
 

Detailed Description

Describes information used to set up an Amazon EBS volume specified in a block device mapping.

See Also:

AWS API Reference

Definition at line 32 of file Ebs.h.

Constructor & Destructor Documentation

◆ Ebs() [1/2]

Aws::AutoScaling::Model::Ebs::Ebs ( )

◆ Ebs() [2/2]

Aws::AutoScaling::Model::Ebs::Ebs ( const Aws::Utils::Xml::XmlNode xmlNode)

Member Function Documentation

◆ DeleteOnTerminationHasBeenSet()

bool Aws::AutoScaling::Model::Ebs::DeleteOnTerminationHasBeenSet ( ) const
inline

Indicates whether the volume is deleted on instance termination. For Amazon EC2 Auto Scaling, the default value is true.

Definition at line 224 of file Ebs.h.

◆ EncryptedHasBeenSet()

bool Aws::AutoScaling::Model::Ebs::EncryptedHasBeenSet ( ) const
inline

Specifies whether the volume should be encrypted. Encrypted EBS volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported Instance Types. If your AMI uses encrypted volumes, you can also only launch it on supported instance types.

If you are creating a volume from a snapshot, you cannot specify an encryption value. Volumes that are created from encrypted snapshots are automatically encrypted, and volumes that are created from unencrypted snapshots are automatically unencrypted. By default, encrypted snapshots use the Amazon Web Services managed CMK that is used for EBS encryption, but you can specify a custom CMK when you create the snapshot. The ability to encrypt a snapshot during copying also allows you to apply a new CMK to an already-encrypted snapshot. Volumes restored from the resulting copy are only accessible using the new CMK.

Enabling encryption by default results in all EBS volumes being encrypted with the Amazon Web Services managed CMK or a customer managed CMK, whether or not the snapshot was encrypted.

For more information, see Using Encryption with EBS-Backed AMIs in the Amazon EC2 User Guide for Linux Instances and Required CMK key policy for use with encrypted volumes in the Amazon EC2 Auto Scaling User Guide.

Definition at line 370 of file Ebs.h.

◆ GetDeleteOnTermination()

bool Aws::AutoScaling::Model::Ebs::GetDeleteOnTermination ( ) const
inline

Indicates whether the volume is deleted on instance termination. For Amazon EC2 Auto Scaling, the default value is true.

Definition at line 218 of file Ebs.h.

◆ GetEncrypted()

bool Aws::AutoScaling::Model::Ebs::GetEncrypted ( ) const
inline

Specifies whether the volume should be encrypted. Encrypted EBS volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported Instance Types. If your AMI uses encrypted volumes, you can also only launch it on supported instance types.

If you are creating a volume from a snapshot, you cannot specify an encryption value. Volumes that are created from encrypted snapshots are automatically encrypted, and volumes that are created from unencrypted snapshots are automatically unencrypted. By default, encrypted snapshots use the Amazon Web Services managed CMK that is used for EBS encryption, but you can specify a custom CMK when you create the snapshot. The ability to encrypt a snapshot during copying also allows you to apply a new CMK to an already-encrypted snapshot. Volumes restored from the resulting copy are only accessible using the new CMK.

Enabling encryption by default results in all EBS volumes being encrypted with the Amazon Web Services managed CMK or a customer managed CMK, whether or not the snapshot was encrypted.

For more information, see Using Encryption with EBS-Backed AMIs in the Amazon EC2 User Guide for Linux Instances and Required CMK key policy for use with encrypted volumes in the Amazon EC2 Auto Scaling User Guide.

Definition at line 342 of file Ebs.h.

◆ GetIops()

int Aws::AutoScaling::Model::Ebs::GetIops ( ) const
inline

The number of input/output (I/O) operations per second (IOPS) to provision for the volume. For gp3 and io1 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

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

Iops is supported when the volume type is gp3 or io1 and required only when the volume type is io1. (Not used with standard, gp2, st1, or sc1 volumes.)

Definition at line 256 of file Ebs.h.

◆ GetSnapshotId()

const Aws::String& Aws::AutoScaling::Model::Ebs::GetSnapshotId ( ) const
inline

The snapshot ID of the volume to use.

You must specify either a VolumeSize or a SnapshotId.

Definition at line 47 of file Ebs.h.

◆ GetThroughput()

int Aws::AutoScaling::Model::Ebs::GetThroughput ( ) const
inline

The throughput (MiBps) to provision for a gp3 volume.

Definition at line 432 of file Ebs.h.

◆ GetVolumeSize()

int Aws::AutoScaling::Model::Ebs::GetVolumeSize ( ) const
inline

The volume size, in GiBs. The following are the supported volumes sizes for each volume type:

  • gp2 and gp3: 1-16,384

  • io1: 4-16,384

  • st1 and sc1: 125-16,384

  • standard: 1-1,024

You must specify either a SnapshotId or a VolumeSize. If you specify both SnapshotId and VolumeSize, the volume size must be equal or greater than the size of the snapshot.

Definition at line 102 of file Ebs.h.

◆ GetVolumeType()

const Aws::String& Aws::AutoScaling::Model::Ebs::GetVolumeType ( ) const
inline

The volume type. For more information, see Amazon EBS Volume Types in the Amazon EC2 User Guide for Linux Instances.

Valid Values: standard | io1 | gp2 | st1 | sc1 | gp3

Definition at line 148 of file Ebs.h.

◆ IopsHasBeenSet()

bool Aws::AutoScaling::Model::Ebs::IopsHasBeenSet ( ) const
inline

The number of input/output (I/O) operations per second (IOPS) to provision for the volume. For gp3 and io1 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

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

Iops is supported when the volume type is gp3 or io1 and required only when the volume type is io1. (Not used with standard, gp2, st1, or sc1 volumes.)

Definition at line 275 of file Ebs.h.

◆ operator=()

Ebs& Aws::AutoScaling::Model::Ebs::operator= ( const Aws::Utils::Xml::XmlNode xmlNode)

◆ OutputToStream() [1/2]

void Aws::AutoScaling::Model::Ebs::OutputToStream ( Aws::OStream oStream,
const char *  location 
) const

◆ OutputToStream() [2/2]

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

◆ SetDeleteOnTermination()

void Aws::AutoScaling::Model::Ebs::SetDeleteOnTermination ( bool  value)
inline

Indicates whether the volume is deleted on instance termination. For Amazon EC2 Auto Scaling, the default value is true.

Definition at line 230 of file Ebs.h.

◆ SetEncrypted()

void Aws::AutoScaling::Model::Ebs::SetEncrypted ( bool  value)
inline

Specifies whether the volume should be encrypted. Encrypted EBS volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported Instance Types. If your AMI uses encrypted volumes, you can also only launch it on supported instance types.

If you are creating a volume from a snapshot, you cannot specify an encryption value. Volumes that are created from encrypted snapshots are automatically encrypted, and volumes that are created from unencrypted snapshots are automatically unencrypted. By default, encrypted snapshots use the Amazon Web Services managed CMK that is used for EBS encryption, but you can specify a custom CMK when you create the snapshot. The ability to encrypt a snapshot during copying also allows you to apply a new CMK to an already-encrypted snapshot. Volumes restored from the resulting copy are only accessible using the new CMK.

Enabling encryption by default results in all EBS volumes being encrypted with the Amazon Web Services managed CMK or a customer managed CMK, whether or not the snapshot was encrypted.

For more information, see Using Encryption with EBS-Backed AMIs in the Amazon EC2 User Guide for Linux Instances and Required CMK key policy for use with encrypted volumes in the Amazon EC2 Auto Scaling User Guide.

Definition at line 398 of file Ebs.h.

◆ SetIops()

void Aws::AutoScaling::Model::Ebs::SetIops ( int  value)
inline

The number of input/output (I/O) operations per second (IOPS) to provision for the volume. For gp3 and io1 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

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

Iops is supported when the volume type is gp3 or io1 and required only when the volume type is io1. (Not used with standard, gp2, st1, or sc1 volumes.)

Definition at line 294 of file Ebs.h.

◆ SetSnapshotId() [1/3]

void Aws::AutoScaling::Model::Ebs::SetSnapshotId ( Aws::String &&  value)
inline

The snapshot ID of the volume to use.

You must specify either a VolumeSize or a SnapshotId.

Definition at line 65 of file Ebs.h.

◆ SetSnapshotId() [2/3]

void Aws::AutoScaling::Model::Ebs::SetSnapshotId ( const Aws::String value)
inline

The snapshot ID of the volume to use.

You must specify either a VolumeSize or a SnapshotId.

Definition at line 59 of file Ebs.h.

◆ SetSnapshotId() [3/3]

void Aws::AutoScaling::Model::Ebs::SetSnapshotId ( const char *  value)
inline

The snapshot ID of the volume to use.

You must specify either a VolumeSize or a SnapshotId.

Definition at line 71 of file Ebs.h.

◆ SetThroughput()

void Aws::AutoScaling::Model::Ebs::SetThroughput ( int  value)
inline

The throughput (MiBps) to provision for a gp3 volume.

Definition at line 442 of file Ebs.h.

◆ SetVolumeSize()

void Aws::AutoScaling::Model::Ebs::SetVolumeSize ( int  value)
inline

The volume size, in GiBs. The following are the supported volumes sizes for each volume type:

  • gp2 and gp3: 1-16,384

  • io1: 4-16,384

  • st1 and sc1: 125-16,384

  • standard: 1-1,024

You must specify either a SnapshotId or a VolumeSize. If you specify both SnapshotId and VolumeSize, the volume size must be equal or greater than the size of the snapshot.

Definition at line 126 of file Ebs.h.

◆ SetVolumeType() [1/3]

void Aws::AutoScaling::Model::Ebs::SetVolumeType ( Aws::String &&  value)
inline

The volume type. For more information, see Amazon EBS Volume Types in the Amazon EC2 User Guide for Linux Instances.

Valid Values: standard | io1 | gp2 | st1 | sc1 | gp3

Definition at line 175 of file Ebs.h.

◆ SetVolumeType() [2/3]

void Aws::AutoScaling::Model::Ebs::SetVolumeType ( const Aws::String value)
inline

The volume type. For more information, see Amazon EBS Volume Types in the Amazon EC2 User Guide for Linux Instances.

Valid Values: standard | io1 | gp2 | st1 | sc1 | gp3

Definition at line 166 of file Ebs.h.

◆ SetVolumeType() [3/3]

void Aws::AutoScaling::Model::Ebs::SetVolumeType ( const char *  value)
inline

The volume type. For more information, see Amazon EBS Volume Types in the Amazon EC2 User Guide for Linux Instances.

Valid Values: standard | io1 | gp2 | st1 | sc1 | gp3

Definition at line 184 of file Ebs.h.

◆ SnapshotIdHasBeenSet()

bool Aws::AutoScaling::Model::Ebs::SnapshotIdHasBeenSet ( ) const
inline

The snapshot ID of the volume to use.

You must specify either a VolumeSize or a SnapshotId.

Definition at line 53 of file Ebs.h.

◆ ThroughputHasBeenSet()

bool Aws::AutoScaling::Model::Ebs::ThroughputHasBeenSet ( ) const
inline

The throughput (MiBps) to provision for a gp3 volume.

Definition at line 437 of file Ebs.h.

◆ VolumeSizeHasBeenSet()

bool Aws::AutoScaling::Model::Ebs::VolumeSizeHasBeenSet ( ) const
inline

The volume size, in GiBs. The following are the supported volumes sizes for each volume type:

  • gp2 and gp3: 1-16,384

  • io1: 4-16,384

  • st1 and sc1: 125-16,384

  • standard: 1-1,024

You must specify either a SnapshotId or a VolumeSize. If you specify both SnapshotId and VolumeSize, the volume size must be equal or greater than the size of the snapshot.

Definition at line 114 of file Ebs.h.

◆ VolumeTypeHasBeenSet()

bool Aws::AutoScaling::Model::Ebs::VolumeTypeHasBeenSet ( ) const
inline

The volume type. For more information, see Amazon EBS Volume Types in the Amazon EC2 User Guide for Linux Instances.

Valid Values: standard | io1 | gp2 | st1 | sc1 | gp3

Definition at line 157 of file Ebs.h.

◆ WithDeleteOnTermination()

Ebs& Aws::AutoScaling::Model::Ebs::WithDeleteOnTermination ( bool  value)
inline

Indicates whether the volume is deleted on instance termination. For Amazon EC2 Auto Scaling, the default value is true.

Definition at line 236 of file Ebs.h.

◆ WithEncrypted()

Ebs& Aws::AutoScaling::Model::Ebs::WithEncrypted ( bool  value)
inline

Specifies whether the volume should be encrypted. Encrypted EBS volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported Instance Types. If your AMI uses encrypted volumes, you can also only launch it on supported instance types.

If you are creating a volume from a snapshot, you cannot specify an encryption value. Volumes that are created from encrypted snapshots are automatically encrypted, and volumes that are created from unencrypted snapshots are automatically unencrypted. By default, encrypted snapshots use the Amazon Web Services managed CMK that is used for EBS encryption, but you can specify a custom CMK when you create the snapshot. The ability to encrypt a snapshot during copying also allows you to apply a new CMK to an already-encrypted snapshot. Volumes restored from the resulting copy are only accessible using the new CMK.

Enabling encryption by default results in all EBS volumes being encrypted with the Amazon Web Services managed CMK or a customer managed CMK, whether or not the snapshot was encrypted.

For more information, see Using Encryption with EBS-Backed AMIs in the Amazon EC2 User Guide for Linux Instances and Required CMK key policy for use with encrypted volumes in the Amazon EC2 Auto Scaling User Guide.

Definition at line 426 of file Ebs.h.

◆ WithIops()

Ebs& Aws::AutoScaling::Model::Ebs::WithIops ( int  value)
inline

The number of input/output (I/O) operations per second (IOPS) to provision for the volume. For gp3 and io1 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

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

Iops is supported when the volume type is gp3 or io1 and required only when the volume type is io1. (Not used with standard, gp2, st1, or sc1 volumes.)

Definition at line 313 of file Ebs.h.

◆ WithSnapshotId() [1/3]

Ebs& Aws::AutoScaling::Model::Ebs::WithSnapshotId ( Aws::String &&  value)
inline

The snapshot ID of the volume to use.

You must specify either a VolumeSize or a SnapshotId.

Definition at line 83 of file Ebs.h.

◆ WithSnapshotId() [2/3]

Ebs& Aws::AutoScaling::Model::Ebs::WithSnapshotId ( const Aws::String value)
inline

The snapshot ID of the volume to use.

You must specify either a VolumeSize or a SnapshotId.

Definition at line 77 of file Ebs.h.

◆ WithSnapshotId() [3/3]

Ebs& Aws::AutoScaling::Model::Ebs::WithSnapshotId ( const char *  value)
inline

The snapshot ID of the volume to use.

You must specify either a VolumeSize or a SnapshotId.

Definition at line 89 of file Ebs.h.

◆ WithThroughput()

Ebs& Aws::AutoScaling::Model::Ebs::WithThroughput ( int  value)
inline

The throughput (MiBps) to provision for a gp3 volume.

Definition at line 447 of file Ebs.h.

◆ WithVolumeSize()

Ebs& Aws::AutoScaling::Model::Ebs::WithVolumeSize ( int  value)
inline

The volume size, in GiBs. The following are the supported volumes sizes for each volume type:

  • gp2 and gp3: 1-16,384

  • io1: 4-16,384

  • st1 and sc1: 125-16,384

  • standard: 1-1,024

You must specify either a SnapshotId or a VolumeSize. If you specify both SnapshotId and VolumeSize, the volume size must be equal or greater than the size of the snapshot.

Definition at line 138 of file Ebs.h.

◆ WithVolumeType() [1/3]

Ebs& Aws::AutoScaling::Model::Ebs::WithVolumeType ( Aws::String &&  value)
inline

The volume type. For more information, see Amazon EBS Volume Types in the Amazon EC2 User Guide for Linux Instances.

Valid Values: standard | io1 | gp2 | st1 | sc1 | gp3

Definition at line 202 of file Ebs.h.

◆ WithVolumeType() [2/3]

Ebs& Aws::AutoScaling::Model::Ebs::WithVolumeType ( const Aws::String value)
inline

The volume type. For more information, see Amazon EBS Volume Types in the Amazon EC2 User Guide for Linux Instances.

Valid Values: standard | io1 | gp2 | st1 | sc1 | gp3

Definition at line 193 of file Ebs.h.

◆ WithVolumeType() [3/3]

Ebs& Aws::AutoScaling::Model::Ebs::WithVolumeType ( const char *  value)
inline

The volume type. For more information, see Amazon EBS Volume Types in the Amazon EC2 User Guide for Linux Instances.

Valid Values: standard | io1 | gp2 | st1 | sc1 | gp3

Definition at line 211 of file Ebs.h.


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