/**
* 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 bool DataEncryptionKeyIdHasBeenSet() const { return m_dataEncryptionKeyIdHasBeenSet; } /** *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_dataEncryptionKeyIdHasBeenSet = true; 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_dataEncryptionKeyIdHasBeenSet = true; 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_dataEncryptionKeyIdHasBeenSet = true; 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 Snapshot& 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 Snapshot& 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 Snapshot& 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 bool DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; } /** *The description for the snapshot.
*/ inline void SetDescription(const Aws::String& value) { m_descriptionHasBeenSet = true; m_description = value; } /** *The description for the snapshot.
*/ inline void SetDescription(Aws::String&& value) { m_descriptionHasBeenSet = true; m_description = std::move(value); } /** *The description for the snapshot.
*/ inline void SetDescription(const char* value) { m_descriptionHasBeenSet = true; m_description.assign(value); } /** *The description for the snapshot.
*/ inline Snapshot& WithDescription(const Aws::String& value) { SetDescription(value); return *this;} /** *The description for the snapshot.
*/ inline Snapshot& WithDescription(Aws::String&& value) { SetDescription(std::move(value)); return *this;} /** *The description for the snapshot.
*/ inline Snapshot& 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 bool EncryptedHasBeenSet() const { return m_encryptedHasBeenSet; } /** *Indicates whether the snapshot is encrypted.
*/ inline void SetEncrypted(bool value) { m_encryptedHasBeenSet = true; m_encrypted = value; } /** *Indicates whether the snapshot is encrypted.
*/ inline Snapshot& WithEncrypted(bool value) { SetEncrypted(value); return *this;} /** *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 parent volume.
*/ inline const Aws::String& GetKmsKeyId() const{ return m_kmsKeyId; } /** *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 parent volume.
*/ inline bool KmsKeyIdHasBeenSet() const { return m_kmsKeyIdHasBeenSet; } /** *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 parent volume.
*/ inline void SetKmsKeyId(const Aws::String& value) { m_kmsKeyIdHasBeenSet = true; m_kmsKeyId = value; } /** *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 parent volume.
*/ inline void SetKmsKeyId(Aws::String&& value) { m_kmsKeyIdHasBeenSet = true; m_kmsKeyId = std::move(value); } /** *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 parent volume.
*/ inline void SetKmsKeyId(const char* value) { m_kmsKeyIdHasBeenSet = true; m_kmsKeyId.assign(value); } /** *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 parent volume.
*/ inline Snapshot& WithKmsKeyId(const Aws::String& value) { SetKmsKeyId(value); return *this;} /** *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 parent volume.
*/ inline Snapshot& WithKmsKeyId(Aws::String&& value) { SetKmsKeyId(std::move(value)); return *this;} /** *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 parent volume.
*/ inline Snapshot& WithKmsKeyId(const char* value) { SetKmsKeyId(value); return *this;} /** *The AWS account ID of the EBS snapshot owner.
*/ inline const Aws::String& GetOwnerId() const{ return m_ownerId; } /** *The AWS account ID of the EBS snapshot owner.
*/ inline bool OwnerIdHasBeenSet() const { return m_ownerIdHasBeenSet; } /** *The AWS account ID of the EBS snapshot owner.
*/ inline void SetOwnerId(const Aws::String& value) { m_ownerIdHasBeenSet = true; m_ownerId = value; } /** *The AWS account ID of the EBS snapshot owner.
*/ inline void SetOwnerId(Aws::String&& value) { m_ownerIdHasBeenSet = true; m_ownerId = std::move(value); } /** *The AWS account ID of the EBS snapshot owner.
*/ inline void SetOwnerId(const char* value) { m_ownerIdHasBeenSet = true; m_ownerId.assign(value); } /** *The AWS account ID of the EBS snapshot owner.
*/ inline Snapshot& WithOwnerId(const Aws::String& value) { SetOwnerId(value); return *this;} /** *The AWS account ID of the EBS snapshot owner.
*/ inline Snapshot& WithOwnerId(Aws::String&& value) { SetOwnerId(std::move(value)); return *this;} /** *The AWS account ID of the EBS snapshot owner.
*/ inline Snapshot& 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 bool ProgressHasBeenSet() const { return m_progressHasBeenSet; } /** *The progress of the snapshot, as a percentage.
*/ inline void SetProgress(const Aws::String& value) { m_progressHasBeenSet = true; m_progress = value; } /** *The progress of the snapshot, as a percentage.
*/ inline void SetProgress(Aws::String&& value) { m_progressHasBeenSet = true; m_progress = std::move(value); } /** *The progress of the snapshot, as a percentage.
*/ inline void SetProgress(const char* value) { m_progressHasBeenSet = true; m_progress.assign(value); } /** *The progress of the snapshot, as a percentage.
*/ inline Snapshot& WithProgress(const Aws::String& value) { SetProgress(value); return *this;} /** *The progress of the snapshot, as a percentage.
*/ inline Snapshot& WithProgress(Aws::String&& value) { SetProgress(std::move(value)); return *this;} /** *The progress of the snapshot, as a percentage.
*/ inline Snapshot& 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 bool SnapshotIdHasBeenSet() const { return m_snapshotIdHasBeenSet; } /** *The ID of the snapshot. Each snapshot receives a unique identifier when it is * created.
*/ inline void SetSnapshotId(const Aws::String& value) { m_snapshotIdHasBeenSet = true; 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_snapshotIdHasBeenSet = true; 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_snapshotIdHasBeenSet = true; m_snapshotId.assign(value); } /** *The ID of the snapshot. Each snapshot receives a unique identifier when it is * created.
*/ inline Snapshot& 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 Snapshot& 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 Snapshot& 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 bool StartTimeHasBeenSet() const { return m_startTimeHasBeenSet; } /** *The time stamp when the snapshot was initiated.
*/ inline void SetStartTime(const Aws::Utils::DateTime& value) { m_startTimeHasBeenSet = true; m_startTime = value; } /** *The time stamp when the snapshot was initiated.
*/ inline void SetStartTime(Aws::Utils::DateTime&& value) { m_startTimeHasBeenSet = true; m_startTime = std::move(value); } /** *The time stamp when the snapshot was initiated.
*/ inline Snapshot& WithStartTime(const Aws::Utils::DateTime& value) { SetStartTime(value); return *this;} /** *The time stamp when the snapshot was initiated.
*/ inline Snapshot& 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 bool StateHasBeenSet() const { return m_stateHasBeenSet; } /** *The snapshot state.
*/ inline void SetState(const SnapshotState& value) { m_stateHasBeenSet = true; m_state = value; } /** *The snapshot state.
*/ inline void SetState(SnapshotState&& value) { m_stateHasBeenSet = true; m_state = std::move(value); } /** *The snapshot state.
*/ inline Snapshot& WithState(const SnapshotState& value) { SetState(value); return *this;} /** *The snapshot state.
*/ inline Snapshot& 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 AWS Key Management Service (AWS 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 AWS Key Management Service (AWS 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 bool StateMessageHasBeenSet() const { return m_stateMessageHasBeenSet; } /** *Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy * operation fails (for example, if the proper AWS Key Management Service (AWS 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_stateMessageHasBeenSet = true; m_stateMessage = value; } /** *Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy * operation fails (for example, if the proper AWS Key Management Service (AWS 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_stateMessageHasBeenSet = true; m_stateMessage = std::move(value); } /** *Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy * operation fails (for example, if the proper AWS Key Management Service (AWS 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_stateMessageHasBeenSet = true; m_stateMessage.assign(value); } /** *Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy * operation fails (for example, if the proper AWS Key Management Service (AWS 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 Snapshot& 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 AWS Key Management Service (AWS 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 Snapshot& 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 AWS Key Management Service (AWS 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 Snapshot& 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 bool VolumeIdHasBeenSet() const { return m_volumeIdHasBeenSet; } /** *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_volumeIdHasBeenSet = true; 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_volumeIdHasBeenSet = true; 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_volumeIdHasBeenSet = true; 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 Snapshot& 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 Snapshot& 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 Snapshot& 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 bool VolumeSizeHasBeenSet() const { return m_volumeSizeHasBeenSet; } /** *The size of the volume, in GiB.
*/ inline void SetVolumeSize(int value) { m_volumeSizeHasBeenSet = true; m_volumeSize = value; } /** *The size of the volume, in GiB.
*/ inline Snapshot& WithVolumeSize(int value) { SetVolumeSize(value); return *this;} /** *The AWS owner alias, as maintained by Amazon. The possible values are:
* amazon | self | all |
* aws-marketplace | microsoft. This AWS owner alias is
* not to be confused with the user-configured AWS account alias, which is set from
* the IAM console.
The AWS owner alias, as maintained by Amazon. The possible values are:
* amazon | self | all |
* aws-marketplace | microsoft. This AWS owner alias is
* not to be confused with the user-configured AWS account alias, which is set from
* the IAM console.
The AWS owner alias, as maintained by Amazon. The possible values are:
* amazon | self | all |
* aws-marketplace | microsoft. This AWS owner alias is
* not to be confused with the user-configured AWS account alias, which is set from
* the IAM console.
The AWS owner alias, as maintained by Amazon. The possible values are:
* amazon | self | all |
* aws-marketplace | microsoft. This AWS owner alias is
* not to be confused with the user-configured AWS account alias, which is set from
* the IAM console.
The AWS owner alias, as maintained by Amazon. The possible values are:
* amazon | self | all |
* aws-marketplace | microsoft. This AWS owner alias is
* not to be confused with the user-configured AWS account alias, which is set from
* the IAM console.
The AWS owner alias, as maintained by Amazon. The possible values are:
* amazon | self | all |
* aws-marketplace | microsoft. This AWS owner alias is
* not to be confused with the user-configured AWS account alias, which is set from
* the IAM console.
The AWS owner alias, as maintained by Amazon. The possible values are:
* amazon | self | all |
* aws-marketplace | microsoft. This AWS owner alias is
* not to be confused with the user-configured AWS account alias, which is set from
* the IAM console.
The AWS owner alias, as maintained by Amazon. The possible values are:
* amazon | self | all |
* aws-marketplace | microsoft. This AWS owner alias is
* not to be confused with the user-configured AWS account alias, which is set from
* the IAM console.
Any tags assigned to the snapshot.
*/ inline const Aws::VectorAny tags assigned to the snapshot.
*/ inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; } /** *Any 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 Snapshot& WithTags(const Aws::VectorAny tags assigned to the snapshot.
*/ inline Snapshot& WithTags(Aws::VectorAny tags assigned to the snapshot.
*/ inline Snapshot& AddTags(const Tag& value) { m_tagsHasBeenSet = true; m_tags.push_back(value); return *this; } /** *Any tags assigned to the snapshot.
*/ inline Snapshot& AddTags(Tag&& value) { m_tagsHasBeenSet = true; m_tags.push_back(std::move(value)); return *this; } inline const ResponseMetadata& GetResponseMetadata() const{ return m_responseMetadata; } inline bool ResponseMetadataHasBeenSet() const { return m_responseMetadataHasBeenSet; } inline void SetResponseMetadata(const ResponseMetadata& value) { m_responseMetadataHasBeenSet = true; m_responseMetadata = value; } inline void SetResponseMetadata(ResponseMetadata&& value) { m_responseMetadataHasBeenSet = true; m_responseMetadata = std::move(value); } inline Snapshot& WithResponseMetadata(const ResponseMetadata& value) { SetResponseMetadata(value); return *this;} inline Snapshot& WithResponseMetadata(ResponseMetadata&& value) { SetResponseMetadata(std::move(value)); return *this;} private: Aws::String m_dataEncryptionKeyId; bool m_dataEncryptionKeyIdHasBeenSet; Aws::String m_description; bool m_descriptionHasBeenSet; bool m_encrypted; bool m_encryptedHasBeenSet; Aws::String m_kmsKeyId; bool m_kmsKeyIdHasBeenSet; Aws::String m_ownerId; bool m_ownerIdHasBeenSet; Aws::String m_progress; bool m_progressHasBeenSet; Aws::String m_snapshotId; bool m_snapshotIdHasBeenSet; Aws::Utils::DateTime m_startTime; bool m_startTimeHasBeenSet; SnapshotState m_state; bool m_stateHasBeenSet; Aws::String m_stateMessage; bool m_stateMessageHasBeenSet; Aws::String m_volumeId; bool m_volumeIdHasBeenSet; int m_volumeSize; bool m_volumeSizeHasBeenSet; Aws::String m_ownerAlias; bool m_ownerAliasHasBeenSet; Aws::Vector