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

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

*/ class AWS_AUTOSCALING_API Ebs { public: Ebs(); Ebs(const Aws::Utils::Xml::XmlNode& xmlNode); Ebs& operator=(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; /** *

The snapshot ID of the volume to use.

You must specify either a * VolumeSize or a SnapshotId.

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

The snapshot ID of the volume to use.

You must specify either a * VolumeSize or a SnapshotId.

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

The snapshot ID of the volume to use.

You must specify either a * VolumeSize or a SnapshotId.

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

The snapshot ID of the volume to use.

You must specify either a * VolumeSize or a SnapshotId.

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

The snapshot ID of the volume to use.

You must specify either a * VolumeSize or a SnapshotId.

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

The snapshot ID of the volume to use.

You must specify either a * VolumeSize or a SnapshotId.

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

The snapshot ID of the volume to use.

You must specify either a * VolumeSize or a SnapshotId.

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

The snapshot ID of the volume to use.

You must specify either a * VolumeSize or a SnapshotId.

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

The volume size, in Gibibytes (GiB).

This can be a number from 1-1,024 * for standard, 4-16,384 for io1, 1-16,384 for * gp2, and 500-16,384 for st1 and sc1. If * you specify a snapshot, the volume size must be equal to or larger than the * snapshot size.

Default: If you create a volume from a snapshot and you * don't specify a volume size, the default is the snapshot size.

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

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

The volume size, in Gibibytes (GiB).

Default: If you create a volume from a snapshot and you * don't specify a volume size, the default is the snapshot size.

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

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

The volume size, in Gibibytes (GiB).

Default: If you create a volume from a snapshot and you * don't specify a volume size, the default is the snapshot size.

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

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

The volume size, in Gibibytes (GiB).

Default: If you create a volume from a snapshot and you * don't specify a volume size, the default is the snapshot size.

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

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

The volume type, which can be standard for Magnetic, * io1 for Provisioned IOPS SSD, gp2 for General Purpose * SSD, st1 for Throughput Optimized HDD, or sc1 for Cold * HDD. For more information, see Amazon * EBS Volume Types in the Amazon EC2 User Guide for Linux * Instances.

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

*/ inline const Aws::String& GetVolumeType() const{ return m_volumeType; } /** *

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

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

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

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

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

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

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

*/ inline void SetVolumeType(const char* value) { m_volumeTypeHasBeenSet = true; m_volumeType.assign(value); } /** *

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

*/ inline Ebs& WithVolumeType(const Aws::String& value) { SetVolumeType(value); return *this;} /** *

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

*/ inline Ebs& WithVolumeType(Aws::String&& value) { SetVolumeType(std::move(value)); return *this;} /** *

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

*/ inline Ebs& WithVolumeType(const char* value) { SetVolumeType(value); return *this;} /** *

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

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

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

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

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

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

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

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

The number of I/O operations per second (IOPS) to provision for the volume. * The maximum ratio of IOPS to volume size (in GiB) is 50:1. For more information, * see Amazon * EBS Volume Types in the Amazon EC2 User Guide for Linux * Instances.

Required when the volume type is io1. (Not * used with standard, gp2, st1, or * sc1 volumes.)

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

Required when the volume type is io1. (Not * used with standard, gp2, st1, or * sc1 volumes.)

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

Required when the volume type is io1. (Not * used with standard, gp2, st1, or * sc1 volumes.)

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

Required when the volume type is io1. (Not * used with standard, gp2, st1, or * sc1 volumes.)

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

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

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

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

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

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

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

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

*/ inline Ebs& WithEncrypted(bool value) { SetEncrypted(value); return *this;} private: Aws::String m_snapshotId; bool m_snapshotIdHasBeenSet; int m_volumeSize; bool m_volumeSizeHasBeenSet; Aws::String m_volumeType; bool m_volumeTypeHasBeenSet; bool m_deleteOnTermination; bool m_deleteOnTerminationHasBeenSet; int m_iops; bool m_iopsHasBeenSet; bool m_encrypted; bool m_encryptedHasBeenSet; }; } // namespace Model } // namespace AutoScaling } // namespace Aws

See Also: