/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include Describes a block device for an EBS volume.See Also:
AWS
* API Reference
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.
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.
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.
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.
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
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
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
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
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
The ARN of the Outpost on which the snapshot is stored.
This parameter
* is only supported on BlockDeviceMapping
objects called by
* CreateImage.
The ARN of the Outpost on which the snapshot is stored.
This parameter
* is only supported on BlockDeviceMapping
objects called by
* CreateImage.
The ARN of the Outpost on which the snapshot is stored.
This parameter
* is only supported on BlockDeviceMapping
objects called by
* CreateImage.
The ARN of the Outpost on which the snapshot is stored.
This parameter
* is only supported on BlockDeviceMapping
objects called by
* CreateImage.
The ARN of the Outpost on which the snapshot is stored.
This parameter
* is only supported on BlockDeviceMapping
objects called by
* CreateImage.
The ARN of the Outpost on which the snapshot is stored.
This parameter
* is only supported on BlockDeviceMapping
objects called by
* CreateImage.
The ARN of the Outpost on which the snapshot is stored.
This parameter
* is only supported on BlockDeviceMapping
objects called by
* CreateImage.
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.
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.
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.
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.