This repository has been archived on 2025-09-14. You can view files and clone it, but cannot push or open issues or pull requests.
Files
pxz-hos-client-cpp-module/support/aws-sdk-cpp-master/aws-cpp-sdk-ec2/include/aws/ec2/model/CreateVolumeResponse.h

587 lines
21 KiB
C++

/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include <aws/ec2/EC2_EXPORTS.h>
#include <aws/core/utils/memory/stl/AWSVector.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <aws/core/utils/DateTime.h>
#include <aws/ec2/model/VolumeState.h>
#include <aws/ec2/model/VolumeType.h>
#include <aws/ec2/model/ResponseMetadata.h>
#include <aws/ec2/model/VolumeAttachment.h>
#include <aws/ec2/model/Tag.h>
#include <utility>
namespace Aws
{
template<typename RESULT_TYPE>
class AmazonWebServiceResult;
namespace Utils
{
namespace Xml
{
class XmlDocument;
} // namespace Xml
} // namespace Utils
namespace EC2
{
namespace Model
{
/**
* <p>Describes a volume.</p><p><h3>See Also:</h3> <a
* href="http://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/Volume">AWS API
* Reference</a></p>
*/
class AWS_EC2_API CreateVolumeResponse
{
public:
CreateVolumeResponse();
CreateVolumeResponse(const Aws::AmazonWebServiceResult<Aws::Utils::Xml::XmlDocument>& result);
CreateVolumeResponse& operator=(const Aws::AmazonWebServiceResult<Aws::Utils::Xml::XmlDocument>& result);
/**
* <p>Information about the volume attachments.</p>
*/
inline const Aws::Vector<VolumeAttachment>& GetAttachments() const{ return m_attachments; }
/**
* <p>Information about the volume attachments.</p>
*/
inline void SetAttachments(const Aws::Vector<VolumeAttachment>& value) { m_attachments = value; }
/**
* <p>Information about the volume attachments.</p>
*/
inline void SetAttachments(Aws::Vector<VolumeAttachment>&& value) { m_attachments = std::move(value); }
/**
* <p>Information about the volume attachments.</p>
*/
inline CreateVolumeResponse& WithAttachments(const Aws::Vector<VolumeAttachment>& value) { SetAttachments(value); return *this;}
/**
* <p>Information about the volume attachments.</p>
*/
inline CreateVolumeResponse& WithAttachments(Aws::Vector<VolumeAttachment>&& value) { SetAttachments(std::move(value)); return *this;}
/**
* <p>Information about the volume attachments.</p>
*/
inline CreateVolumeResponse& AddAttachments(const VolumeAttachment& value) { m_attachments.push_back(value); return *this; }
/**
* <p>Information about the volume attachments.</p>
*/
inline CreateVolumeResponse& AddAttachments(VolumeAttachment&& value) { m_attachments.push_back(std::move(value)); return *this; }
/**
* <p>The Availability Zone for the volume.</p>
*/
inline const Aws::String& GetAvailabilityZone() const{ return m_availabilityZone; }
/**
* <p>The Availability Zone for the volume.</p>
*/
inline void SetAvailabilityZone(const Aws::String& value) { m_availabilityZone = value; }
/**
* <p>The Availability Zone for the volume.</p>
*/
inline void SetAvailabilityZone(Aws::String&& value) { m_availabilityZone = std::move(value); }
/**
* <p>The Availability Zone for the volume.</p>
*/
inline void SetAvailabilityZone(const char* value) { m_availabilityZone.assign(value); }
/**
* <p>The Availability Zone for the volume.</p>
*/
inline CreateVolumeResponse& WithAvailabilityZone(const Aws::String& value) { SetAvailabilityZone(value); return *this;}
/**
* <p>The Availability Zone for the volume.</p>
*/
inline CreateVolumeResponse& WithAvailabilityZone(Aws::String&& value) { SetAvailabilityZone(std::move(value)); return *this;}
/**
* <p>The Availability Zone for the volume.</p>
*/
inline CreateVolumeResponse& WithAvailabilityZone(const char* value) { SetAvailabilityZone(value); return *this;}
/**
* <p>The time stamp when volume creation was initiated.</p>
*/
inline const Aws::Utils::DateTime& GetCreateTime() const{ return m_createTime; }
/**
* <p>The time stamp when volume creation was initiated.</p>
*/
inline void SetCreateTime(const Aws::Utils::DateTime& value) { m_createTime = value; }
/**
* <p>The time stamp when volume creation was initiated.</p>
*/
inline void SetCreateTime(Aws::Utils::DateTime&& value) { m_createTime = std::move(value); }
/**
* <p>The time stamp when volume creation was initiated.</p>
*/
inline CreateVolumeResponse& WithCreateTime(const Aws::Utils::DateTime& value) { SetCreateTime(value); return *this;}
/**
* <p>The time stamp when volume creation was initiated.</p>
*/
inline CreateVolumeResponse& WithCreateTime(Aws::Utils::DateTime&& value) { SetCreateTime(std::move(value)); return *this;}
/**
* <p>Indicates whether the volume is encrypted.</p>
*/
inline bool GetEncrypted() const{ return m_encrypted; }
/**
* <p>Indicates whether the volume is encrypted.</p>
*/
inline void SetEncrypted(bool value) { m_encrypted = value; }
/**
* <p>Indicates whether the volume is encrypted.</p>
*/
inline CreateVolumeResponse& WithEncrypted(bool value) { SetEncrypted(value); return *this;}
/**
* <p>The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS)
* customer master key (CMK) that was used to protect the volume encryption key for
* the volume.</p>
*/
inline const Aws::String& GetKmsKeyId() const{ return m_kmsKeyId; }
/**
* <p>The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS)
* customer master key (CMK) that was used to protect the volume encryption key for
* the volume.</p>
*/
inline void SetKmsKeyId(const Aws::String& value) { m_kmsKeyId = value; }
/**
* <p>The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS)
* customer master key (CMK) that was used to protect the volume encryption key for
* the volume.</p>
*/
inline void SetKmsKeyId(Aws::String&& value) { m_kmsKeyId = std::move(value); }
/**
* <p>The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS)
* customer master key (CMK) that was used to protect the volume encryption key for
* the volume.</p>
*/
inline void SetKmsKeyId(const char* value) { m_kmsKeyId.assign(value); }
/**
* <p>The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS)
* customer master key (CMK) that was used to protect the volume encryption key for
* the volume.</p>
*/
inline CreateVolumeResponse& WithKmsKeyId(const Aws::String& value) { SetKmsKeyId(value); return *this;}
/**
* <p>The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS)
* customer master key (CMK) that was used to protect the volume encryption key for
* the volume.</p>
*/
inline CreateVolumeResponse& WithKmsKeyId(Aws::String&& value) { SetKmsKeyId(std::move(value)); return *this;}
/**
* <p>The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS)
* customer master key (CMK) that was used to protect the volume encryption key for
* the volume.</p>
*/
inline CreateVolumeResponse& WithKmsKeyId(const char* value) { SetKmsKeyId(value); return *this;}
/**
* <p>The Amazon Resource Name (ARN) of the Outpost.</p>
*/
inline const Aws::String& GetOutpostArn() const{ return m_outpostArn; }
/**
* <p>The Amazon Resource Name (ARN) of the Outpost.</p>
*/
inline void SetOutpostArn(const Aws::String& value) { m_outpostArn = value; }
/**
* <p>The Amazon Resource Name (ARN) of the Outpost.</p>
*/
inline void SetOutpostArn(Aws::String&& value) { m_outpostArn = std::move(value); }
/**
* <p>The Amazon Resource Name (ARN) of the Outpost.</p>
*/
inline void SetOutpostArn(const char* value) { m_outpostArn.assign(value); }
/**
* <p>The Amazon Resource Name (ARN) of the Outpost.</p>
*/
inline CreateVolumeResponse& WithOutpostArn(const Aws::String& value) { SetOutpostArn(value); return *this;}
/**
* <p>The Amazon Resource Name (ARN) of the Outpost.</p>
*/
inline CreateVolumeResponse& WithOutpostArn(Aws::String&& value) { SetOutpostArn(std::move(value)); return *this;}
/**
* <p>The Amazon Resource Name (ARN) of the Outpost.</p>
*/
inline CreateVolumeResponse& WithOutpostArn(const char* value) { SetOutpostArn(value); return *this;}
/**
* <p>The size of the volume, in GiBs.</p>
*/
inline int GetSize() const{ return m_size; }
/**
* <p>The size of the volume, in GiBs.</p>
*/
inline void SetSize(int value) { m_size = value; }
/**
* <p>The size of the volume, in GiBs.</p>
*/
inline CreateVolumeResponse& WithSize(int value) { SetSize(value); return *this;}
/**
* <p>The snapshot from which the volume was created, if applicable.</p>
*/
inline const Aws::String& GetSnapshotId() const{ return m_snapshotId; }
/**
* <p>The snapshot from which the volume was created, if applicable.</p>
*/
inline void SetSnapshotId(const Aws::String& value) { m_snapshotId = value; }
/**
* <p>The snapshot from which the volume was created, if applicable.</p>
*/
inline void SetSnapshotId(Aws::String&& value) { m_snapshotId = std::move(value); }
/**
* <p>The snapshot from which the volume was created, if applicable.</p>
*/
inline void SetSnapshotId(const char* value) { m_snapshotId.assign(value); }
/**
* <p>The snapshot from which the volume was created, if applicable.</p>
*/
inline CreateVolumeResponse& WithSnapshotId(const Aws::String& value) { SetSnapshotId(value); return *this;}
/**
* <p>The snapshot from which the volume was created, if applicable.</p>
*/
inline CreateVolumeResponse& WithSnapshotId(Aws::String&& value) { SetSnapshotId(std::move(value)); return *this;}
/**
* <p>The snapshot from which the volume was created, if applicable.</p>
*/
inline CreateVolumeResponse& WithSnapshotId(const char* value) { SetSnapshotId(value); return *this;}
/**
* <p>The volume state.</p>
*/
inline const VolumeState& GetState() const{ return m_state; }
/**
* <p>The volume state.</p>
*/
inline void SetState(const VolumeState& value) { m_state = value; }
/**
* <p>The volume state.</p>
*/
inline void SetState(VolumeState&& value) { m_state = std::move(value); }
/**
* <p>The volume state.</p>
*/
inline CreateVolumeResponse& WithState(const VolumeState& value) { SetState(value); return *this;}
/**
* <p>The volume state.</p>
*/
inline CreateVolumeResponse& WithState(VolumeState&& value) { SetState(std::move(value)); return *this;}
/**
* <p>The ID of the volume.</p>
*/
inline const Aws::String& GetVolumeId() const{ return m_volumeId; }
/**
* <p>The ID of the volume.</p>
*/
inline void SetVolumeId(const Aws::String& value) { m_volumeId = value; }
/**
* <p>The ID of the volume.</p>
*/
inline void SetVolumeId(Aws::String&& value) { m_volumeId = std::move(value); }
/**
* <p>The ID of the volume.</p>
*/
inline void SetVolumeId(const char* value) { m_volumeId.assign(value); }
/**
* <p>The ID of the volume.</p>
*/
inline CreateVolumeResponse& WithVolumeId(const Aws::String& value) { SetVolumeId(value); return *this;}
/**
* <p>The ID of the volume.</p>
*/
inline CreateVolumeResponse& WithVolumeId(Aws::String&& value) { SetVolumeId(std::move(value)); return *this;}
/**
* <p>The ID of the volume.</p>
*/
inline CreateVolumeResponse& WithVolumeId(const char* value) { SetVolumeId(value); return *this;}
/**
* <p>The number of I/O operations per second (IOPS) that the volume supports. For
* Provisioned IOPS SSD volumes, this represents the number of IOPS that are
* provisioned for the volume. For General Purpose SSD 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 <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html">Amazon
* EBS volume types</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
* <p>Constraints: Range is 100-16,000 IOPS for <code>gp2</code> volumes and 100 to
* 64,000 IOPS for <code>io1</code> and <code>io2</code> volumes, in most Regions.
* The maximum IOPS for <code>io1</code> and <code>io2</code> of 64,000 is
* guaranteed only on <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances">Nitro-based
* instances</a>. Other instance families guarantee performance up to 32,000
* IOPS.</p> <p>Condition: This parameter is required for requests to create
* <code>io1</code> and <code>io2</code> volumes; it is not used in requests to
* create <code>gp2</code>, <code>st1</code>, <code>sc1</code>, or
* <code>standard</code> volumes.</p>
*/
inline int GetIops() const{ return m_iops; }
/**
* <p>The number of I/O operations per second (IOPS) that the volume supports. For
* Provisioned IOPS SSD volumes, this represents the number of IOPS that are
* provisioned for the volume. For General Purpose SSD 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 <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html">Amazon
* EBS volume types</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
* <p>Constraints: Range is 100-16,000 IOPS for <code>gp2</code> volumes and 100 to
* 64,000 IOPS for <code>io1</code> and <code>io2</code> volumes, in most Regions.
* The maximum IOPS for <code>io1</code> and <code>io2</code> of 64,000 is
* guaranteed only on <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances">Nitro-based
* instances</a>. Other instance families guarantee performance up to 32,000
* IOPS.</p> <p>Condition: This parameter is required for requests to create
* <code>io1</code> and <code>io2</code> volumes; it is not used in requests to
* create <code>gp2</code>, <code>st1</code>, <code>sc1</code>, or
* <code>standard</code> volumes.</p>
*/
inline void SetIops(int value) { m_iops = value; }
/**
* <p>The number of I/O operations per second (IOPS) that the volume supports. For
* Provisioned IOPS SSD volumes, this represents the number of IOPS that are
* provisioned for the volume. For General Purpose SSD 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 <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html">Amazon
* EBS volume types</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
* <p>Constraints: Range is 100-16,000 IOPS for <code>gp2</code> volumes and 100 to
* 64,000 IOPS for <code>io1</code> and <code>io2</code> volumes, in most Regions.
* The maximum IOPS for <code>io1</code> and <code>io2</code> of 64,000 is
* guaranteed only on <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances">Nitro-based
* instances</a>. Other instance families guarantee performance up to 32,000
* IOPS.</p> <p>Condition: This parameter is required for requests to create
* <code>io1</code> and <code>io2</code> volumes; it is not used in requests to
* create <code>gp2</code>, <code>st1</code>, <code>sc1</code>, or
* <code>standard</code> volumes.</p>
*/
inline CreateVolumeResponse& WithIops(int value) { SetIops(value); return *this;}
/**
* <p>Any tags assigned to the volume.</p>
*/
inline const Aws::Vector<Tag>& GetTags() const{ return m_tags; }
/**
* <p>Any tags assigned to the volume.</p>
*/
inline void SetTags(const Aws::Vector<Tag>& value) { m_tags = value; }
/**
* <p>Any tags assigned to the volume.</p>
*/
inline void SetTags(Aws::Vector<Tag>&& value) { m_tags = std::move(value); }
/**
* <p>Any tags assigned to the volume.</p>
*/
inline CreateVolumeResponse& WithTags(const Aws::Vector<Tag>& value) { SetTags(value); return *this;}
/**
* <p>Any tags assigned to the volume.</p>
*/
inline CreateVolumeResponse& WithTags(Aws::Vector<Tag>&& value) { SetTags(std::move(value)); return *this;}
/**
* <p>Any tags assigned to the volume.</p>
*/
inline CreateVolumeResponse& AddTags(const Tag& value) { m_tags.push_back(value); return *this; }
/**
* <p>Any tags assigned to the volume.</p>
*/
inline CreateVolumeResponse& AddTags(Tag&& value) { m_tags.push_back(std::move(value)); return *this; }
/**
* <p>The volume type. This can be <code>gp2</code> for General Purpose SSD,
* <code>io1</code> or <code>io2</code> for Provisioned IOPS SSD, <code>st1</code>
* for Throughput Optimized HDD, <code>sc1</code> for Cold HDD, or
* <code>standard</code> for Magnetic volumes.</p>
*/
inline const VolumeType& GetVolumeType() const{ return m_volumeType; }
/**
* <p>The volume type. This can be <code>gp2</code> for General Purpose SSD,
* <code>io1</code> or <code>io2</code> for Provisioned IOPS SSD, <code>st1</code>
* for Throughput Optimized HDD, <code>sc1</code> for Cold HDD, or
* <code>standard</code> for Magnetic volumes.</p>
*/
inline void SetVolumeType(const VolumeType& value) { m_volumeType = value; }
/**
* <p>The volume type. This can be <code>gp2</code> for General Purpose SSD,
* <code>io1</code> or <code>io2</code> for Provisioned IOPS SSD, <code>st1</code>
* for Throughput Optimized HDD, <code>sc1</code> for Cold HDD, or
* <code>standard</code> for Magnetic volumes.</p>
*/
inline void SetVolumeType(VolumeType&& value) { m_volumeType = std::move(value); }
/**
* <p>The volume type. This can be <code>gp2</code> for General Purpose SSD,
* <code>io1</code> or <code>io2</code> for Provisioned IOPS SSD, <code>st1</code>
* for Throughput Optimized HDD, <code>sc1</code> for Cold HDD, or
* <code>standard</code> for Magnetic volumes.</p>
*/
inline CreateVolumeResponse& WithVolumeType(const VolumeType& value) { SetVolumeType(value); return *this;}
/**
* <p>The volume type. This can be <code>gp2</code> for General Purpose SSD,
* <code>io1</code> or <code>io2</code> for Provisioned IOPS SSD, <code>st1</code>
* for Throughput Optimized HDD, <code>sc1</code> for Cold HDD, or
* <code>standard</code> for Magnetic volumes.</p>
*/
inline CreateVolumeResponse& WithVolumeType(VolumeType&& value) { SetVolumeType(std::move(value)); return *this;}
/**
* <p>Indicates whether the volume was created using fast snapshot restore.</p>
*/
inline bool GetFastRestored() const{ return m_fastRestored; }
/**
* <p>Indicates whether the volume was created using fast snapshot restore.</p>
*/
inline void SetFastRestored(bool value) { m_fastRestored = value; }
/**
* <p>Indicates whether the volume was created using fast snapshot restore.</p>
*/
inline CreateVolumeResponse& WithFastRestored(bool value) { SetFastRestored(value); return *this;}
/**
* <p>Indicates whether Amazon EBS Multi-Attach is enabled.</p>
*/
inline bool GetMultiAttachEnabled() const{ return m_multiAttachEnabled; }
/**
* <p>Indicates whether Amazon EBS Multi-Attach is enabled.</p>
*/
inline void SetMultiAttachEnabled(bool value) { m_multiAttachEnabled = value; }
/**
* <p>Indicates whether Amazon EBS Multi-Attach is enabled.</p>
*/
inline CreateVolumeResponse& WithMultiAttachEnabled(bool value) { SetMultiAttachEnabled(value); return *this;}
inline const ResponseMetadata& GetResponseMetadata() const{ return m_responseMetadata; }
inline void SetResponseMetadata(const ResponseMetadata& value) { m_responseMetadata = value; }
inline void SetResponseMetadata(ResponseMetadata&& value) { m_responseMetadata = std::move(value); }
inline CreateVolumeResponse& WithResponseMetadata(const ResponseMetadata& value) { SetResponseMetadata(value); return *this;}
inline CreateVolumeResponse& WithResponseMetadata(ResponseMetadata&& value) { SetResponseMetadata(std::move(value)); return *this;}
private:
Aws::Vector<VolumeAttachment> m_attachments;
Aws::String m_availabilityZone;
Aws::Utils::DateTime m_createTime;
bool m_encrypted;
Aws::String m_kmsKeyId;
Aws::String m_outpostArn;
int m_size;
Aws::String m_snapshotId;
VolumeState m_state;
Aws::String m_volumeId;
int m_iops;
Aws::Vector<Tag> m_tags;
VolumeType m_volumeType;
bool m_fastRestored;
bool m_multiAttachEnabled;
ResponseMetadata m_responseMetadata;
};
} // namespace Model
} // namespace EC2
} // namespace Aws