/**
* 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 Elastic Compute * Cloud 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 Elastic Compute * Cloud 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 Elastic Compute * Cloud 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 Elastic Compute * Cloud User Guide.
*/ inline EbsBlockDevice& WithDeleteOnTermination(bool value) { SetDeleteOnTermination(value); return *this;} /** *The number of I/O operations per second (IOPS) that the volume supports. For
* 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. For more information, see Amazon
* EBS volume types in the Amazon Elastic Compute Cloud User Guide.
Constraints: Range is 100-16,000 IOPS for gp2 volumes and 100 to
* 64,000 IOPS for io1 and io2 volumes in most Regions.
* Maximum io1 and io2 IOPS of 64,000 is guaranteed only
* on Nitro-based
* instances. Other instance families guarantee performance up to 32,000 IOPS.
* For more information, see Amazon
* EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.
Condition: This parameter is required for requests to create io1
* and io2 volumes; it is not used in requests to create
* gp2, st1, sc1, or standard
* volumes.
The number of I/O operations per second (IOPS) that the volume supports. For
* 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. For more information, see Amazon
* EBS volume types in the Amazon Elastic Compute Cloud User Guide.
Constraints: Range is 100-16,000 IOPS for gp2 volumes and 100 to
* 64,000 IOPS for io1 and io2 volumes in most Regions.
* Maximum io1 and io2 IOPS of 64,000 is guaranteed only
* on Nitro-based
* instances. Other instance families guarantee performance up to 32,000 IOPS.
* For more information, see Amazon
* EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.
Condition: This parameter is required for requests to create io1
* and io2 volumes; it is not used in requests to create
* gp2, st1, sc1, or standard
* volumes.
The number of I/O operations per second (IOPS) that the volume supports. For
* 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. For more information, see Amazon
* EBS volume types in the Amazon Elastic Compute Cloud User Guide.
Constraints: Range is 100-16,000 IOPS for gp2 volumes and 100 to
* 64,000 IOPS for io1 and io2 volumes in most Regions.
* Maximum io1 and io2 IOPS of 64,000 is guaranteed only
* on Nitro-based
* instances. Other instance families guarantee performance up to 32,000 IOPS.
* For more information, see Amazon
* EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.
Condition: This parameter is required for requests to create io1
* and io2 volumes; it is not used in requests to create
* gp2, st1, sc1, or standard
* volumes.
The number of I/O operations per second (IOPS) that the volume supports. For
* 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. For more information, see Amazon
* EBS volume types in the Amazon Elastic Compute Cloud User Guide.
Constraints: Range is 100-16,000 IOPS for gp2 volumes and 100 to
* 64,000 IOPS for io1 and io2 volumes in most Regions.
* Maximum io1 and io2 IOPS of 64,000 is guaranteed only
* on Nitro-based
* instances. Other instance families guarantee performance up to 32,000 IOPS.
* For more information, see Amazon
* EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.
Condition: This parameter is required for requests to create io1
* and io2 volumes; it is not used in requests to create
* 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 GiB.
Default: If you're creating the volume * from a snapshot and don't specify a volume size, the default is the snapshot * size.
Constraints: 1-16384 for General Purpose SSD (gp2),
* 4-16384 for Provisioned IOPS SSD (io1 and io2),
* 500-16384 for Throughput Optimized HDD (st1), 500-16384 for Cold
* HDD (sc1), and 1-1024 for Magnetic (standard) volumes.
* If you specify a snapshot, the volume size must be equal to or larger than the
* snapshot size.
The size of the volume, in GiB.
Default: If you're creating the volume * from a snapshot and don't specify a volume size, the default is the snapshot * size.
Constraints: 1-16384 for General Purpose SSD (gp2),
* 4-16384 for Provisioned IOPS SSD (io1 and io2),
* 500-16384 for Throughput Optimized HDD (st1), 500-16384 for Cold
* HDD (sc1), and 1-1024 for Magnetic (standard) volumes.
* If you specify a snapshot, the volume size must be equal to or larger than the
* snapshot size.
The size of the volume, in GiB.
Default: If you're creating the volume * from a snapshot and don't specify a volume size, the default is the snapshot * size.
Constraints: 1-16384 for General Purpose SSD (gp2),
* 4-16384 for Provisioned IOPS SSD (io1 and io2),
* 500-16384 for Throughput Optimized HDD (st1), 500-16384 for Cold
* HDD (sc1), and 1-1024 for Magnetic (standard) volumes.
* If you specify a snapshot, the volume size must be equal to or larger than the
* snapshot size.
The size of the volume, in GiB.
Default: If you're creating the volume * from a snapshot and don't specify a volume size, the default is the snapshot * size.
Constraints: 1-16384 for General Purpose SSD (gp2),
* 4-16384 for Provisioned IOPS SSD (io1 and io2),
* 500-16384 for Throughput Optimized HDD (st1), 500-16384 for Cold
* HDD (sc1), and 1-1024 for Magnetic (standard) volumes.
* If you specify a snapshot, the volume size must be equal to or larger than the
* snapshot size.
The volume type. If you set the type to io1 or io2,
* you must also specify the Iops parameter. If you set the type to
* gp2, st1, sc1, or standard,
* you must omit the Iops parameter.
Default: gp2
The volume type. If you set the type to io1 or io2,
* you must also specify the Iops parameter. If you set the type to
* gp2, st1, sc1, or standard,
* you must omit the Iops parameter.
Default: gp2
The volume type. If you set the type to io1 or io2,
* you must also specify the Iops parameter. If you set the type to
* gp2, st1, sc1, or standard,
* you must omit the Iops parameter.
Default: gp2
The volume type. If you set the type to io1 or io2,
* you must also specify the Iops parameter. If you set the type to
* gp2, st1, sc1, or standard,
* you must omit the Iops parameter.
Default: gp2
The volume type. If you set the type to io1 or io2,
* you must also specify the Iops parameter. If you set the type to
* gp2, st1, sc1, or standard,
* you must omit the Iops parameter.
Default: gp2
The volume type. If you set the type to io1 or io2,
* you must also specify the Iops parameter. If you set the type to
* gp2, st1, sc1, or standard,
* you must omit the Iops parameter.
Default: gp2
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.
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 Elastic Compute Cloud 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 .
*/ 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 Elastic Compute Cloud 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 .
*/ 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 Elastic Compute Cloud 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 .
*/ 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 Elastic Compute Cloud 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 .
*/ inline EbsBlockDevice& WithEncrypted(bool value) { SetEncrypted(value); return *this;} private: bool m_deleteOnTermination; bool m_deleteOnTerminationHasBeenSet; int m_iops; bool m_iopsHasBeenSet; Aws::String m_snapshotId; bool m_snapshotIdHasBeenSet; int m_volumeSize; bool m_volumeSizeHasBeenSet; VolumeType m_volumeType; bool m_volumeTypeHasBeenSet; Aws::String m_kmsKeyId; bool m_kmsKeyIdHasBeenSet; bool m_encrypted; bool m_encryptedHasBeenSet; }; } // namespace Model } // namespace EC2 } // namespace Aws