/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include Describes a snapshot.See Also:
AWS API
* Reference
The data encryption key identifier for the snapshot. This value is a unique * identifier that corresponds to the data encryption key that was used to encrypt * the original volume or snapshot copy. Because data encryption keys are inherited * by volumes created from snapshots, and vice versa, if snapshots share the same * data encryption key identifier, then they belong to the same volume/snapshot * lineage. This parameter is only returned by DescribeSnapshots.
*/ inline const Aws::String& GetDataEncryptionKeyId() const{ return m_dataEncryptionKeyId; } /** *The data encryption key identifier for the snapshot. This value is a unique * identifier that corresponds to the data encryption key that was used to encrypt * the original volume or snapshot copy. Because data encryption keys are inherited * by volumes created from snapshots, and vice versa, if snapshots share the same * data encryption key identifier, then they belong to the same volume/snapshot * lineage. This parameter is only returned by DescribeSnapshots.
*/ inline void SetDataEncryptionKeyId(const Aws::String& value) { m_dataEncryptionKeyId = value; } /** *The data encryption key identifier for the snapshot. This value is a unique * identifier that corresponds to the data encryption key that was used to encrypt * the original volume or snapshot copy. Because data encryption keys are inherited * by volumes created from snapshots, and vice versa, if snapshots share the same * data encryption key identifier, then they belong to the same volume/snapshot * lineage. This parameter is only returned by DescribeSnapshots.
*/ inline void SetDataEncryptionKeyId(Aws::String&& value) { m_dataEncryptionKeyId = std::move(value); } /** *The data encryption key identifier for the snapshot. This value is a unique * identifier that corresponds to the data encryption key that was used to encrypt * the original volume or snapshot copy. Because data encryption keys are inherited * by volumes created from snapshots, and vice versa, if snapshots share the same * data encryption key identifier, then they belong to the same volume/snapshot * lineage. This parameter is only returned by DescribeSnapshots.
*/ inline void SetDataEncryptionKeyId(const char* value) { m_dataEncryptionKeyId.assign(value); } /** *The data encryption key identifier for the snapshot. This value is a unique * identifier that corresponds to the data encryption key that was used to encrypt * the original volume or snapshot copy. Because data encryption keys are inherited * by volumes created from snapshots, and vice versa, if snapshots share the same * data encryption key identifier, then they belong to the same volume/snapshot * lineage. This parameter is only returned by DescribeSnapshots.
*/ inline CreateSnapshotResponse& WithDataEncryptionKeyId(const Aws::String& value) { SetDataEncryptionKeyId(value); return *this;} /** *The data encryption key identifier for the snapshot. This value is a unique * identifier that corresponds to the data encryption key that was used to encrypt * the original volume or snapshot copy. Because data encryption keys are inherited * by volumes created from snapshots, and vice versa, if snapshots share the same * data encryption key identifier, then they belong to the same volume/snapshot * lineage. This parameter is only returned by DescribeSnapshots.
*/ inline CreateSnapshotResponse& WithDataEncryptionKeyId(Aws::String&& value) { SetDataEncryptionKeyId(std::move(value)); return *this;} /** *The data encryption key identifier for the snapshot. This value is a unique * identifier that corresponds to the data encryption key that was used to encrypt * the original volume or snapshot copy. Because data encryption keys are inherited * by volumes created from snapshots, and vice versa, if snapshots share the same * data encryption key identifier, then they belong to the same volume/snapshot * lineage. This parameter is only returned by DescribeSnapshots.
*/ inline CreateSnapshotResponse& WithDataEncryptionKeyId(const char* value) { SetDataEncryptionKeyId(value); return *this;} /** *The description for the snapshot.
*/ inline const Aws::String& GetDescription() const{ return m_description; } /** *The description for the snapshot.
*/ inline void SetDescription(const Aws::String& value) { m_description = value; } /** *The description for the snapshot.
*/ inline void SetDescription(Aws::String&& value) { m_description = std::move(value); } /** *The description for the snapshot.
*/ inline void SetDescription(const char* value) { m_description.assign(value); } /** *The description for the snapshot.
*/ inline CreateSnapshotResponse& WithDescription(const Aws::String& value) { SetDescription(value); return *this;} /** *The description for the snapshot.
*/ inline CreateSnapshotResponse& WithDescription(Aws::String&& value) { SetDescription(std::move(value)); return *this;} /** *The description for the snapshot.
*/ inline CreateSnapshotResponse& WithDescription(const char* value) { SetDescription(value); return *this;} /** *Indicates whether the snapshot is encrypted.
*/ inline bool GetEncrypted() const{ return m_encrypted; } /** *Indicates whether the snapshot is encrypted.
*/ inline void SetEncrypted(bool value) { m_encrypted = value; } /** *Indicates whether the snapshot is encrypted.
*/ inline CreateSnapshotResponse& WithEncrypted(bool value) { SetEncrypted(value); return *this;} /** *The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key * that was used to protect the volume encryption key for the parent volume.
*/ inline const Aws::String& GetKmsKeyId() const{ return m_kmsKeyId; } /** *The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key * that was used to protect the volume encryption key for the parent volume.
*/ inline void SetKmsKeyId(const Aws::String& value) { m_kmsKeyId = value; } /** *The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key * that was used to protect the volume encryption key for the parent volume.
*/ inline void SetKmsKeyId(Aws::String&& value) { m_kmsKeyId = std::move(value); } /** *The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key * that was used to protect the volume encryption key for the parent volume.
*/ inline void SetKmsKeyId(const char* value) { m_kmsKeyId.assign(value); } /** *The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key * that was used to protect the volume encryption key for the parent volume.
*/ inline CreateSnapshotResponse& WithKmsKeyId(const Aws::String& value) { SetKmsKeyId(value); return *this;} /** *The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key * that was used to protect the volume encryption key for the parent volume.
*/ inline CreateSnapshotResponse& WithKmsKeyId(Aws::String&& value) { SetKmsKeyId(std::move(value)); return *this;} /** *The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key * that was used to protect the volume encryption key for the parent volume.
*/ inline CreateSnapshotResponse& WithKmsKeyId(const char* value) { SetKmsKeyId(value); return *this;} /** *The ID of the Amazon Web Services account that owns the EBS snapshot.
*/ inline const Aws::String& GetOwnerId() const{ return m_ownerId; } /** *The ID of the Amazon Web Services account that owns the EBS snapshot.
*/ inline void SetOwnerId(const Aws::String& value) { m_ownerId = value; } /** *The ID of the Amazon Web Services account that owns the EBS snapshot.
*/ inline void SetOwnerId(Aws::String&& value) { m_ownerId = std::move(value); } /** *The ID of the Amazon Web Services account that owns the EBS snapshot.
*/ inline void SetOwnerId(const char* value) { m_ownerId.assign(value); } /** *The ID of the Amazon Web Services account that owns the EBS snapshot.
*/ inline CreateSnapshotResponse& WithOwnerId(const Aws::String& value) { SetOwnerId(value); return *this;} /** *The ID of the Amazon Web Services account that owns the EBS snapshot.
*/ inline CreateSnapshotResponse& WithOwnerId(Aws::String&& value) { SetOwnerId(std::move(value)); return *this;} /** *The ID of the Amazon Web Services account that owns the EBS snapshot.
*/ inline CreateSnapshotResponse& WithOwnerId(const char* value) { SetOwnerId(value); return *this;} /** *The progress of the snapshot, as a percentage.
*/ inline const Aws::String& GetProgress() const{ return m_progress; } /** *The progress of the snapshot, as a percentage.
*/ inline void SetProgress(const Aws::String& value) { m_progress = value; } /** *The progress of the snapshot, as a percentage.
*/ inline void SetProgress(Aws::String&& value) { m_progress = std::move(value); } /** *The progress of the snapshot, as a percentage.
*/ inline void SetProgress(const char* value) { m_progress.assign(value); } /** *The progress of the snapshot, as a percentage.
*/ inline CreateSnapshotResponse& WithProgress(const Aws::String& value) { SetProgress(value); return *this;} /** *The progress of the snapshot, as a percentage.
*/ inline CreateSnapshotResponse& WithProgress(Aws::String&& value) { SetProgress(std::move(value)); return *this;} /** *The progress of the snapshot, as a percentage.
*/ inline CreateSnapshotResponse& WithProgress(const char* value) { SetProgress(value); return *this;} /** *The ID of the snapshot. Each snapshot receives a unique identifier when it is * created.
*/ inline const Aws::String& GetSnapshotId() const{ return m_snapshotId; } /** *The ID of the snapshot. Each snapshot receives a unique identifier when it is * created.
*/ inline void SetSnapshotId(const Aws::String& value) { m_snapshotId = value; } /** *The ID of the snapshot. Each snapshot receives a unique identifier when it is * created.
*/ inline void SetSnapshotId(Aws::String&& value) { m_snapshotId = std::move(value); } /** *The ID of the snapshot. Each snapshot receives a unique identifier when it is * created.
*/ inline void SetSnapshotId(const char* value) { m_snapshotId.assign(value); } /** *The ID of the snapshot. Each snapshot receives a unique identifier when it is * created.
*/ inline CreateSnapshotResponse& WithSnapshotId(const Aws::String& value) { SetSnapshotId(value); return *this;} /** *The ID of the snapshot. Each snapshot receives a unique identifier when it is * created.
*/ inline CreateSnapshotResponse& WithSnapshotId(Aws::String&& value) { SetSnapshotId(std::move(value)); return *this;} /** *The ID of the snapshot. Each snapshot receives a unique identifier when it is * created.
*/ inline CreateSnapshotResponse& WithSnapshotId(const char* value) { SetSnapshotId(value); return *this;} /** *The time stamp when the snapshot was initiated.
*/ inline const Aws::Utils::DateTime& GetStartTime() const{ return m_startTime; } /** *The time stamp when the snapshot was initiated.
*/ inline void SetStartTime(const Aws::Utils::DateTime& value) { m_startTime = value; } /** *The time stamp when the snapshot was initiated.
*/ inline void SetStartTime(Aws::Utils::DateTime&& value) { m_startTime = std::move(value); } /** *The time stamp when the snapshot was initiated.
*/ inline CreateSnapshotResponse& WithStartTime(const Aws::Utils::DateTime& value) { SetStartTime(value); return *this;} /** *The time stamp when the snapshot was initiated.
*/ inline CreateSnapshotResponse& WithStartTime(Aws::Utils::DateTime&& value) { SetStartTime(std::move(value)); return *this;} /** *The snapshot state.
*/ inline const SnapshotState& GetState() const{ return m_state; } /** *The snapshot state.
*/ inline void SetState(const SnapshotState& value) { m_state = value; } /** *The snapshot state.
*/ inline void SetState(SnapshotState&& value) { m_state = std::move(value); } /** *The snapshot state.
*/ inline CreateSnapshotResponse& WithState(const SnapshotState& value) { SetState(value); return *this;} /** *The snapshot state.
*/ inline CreateSnapshotResponse& WithState(SnapshotState&& value) { SetState(std::move(value)); return *this;} /** *Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy * operation fails (for example, if the proper Key Management Service (KMS) * permissions are not obtained) this field displays error state details to help * you diagnose why the error occurred. This parameter is only returned by * DescribeSnapshots.
*/ inline const Aws::String& GetStateMessage() const{ return m_stateMessage; } /** *Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy * operation fails (for example, if the proper Key Management Service (KMS) * permissions are not obtained) this field displays error state details to help * you diagnose why the error occurred. This parameter is only returned by * DescribeSnapshots.
*/ inline void SetStateMessage(const Aws::String& value) { m_stateMessage = value; } /** *Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy * operation fails (for example, if the proper Key Management Service (KMS) * permissions are not obtained) this field displays error state details to help * you diagnose why the error occurred. This parameter is only returned by * DescribeSnapshots.
*/ inline void SetStateMessage(Aws::String&& value) { m_stateMessage = std::move(value); } /** *Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy * operation fails (for example, if the proper Key Management Service (KMS) * permissions are not obtained) this field displays error state details to help * you diagnose why the error occurred. This parameter is only returned by * DescribeSnapshots.
*/ inline void SetStateMessage(const char* value) { m_stateMessage.assign(value); } /** *Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy * operation fails (for example, if the proper Key Management Service (KMS) * permissions are not obtained) this field displays error state details to help * you diagnose why the error occurred. This parameter is only returned by * DescribeSnapshots.
*/ inline CreateSnapshotResponse& WithStateMessage(const Aws::String& value) { SetStateMessage(value); return *this;} /** *Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy * operation fails (for example, if the proper Key Management Service (KMS) * permissions are not obtained) this field displays error state details to help * you diagnose why the error occurred. This parameter is only returned by * DescribeSnapshots.
*/ inline CreateSnapshotResponse& WithStateMessage(Aws::String&& value) { SetStateMessage(std::move(value)); return *this;} /** *Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy * operation fails (for example, if the proper Key Management Service (KMS) * permissions are not obtained) this field displays error state details to help * you diagnose why the error occurred. This parameter is only returned by * DescribeSnapshots.
*/ inline CreateSnapshotResponse& WithStateMessage(const char* value) { SetStateMessage(value); return *this;} /** *The ID of the volume that was used to create the snapshot. Snapshots created * by the CopySnapshot action have an arbitrary volume ID that should not be * used for any purpose.
*/ inline const Aws::String& GetVolumeId() const{ return m_volumeId; } /** *The ID of the volume that was used to create the snapshot. Snapshots created * by the CopySnapshot action have an arbitrary volume ID that should not be * used for any purpose.
*/ inline void SetVolumeId(const Aws::String& value) { m_volumeId = value; } /** *The ID of the volume that was used to create the snapshot. Snapshots created * by the CopySnapshot action have an arbitrary volume ID that should not be * used for any purpose.
*/ inline void SetVolumeId(Aws::String&& value) { m_volumeId = std::move(value); } /** *The ID of the volume that was used to create the snapshot. Snapshots created * by the CopySnapshot action have an arbitrary volume ID that should not be * used for any purpose.
*/ inline void SetVolumeId(const char* value) { m_volumeId.assign(value); } /** *The ID of the volume that was used to create the snapshot. Snapshots created * by the CopySnapshot action have an arbitrary volume ID that should not be * used for any purpose.
*/ inline CreateSnapshotResponse& WithVolumeId(const Aws::String& value) { SetVolumeId(value); return *this;} /** *The ID of the volume that was used to create the snapshot. Snapshots created * by the CopySnapshot action have an arbitrary volume ID that should not be * used for any purpose.
*/ inline CreateSnapshotResponse& WithVolumeId(Aws::String&& value) { SetVolumeId(std::move(value)); return *this;} /** *The ID of the volume that was used to create the snapshot. Snapshots created * by the CopySnapshot action have an arbitrary volume ID that should not be * used for any purpose.
*/ inline CreateSnapshotResponse& WithVolumeId(const char* value) { SetVolumeId(value); return *this;} /** *The size of the volume, in GiB.
*/ inline int GetVolumeSize() const{ return m_volumeSize; } /** *The size of the volume, in GiB.
*/ inline void SetVolumeSize(int value) { m_volumeSize = value; } /** *The size of the volume, in GiB.
*/ inline CreateSnapshotResponse& WithVolumeSize(int value) { SetVolumeSize(value); return *this;} /** *The Amazon Web Services owner alias, from an Amazon-maintained list
* (amazon
). This is not the user-configured Amazon Web Services
* account alias set using the IAM console.
The Amazon Web Services owner alias, from an Amazon-maintained list
* (amazon
). This is not the user-configured Amazon Web Services
* account alias set using the IAM console.
The Amazon Web Services owner alias, from an Amazon-maintained list
* (amazon
). This is not the user-configured Amazon Web Services
* account alias set using the IAM console.
The Amazon Web Services owner alias, from an Amazon-maintained list
* (amazon
). This is not the user-configured Amazon Web Services
* account alias set using the IAM console.
The Amazon Web Services owner alias, from an Amazon-maintained list
* (amazon
). This is not the user-configured Amazon Web Services
* account alias set using the IAM console.
The Amazon Web Services owner alias, from an Amazon-maintained list
* (amazon
). This is not the user-configured Amazon Web Services
* account alias set using the IAM console.
The Amazon Web Services owner alias, from an Amazon-maintained list
* (amazon
). This is not the user-configured Amazon Web Services
* account alias set using the IAM console.
The ARN of the Outpost on which the snapshot is stored. For more information, * see Amazon * EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User * Guide.
*/ inline const Aws::String& GetOutpostArn() const{ return m_outpostArn; } /** *The ARN of the Outpost on which the snapshot is stored. For more information, * see Amazon * EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User * Guide.
*/ inline void SetOutpostArn(const Aws::String& value) { m_outpostArn = value; } /** *The ARN of the Outpost on which the snapshot is stored. For more information, * see Amazon * EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User * Guide.
*/ inline void SetOutpostArn(Aws::String&& value) { m_outpostArn = std::move(value); } /** *The ARN of the Outpost on which the snapshot is stored. For more information, * see Amazon * EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User * Guide.
*/ inline void SetOutpostArn(const char* value) { m_outpostArn.assign(value); } /** *The ARN of the Outpost on which the snapshot is stored. For more information, * see Amazon * EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User * Guide.
*/ inline CreateSnapshotResponse& WithOutpostArn(const Aws::String& value) { SetOutpostArn(value); return *this;} /** *The ARN of the Outpost on which the snapshot is stored. For more information, * see Amazon * EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User * Guide.
*/ inline CreateSnapshotResponse& WithOutpostArn(Aws::String&& value) { SetOutpostArn(std::move(value)); return *this;} /** *The ARN of the Outpost on which the snapshot is stored. For more information, * see Amazon * EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User * Guide.
*/ inline CreateSnapshotResponse& WithOutpostArn(const char* value) { SetOutpostArn(value); return *this;} /** *Any tags assigned to the snapshot.
*/ inline const Aws::VectorAny tags assigned to the snapshot.
*/ inline void SetTags(const Aws::VectorAny tags assigned to the snapshot.
*/ inline void SetTags(Aws::VectorAny tags assigned to the snapshot.
*/ inline CreateSnapshotResponse& WithTags(const Aws::VectorAny tags assigned to the snapshot.
*/ inline CreateSnapshotResponse& WithTags(Aws::VectorAny tags assigned to the snapshot.
*/ inline CreateSnapshotResponse& AddTags(const Tag& value) { m_tags.push_back(value); return *this; } /** *Any tags assigned to the snapshot.
*/ inline CreateSnapshotResponse& AddTags(Tag&& value) { m_tags.push_back(std::move(value)); return *this; } /** *The storage tier in which the snapshot is stored. standard
* indicates that the snapshot is stored in the standard snapshot storage tier and
* that it is ready for use. archive
indicates that the snapshot is
* currently archived and that it must be restored before it can be used.
The storage tier in which the snapshot is stored. standard
* indicates that the snapshot is stored in the standard snapshot storage tier and
* that it is ready for use. archive
indicates that the snapshot is
* currently archived and that it must be restored before it can be used.
The storage tier in which the snapshot is stored. standard
* indicates that the snapshot is stored in the standard snapshot storage tier and
* that it is ready for use. archive
indicates that the snapshot is
* currently archived and that it must be restored before it can be used.
The storage tier in which the snapshot is stored. standard
* indicates that the snapshot is stored in the standard snapshot storage tier and
* that it is ready for use. archive
indicates that the snapshot is
* currently archived and that it must be restored before it can be used.
The storage tier in which the snapshot is stored. standard
* indicates that the snapshot is stored in the standard snapshot storage tier and
* that it is ready for use. archive
indicates that the snapshot is
* currently archived and that it must be restored before it can be used.
Only for archived snapshots that are temporarily restored. Indicates the date * and time when a temporarily restored snapshot will be automatically * re-archived.
*/ inline const Aws::Utils::DateTime& GetRestoreExpiryTime() const{ return m_restoreExpiryTime; } /** *Only for archived snapshots that are temporarily restored. Indicates the date * and time when a temporarily restored snapshot will be automatically * re-archived.
*/ inline void SetRestoreExpiryTime(const Aws::Utils::DateTime& value) { m_restoreExpiryTime = value; } /** *Only for archived snapshots that are temporarily restored. Indicates the date * and time when a temporarily restored snapshot will be automatically * re-archived.
*/ inline void SetRestoreExpiryTime(Aws::Utils::DateTime&& value) { m_restoreExpiryTime = std::move(value); } /** *Only for archived snapshots that are temporarily restored. Indicates the date * and time when a temporarily restored snapshot will be automatically * re-archived.
*/ inline CreateSnapshotResponse& WithRestoreExpiryTime(const Aws::Utils::DateTime& value) { SetRestoreExpiryTime(value); return *this;} /** *Only for archived snapshots that are temporarily restored. Indicates the date * and time when a temporarily restored snapshot will be automatically * re-archived.
*/ inline CreateSnapshotResponse& WithRestoreExpiryTime(Aws::Utils::DateTime&& value) { SetRestoreExpiryTime(std::move(value)); return *this;} /** *Reserved for future use.
*/ inline const SSEType& GetSseType() const{ return m_sseType; } /** *Reserved for future use.
*/ inline void SetSseType(const SSEType& value) { m_sseType = value; } /** *Reserved for future use.
*/ inline void SetSseType(SSEType&& value) { m_sseType = std::move(value); } /** *Reserved for future use.
*/ inline CreateSnapshotResponse& WithSseType(const SSEType& value) { SetSseType(value); return *this;} /** *Reserved for future use.
*/ inline CreateSnapshotResponse& WithSseType(SSEType&& value) { SetSseType(std::move(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 CreateSnapshotResponse& WithResponseMetadata(const ResponseMetadata& value) { SetResponseMetadata(value); return *this;} inline CreateSnapshotResponse& WithResponseMetadata(ResponseMetadata&& value) { SetResponseMetadata(std::move(value)); return *this;} private: Aws::String m_dataEncryptionKeyId; Aws::String m_description; bool m_encrypted; Aws::String m_kmsKeyId; Aws::String m_ownerId; Aws::String m_progress; Aws::String m_snapshotId; Aws::Utils::DateTime m_startTime; SnapshotState m_state; Aws::String m_stateMessage; Aws::String m_volumeId; int m_volumeSize; Aws::String m_ownerAlias; Aws::String m_outpostArn; Aws::Vector