/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include namespace Aws { namespace Utils { namespace Xml { class XmlNode; } // namespace Xml } // namespace Utils namespace EC2 { namespace Model { /** *

Describes a block device for an EBS volume.

See Also:

AWS * API Reference

*/ class EbsBlockDevice { public: AWS_EC2_API EbsBlockDevice(); AWS_EC2_API EbsBlockDevice(const Aws::Utils::Xml::XmlNode& xmlNode); AWS_EC2_API EbsBlockDevice& operator=(const Aws::Utils::Xml::XmlNode& xmlNode); AWS_EC2_API void OutputToStream(Aws::OStream& ostream, const char* location, unsigned index, const char* locationValue) const; AWS_EC2_API void OutputToStream(Aws::OStream& oStream, const char* location) const; /** *

Indicates whether the EBS volume is deleted on instance termination. For more * information, see Preserving * Amazon EBS volumes on instance termination in the Amazon EC2 User * Guide.

*/ inline bool GetDeleteOnTermination() const{ return m_deleteOnTermination; } /** *

Indicates whether the EBS volume is deleted on instance termination. For more * information, see Preserving * Amazon EBS volumes on instance termination in the Amazon EC2 User * Guide.

*/ inline bool DeleteOnTerminationHasBeenSet() const { return m_deleteOnTerminationHasBeenSet; } /** *

Indicates whether the EBS volume is deleted on instance termination. For more * information, see Preserving * Amazon EBS volumes on instance termination in the Amazon EC2 User * Guide.

*/ inline void SetDeleteOnTermination(bool value) { m_deleteOnTerminationHasBeenSet = true; m_deleteOnTermination = value; } /** *

Indicates whether the EBS volume is deleted on instance termination. For more * information, see Preserving * Amazon EBS volumes on instance termination in the Amazon EC2 User * Guide.

*/ inline EbsBlockDevice& WithDeleteOnTermination(bool value) { SetDeleteOnTermination(value); return *this;} /** *

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 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.

*/ inline int GetIops() const{ return m_iops; } /** *

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 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.

*/ inline bool IopsHasBeenSet() const { return m_iopsHasBeenSet; } /** *

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 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.

*/ inline void SetIops(int value) { m_iopsHasBeenSet = true; m_iops = value; } /** *

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 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.

*/ inline EbsBlockDevice& WithIops(int value) { SetIops(value); return *this;} /** *

The ID of the snapshot.

*/ inline const Aws::String& GetSnapshotId() const{ return m_snapshotId; } /** *

The ID of the snapshot.

*/ inline bool SnapshotIdHasBeenSet() const { return m_snapshotIdHasBeenSet; } /** *

The ID of the snapshot.

*/ inline void SetSnapshotId(const Aws::String& value) { m_snapshotIdHasBeenSet = true; m_snapshotId = value; } /** *

The ID of the snapshot.

*/ inline void SetSnapshotId(Aws::String&& value) { m_snapshotIdHasBeenSet = true; m_snapshotId = std::move(value); } /** *

The ID of the snapshot.

*/ inline void SetSnapshotId(const char* value) { m_snapshotIdHasBeenSet = true; m_snapshotId.assign(value); } /** *

The ID of the snapshot.

*/ inline EbsBlockDevice& WithSnapshotId(const Aws::String& value) { SetSnapshotId(value); return *this;} /** *

The ID of the snapshot.

*/ inline EbsBlockDevice& WithSnapshotId(Aws::String&& value) { SetSnapshotId(std::move(value)); return *this;} /** *

The ID of the snapshot.

*/ inline EbsBlockDevice& WithSnapshotId(const char* value) { SetSnapshotId(value); return *this;} /** *

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

*/ inline int GetVolumeSize() const{ return m_volumeSize; } /** *

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

*/ inline bool VolumeSizeHasBeenSet() const { return m_volumeSizeHasBeenSet; } /** *

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

*/ inline void SetVolumeSize(int value) { m_volumeSizeHasBeenSet = true; m_volumeSize = value; } /** *

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

*/ inline EbsBlockDevice& WithVolumeSize(int value) { SetVolumeSize(value); return *this;} /** *

The volume type. For more information, see Amazon * EBS volume types in the Amazon EC2 User Guide. If the volume type is * io1 or io2, you must specify the IOPS that the volume * supports.

*/ inline const VolumeType& GetVolumeType() const{ return m_volumeType; } /** *

The volume type. For more information, see Amazon * EBS volume types in the Amazon EC2 User Guide. If the volume type is * io1 or io2, you must specify the IOPS that the volume * supports.

*/ inline bool VolumeTypeHasBeenSet() const { return m_volumeTypeHasBeenSet; } /** *

The volume type. For more information, see Amazon * EBS volume types in the Amazon EC2 User Guide. If the volume type is * io1 or io2, you must specify the IOPS that the volume * supports.

*/ inline void SetVolumeType(const VolumeType& value) { m_volumeTypeHasBeenSet = true; m_volumeType = value; } /** *

The volume type. For more information, see Amazon * EBS volume types in the Amazon EC2 User Guide. If the volume type is * io1 or io2, you must specify the IOPS that the volume * supports.

*/ inline void SetVolumeType(VolumeType&& value) { m_volumeTypeHasBeenSet = true; m_volumeType = std::move(value); } /** *

The volume type. For more information, see Amazon * EBS volume types in the Amazon EC2 User Guide. If the volume type is * io1 or io2, you must specify the IOPS that the volume * supports.

*/ inline EbsBlockDevice& WithVolumeType(const VolumeType& value) { SetVolumeType(value); return *this;} /** *

The volume type. For more information, see Amazon * EBS volume types in the Amazon EC2 User Guide. If the volume type is * io1 or io2, you must specify the IOPS that the volume * supports.

*/ inline EbsBlockDevice& WithVolumeType(VolumeType&& value) { SetVolumeType(std::move(value)); return *this;} /** *

Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed * CMK under which the EBS volume is encrypted.

This parameter is only * supported on BlockDeviceMapping objects called by RunInstances, * RequestSpotFleet, * and RequestSpotInstances.

*/ inline const Aws::String& GetKmsKeyId() const{ return m_kmsKeyId; } /** *

Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed * CMK under which the EBS volume is encrypted.

This parameter is only * supported on BlockDeviceMapping objects called by RunInstances, * RequestSpotFleet, * and RequestSpotInstances.

*/ inline bool KmsKeyIdHasBeenSet() const { return m_kmsKeyIdHasBeenSet; } /** *

Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed * CMK under which the EBS volume is encrypted.

This parameter is only * supported on BlockDeviceMapping objects called by RunInstances, * RequestSpotFleet, * and RequestSpotInstances.

*/ inline void SetKmsKeyId(const Aws::String& value) { m_kmsKeyIdHasBeenSet = true; m_kmsKeyId = value; } /** *

Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed * CMK under which the EBS volume is encrypted.

This parameter is only * supported on BlockDeviceMapping objects called by RunInstances, * RequestSpotFleet, * and RequestSpotInstances.

*/ inline void SetKmsKeyId(Aws::String&& value) { m_kmsKeyIdHasBeenSet = true; m_kmsKeyId = std::move(value); } /** *

Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed * CMK under which the EBS volume is encrypted.

This parameter is only * supported on BlockDeviceMapping objects called by RunInstances, * RequestSpotFleet, * and RequestSpotInstances.

*/ inline void SetKmsKeyId(const char* value) { m_kmsKeyIdHasBeenSet = true; m_kmsKeyId.assign(value); } /** *

Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed * CMK under which the EBS volume is encrypted.

This parameter is only * supported on BlockDeviceMapping objects called by RunInstances, * RequestSpotFleet, * and RequestSpotInstances.

*/ inline EbsBlockDevice& WithKmsKeyId(const Aws::String& value) { SetKmsKeyId(value); return *this;} /** *

Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed * CMK under which the EBS volume is encrypted.

This parameter is only * supported on BlockDeviceMapping objects called by RunInstances, * RequestSpotFleet, * and RequestSpotInstances.

*/ inline EbsBlockDevice& WithKmsKeyId(Aws::String&& value) { SetKmsKeyId(std::move(value)); return *this;} /** *

Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed * CMK under which the EBS volume is encrypted.

This parameter is only * supported on BlockDeviceMapping objects called by RunInstances, * RequestSpotFleet, * and RequestSpotInstances.

*/ inline EbsBlockDevice& WithKmsKeyId(const char* value) { SetKmsKeyId(value); return *this;} /** *

The throughput that the volume supports, in MiB/s.

This parameter is * valid only for gp3 volumes.

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

*/ inline int GetThroughput() const{ return m_throughput; } /** *

The throughput that the volume supports, in MiB/s.

This parameter is * valid only for gp3 volumes.

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

*/ inline bool ThroughputHasBeenSet() const { return m_throughputHasBeenSet; } /** *

The throughput that the volume supports, in MiB/s.

This parameter is * valid only for gp3 volumes.

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

*/ inline void SetThroughput(int value) { m_throughputHasBeenSet = true; m_throughput = value; } /** *

The throughput that the volume supports, in MiB/s.

This parameter is * valid only for gp3 volumes.

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

*/ inline EbsBlockDevice& WithThroughput(int value) { SetThroughput(value); return *this;} /** *

The ARN of the Outpost on which the snapshot is stored.

This parameter * is only supported on BlockDeviceMapping objects called by * CreateImage.

*/ inline const Aws::String& GetOutpostArn() const{ return m_outpostArn; } /** *

The ARN of the Outpost on which the snapshot is stored.

This parameter * is only supported on BlockDeviceMapping objects called by * CreateImage.

*/ inline bool OutpostArnHasBeenSet() const { return m_outpostArnHasBeenSet; } /** *

The ARN of the Outpost on which the snapshot is stored.

This parameter * is only supported on BlockDeviceMapping objects called by * CreateImage.

*/ inline void SetOutpostArn(const Aws::String& value) { m_outpostArnHasBeenSet = true; m_outpostArn = value; } /** *

The ARN of the Outpost on which the snapshot is stored.

This parameter * is only supported on BlockDeviceMapping objects called by * CreateImage.

*/ inline void SetOutpostArn(Aws::String&& value) { m_outpostArnHasBeenSet = true; m_outpostArn = std::move(value); } /** *

The ARN of the Outpost on which the snapshot is stored.

This parameter * is only supported on BlockDeviceMapping objects called by * CreateImage.

*/ inline void SetOutpostArn(const char* value) { m_outpostArnHasBeenSet = true; m_outpostArn.assign(value); } /** *

The ARN of the Outpost on which the snapshot is stored.

This parameter * is only supported on BlockDeviceMapping objects called by * CreateImage.

*/ inline EbsBlockDevice& WithOutpostArn(const Aws::String& value) { SetOutpostArn(value); return *this;} /** *

The ARN of the Outpost on which the snapshot is stored.

This parameter * is only supported on BlockDeviceMapping objects called by * CreateImage.

*/ inline EbsBlockDevice& WithOutpostArn(Aws::String&& value) { SetOutpostArn(std::move(value)); return *this;} /** *

The ARN of the Outpost on which the snapshot is stored.

This parameter * is only supported on BlockDeviceMapping objects called by * CreateImage.

*/ inline EbsBlockDevice& WithOutpostArn(const char* value) { SetOutpostArn(value); return *this;} /** *

Indicates whether the encryption state of an EBS volume is changed while * being restored from a backing snapshot. 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 Amazon * EBS encryption in the Amazon EC2 User Guide.

In no case can * you remove encryption from an encrypted volume.

Encrypted volumes can * only be attached to instances that support Amazon EBS encryption. For more * information, see Supported * instance types.

This parameter is not returned by * DescribeImageAttribute.

For CreateImage and * RegisterImage, whether you can include this parameter, and the allowed * values differ depending on the type of block device mapping you are * creating.

  • If you are creating a block device mapping for a * new (empty) volume, you can include this parameter, and specify either * true for an encrypted volume, or false for an * unencrypted volume. If you omit this parameter, it defaults to * false (unencrypted).

  • If you are creating a block * device mapping from an existing encrypted or unencrypted snapshot, you * must omit this parameter. If you include this parameter, the request will fail, * regardless of the value that you specify.

  • If you are creating * a block device mapping from an existing unencrypted volume, you can * include this parameter, but you must specify false. If you specify * true, the request will fail. In this case, we recommend that you * omit the parameter.

  • If you are creating a block device mapping * from an existing encrypted volume, you can include this parameter, and * specify either true or false. However, if you specify * false, the parameter is ignored and the block device mapping is * always encrypted. In this case, we recommend that you omit the parameter.

    *
*/ inline bool GetEncrypted() const{ return m_encrypted; } /** *

Indicates whether the encryption state of an EBS volume is changed while * being restored from a backing snapshot. 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 Amazon * EBS encryption in the Amazon EC2 User Guide.

In no case can * you remove encryption from an encrypted volume.

Encrypted volumes can * only be attached to instances that support Amazon EBS encryption. For more * information, see Supported * instance types.

This parameter is not returned by * DescribeImageAttribute.

For CreateImage and * RegisterImage, whether you can include this parameter, and the allowed * values differ depending on the type of block device mapping you are * creating.

  • If you are creating a block device mapping for a * new (empty) volume, you can include this parameter, and specify either * true for an encrypted volume, or false for an * unencrypted volume. If you omit this parameter, it defaults to * false (unencrypted).

  • If you are creating a block * device mapping from an existing encrypted or unencrypted snapshot, you * must omit this parameter. If you include this parameter, the request will fail, * regardless of the value that you specify.

  • If you are creating * a block device mapping from an existing unencrypted volume, you can * include this parameter, but you must specify false. If you specify * true, the request will fail. In this case, we recommend that you * omit the parameter.

  • If you are creating a block device mapping * from an existing encrypted volume, you can include this parameter, and * specify either true or false. However, if you specify * false, the parameter is ignored and the block device mapping is * always encrypted. In this case, we recommend that you omit the parameter.

    *
*/ inline bool EncryptedHasBeenSet() const { return m_encryptedHasBeenSet; } /** *

Indicates whether the encryption state of an EBS volume is changed while * being restored from a backing snapshot. 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 Amazon * EBS encryption in the Amazon EC2 User Guide.

In no case can * you remove encryption from an encrypted volume.

Encrypted volumes can * only be attached to instances that support Amazon EBS encryption. For more * information, see Supported * instance types.

This parameter is not returned by * DescribeImageAttribute.

For CreateImage and * RegisterImage, whether you can include this parameter, and the allowed * values differ depending on the type of block device mapping you are * creating.

  • If you are creating a block device mapping for a * new (empty) volume, you can include this parameter, and specify either * true for an encrypted volume, or false for an * unencrypted volume. If you omit this parameter, it defaults to * false (unencrypted).

  • If you are creating a block * device mapping from an existing encrypted or unencrypted snapshot, you * must omit this parameter. If you include this parameter, the request will fail, * regardless of the value that you specify.

  • If you are creating * a block device mapping from an existing unencrypted volume, you can * include this parameter, but you must specify false. If you specify * true, the request will fail. In this case, we recommend that you * omit the parameter.

  • If you are creating a block device mapping * from an existing encrypted volume, you can include this parameter, and * specify either true or false. However, if you specify * false, the parameter is ignored and the block device mapping is * always encrypted. In this case, we recommend that you omit the parameter.

    *
*/ inline void SetEncrypted(bool value) { m_encryptedHasBeenSet = true; m_encrypted = value; } /** *

Indicates whether the encryption state of an EBS volume is changed while * being restored from a backing snapshot. 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 Amazon * EBS encryption in the Amazon EC2 User Guide.

In no case can * you remove encryption from an encrypted volume.

Encrypted volumes can * only be attached to instances that support Amazon EBS encryption. For more * information, see Supported * instance types.

This parameter is not returned by * DescribeImageAttribute.

For CreateImage and * RegisterImage, whether you can include this parameter, and the allowed * values differ depending on the type of block device mapping you are * creating.

  • If you are creating a block device mapping for a * new (empty) volume, you can include this parameter, and specify either * true for an encrypted volume, or false for an * unencrypted volume. If you omit this parameter, it defaults to * false (unencrypted).

  • If you are creating a block * device mapping from an existing encrypted or unencrypted snapshot, you * must omit this parameter. If you include this parameter, the request will fail, * regardless of the value that you specify.

  • If you are creating * a block device mapping from an existing unencrypted volume, you can * include this parameter, but you must specify false. If you specify * true, the request will fail. In this case, we recommend that you * omit the parameter.

  • If you are creating a block device mapping * from an existing encrypted volume, you can include this parameter, and * specify either true or false. However, if you specify * false, the parameter is ignored and the block device mapping is * always encrypted. In this case, we recommend that you omit the parameter.

    *
*/ inline EbsBlockDevice& WithEncrypted(bool value) { SetEncrypted(value); return *this;} private: bool m_deleteOnTermination; bool m_deleteOnTerminationHasBeenSet = false; int m_iops; bool m_iopsHasBeenSet = false; Aws::String m_snapshotId; bool m_snapshotIdHasBeenSet = false; int m_volumeSize; bool m_volumeSizeHasBeenSet = false; VolumeType m_volumeType; bool m_volumeTypeHasBeenSet = false; Aws::String m_kmsKeyId; bool m_kmsKeyIdHasBeenSet = false; int m_throughput; bool m_throughputHasBeenSet = false; Aws::String m_outpostArn; bool m_outpostArnHasBeenSet = false; bool m_encrypted; bool m_encryptedHasBeenSet = false; }; } // namespace Model } // namespace EC2 } // namespace Aws