AWS SDK for C++  1.9.109
AWS SDK for C++
Public Member Functions | List of all members
Aws::EC2::Model::Snapshot Class Reference

#include <Snapshot.h>

Public Member Functions

 Snapshot ()
 
 Snapshot (const Aws::Utils::Xml::XmlNode &xmlNode)
 
Snapshotoperator= (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
 
const Aws::StringGetDataEncryptionKeyId () const
 
bool DataEncryptionKeyIdHasBeenSet () const
 
void SetDataEncryptionKeyId (const Aws::String &value)
 
void SetDataEncryptionKeyId (Aws::String &&value)
 
void SetDataEncryptionKeyId (const char *value)
 
SnapshotWithDataEncryptionKeyId (const Aws::String &value)
 
SnapshotWithDataEncryptionKeyId (Aws::String &&value)
 
SnapshotWithDataEncryptionKeyId (const char *value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
SnapshotWithDescription (const Aws::String &value)
 
SnapshotWithDescription (Aws::String &&value)
 
SnapshotWithDescription (const char *value)
 
bool GetEncrypted () const
 
bool EncryptedHasBeenSet () const
 
void SetEncrypted (bool value)
 
SnapshotWithEncrypted (bool value)
 
const Aws::StringGetKmsKeyId () const
 
bool KmsKeyIdHasBeenSet () const
 
void SetKmsKeyId (const Aws::String &value)
 
void SetKmsKeyId (Aws::String &&value)
 
void SetKmsKeyId (const char *value)
 
SnapshotWithKmsKeyId (const Aws::String &value)
 
SnapshotWithKmsKeyId (Aws::String &&value)
 
SnapshotWithKmsKeyId (const char *value)
 
const Aws::StringGetOwnerId () const
 
bool OwnerIdHasBeenSet () const
 
void SetOwnerId (const Aws::String &value)
 
void SetOwnerId (Aws::String &&value)
 
void SetOwnerId (const char *value)
 
SnapshotWithOwnerId (const Aws::String &value)
 
SnapshotWithOwnerId (Aws::String &&value)
 
SnapshotWithOwnerId (const char *value)
 
const Aws::StringGetProgress () const
 
bool ProgressHasBeenSet () const
 
void SetProgress (const Aws::String &value)
 
void SetProgress (Aws::String &&value)
 
void SetProgress (const char *value)
 
SnapshotWithProgress (const Aws::String &value)
 
SnapshotWithProgress (Aws::String &&value)
 
SnapshotWithProgress (const char *value)
 
const Aws::StringGetSnapshotId () const
 
bool SnapshotIdHasBeenSet () const
 
void SetSnapshotId (const Aws::String &value)
 
void SetSnapshotId (Aws::String &&value)
 
void SetSnapshotId (const char *value)
 
SnapshotWithSnapshotId (const Aws::String &value)
 
SnapshotWithSnapshotId (Aws::String &&value)
 
SnapshotWithSnapshotId (const char *value)
 
const Aws::Utils::DateTimeGetStartTime () const
 
bool StartTimeHasBeenSet () const
 
void SetStartTime (const Aws::Utils::DateTime &value)
 
void SetStartTime (Aws::Utils::DateTime &&value)
 
SnapshotWithStartTime (const Aws::Utils::DateTime &value)
 
SnapshotWithStartTime (Aws::Utils::DateTime &&value)
 
const SnapshotStateGetState () const
 
bool StateHasBeenSet () const
 
void SetState (const SnapshotState &value)
 
void SetState (SnapshotState &&value)
 
SnapshotWithState (const SnapshotState &value)
 
SnapshotWithState (SnapshotState &&value)
 
const Aws::StringGetStateMessage () const
 
bool StateMessageHasBeenSet () const
 
void SetStateMessage (const Aws::String &value)
 
void SetStateMessage (Aws::String &&value)
 
void SetStateMessage (const char *value)
 
SnapshotWithStateMessage (const Aws::String &value)
 
SnapshotWithStateMessage (Aws::String &&value)
 
SnapshotWithStateMessage (const char *value)
 
const Aws::StringGetVolumeId () const
 
bool VolumeIdHasBeenSet () const
 
void SetVolumeId (const Aws::String &value)
 
void SetVolumeId (Aws::String &&value)
 
void SetVolumeId (const char *value)
 
SnapshotWithVolumeId (const Aws::String &value)
 
SnapshotWithVolumeId (Aws::String &&value)
 
SnapshotWithVolumeId (const char *value)
 
int GetVolumeSize () const
 
bool VolumeSizeHasBeenSet () const
 
void SetVolumeSize (int value)
 
SnapshotWithVolumeSize (int value)
 
const Aws::StringGetOwnerAlias () const
 
bool OwnerAliasHasBeenSet () const
 
void SetOwnerAlias (const Aws::String &value)
 
void SetOwnerAlias (Aws::String &&value)
 
void SetOwnerAlias (const char *value)
 
SnapshotWithOwnerAlias (const Aws::String &value)
 
SnapshotWithOwnerAlias (Aws::String &&value)
 
SnapshotWithOwnerAlias (const char *value)
 
const Aws::StringGetOutpostArn () const
 
bool OutpostArnHasBeenSet () const
 
void SetOutpostArn (const Aws::String &value)
 
void SetOutpostArn (Aws::String &&value)
 
void SetOutpostArn (const char *value)
 
SnapshotWithOutpostArn (const Aws::String &value)
 
SnapshotWithOutpostArn (Aws::String &&value)
 
SnapshotWithOutpostArn (const char *value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
SnapshotWithTags (const Aws::Vector< Tag > &value)
 
SnapshotWithTags (Aws::Vector< Tag > &&value)
 
SnapshotAddTags (const Tag &value)
 
SnapshotAddTags (Tag &&value)
 
const ResponseMetadataGetResponseMetadata () const
 
bool ResponseMetadataHasBeenSet () const
 
void SetResponseMetadata (const ResponseMetadata &value)
 
void SetResponseMetadata (ResponseMetadata &&value)
 
SnapshotWithResponseMetadata (const ResponseMetadata &value)
 
SnapshotWithResponseMetadata (ResponseMetadata &&value)
 

Detailed Description

Describes a snapshot.

See Also:

AWS API Reference

Definition at line 36 of file Snapshot.h.

Constructor & Destructor Documentation

◆ Snapshot() [1/2]

Aws::EC2::Model::Snapshot::Snapshot ( )

◆ Snapshot() [2/2]

Aws::EC2::Model::Snapshot::Snapshot ( const Aws::Utils::Xml::XmlNode xmlNode)

Member Function Documentation

◆ AddTags() [1/2]

Snapshot& Aws::EC2::Model::Snapshot::AddTags ( const Tag value)
inline

Any tags assigned to the snapshot.

Definition at line 746 of file Snapshot.h.

◆ AddTags() [2/2]

Snapshot& Aws::EC2::Model::Snapshot::AddTags ( Tag &&  value)
inline

Any tags assigned to the snapshot.

Definition at line 751 of file Snapshot.h.

◆ DataEncryptionKeyIdHasBeenSet()

bool Aws::EC2::Model::Snapshot::DataEncryptionKeyIdHasBeenSet ( ) const
inline

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.

Definition at line 65 of file Snapshot.h.

◆ DescriptionHasBeenSet()

bool Aws::EC2::Model::Snapshot::DescriptionHasBeenSet ( ) const
inline

The description for the snapshot.

Definition at line 136 of file Snapshot.h.

◆ EncryptedHasBeenSet()

bool Aws::EC2::Model::Snapshot::EncryptedHasBeenSet ( ) const
inline

Indicates whether the snapshot is encrypted.

Definition at line 177 of file Snapshot.h.

◆ GetDataEncryptionKeyId()

const Aws::String& Aws::EC2::Model::Snapshot::GetDataEncryptionKeyId ( ) const
inline

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.

Definition at line 55 of file Snapshot.h.

◆ GetDescription()

const Aws::String& Aws::EC2::Model::Snapshot::GetDescription ( ) const
inline

The description for the snapshot.

Definition at line 131 of file Snapshot.h.

◆ GetEncrypted()

bool Aws::EC2::Model::Snapshot::GetEncrypted ( ) const
inline

Indicates whether the snapshot is encrypted.

Definition at line 172 of file Snapshot.h.

◆ GetKmsKeyId()

const Aws::String& Aws::EC2::Model::Snapshot::GetKmsKeyId ( ) const
inline

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.

Definition at line 194 of file Snapshot.h.

◆ GetOutpostArn()

const Aws::String& Aws::EC2::Model::Snapshot::GetOutpostArn ( ) const
inline

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.

Definition at line 647 of file Snapshot.h.

◆ GetOwnerAlias()

const Aws::String& Aws::EC2::Model::Snapshot::GetOwnerAlias ( ) const
inline

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.

Definition at line 588 of file Snapshot.h.

◆ GetOwnerId()

const Aws::String& Aws::EC2::Model::Snapshot::GetOwnerId ( ) const
inline

The ID of the Amazon Web Services account that owns the EBS snapshot.

Definition at line 242 of file Snapshot.h.

◆ GetProgress()

const Aws::String& Aws::EC2::Model::Snapshot::GetProgress ( ) const
inline

The progress of the snapshot, as a percentage.

Definition at line 283 of file Snapshot.h.

◆ GetResponseMetadata()

const ResponseMetadata& Aws::EC2::Model::Snapshot::GetResponseMetadata ( ) const
inline

Definition at line 755 of file Snapshot.h.

◆ GetSnapshotId()

const Aws::String& Aws::EC2::Model::Snapshot::GetSnapshotId ( ) const
inline

The ID of the snapshot. Each snapshot receives a unique identifier when it is created.

Definition at line 325 of file Snapshot.h.

◆ GetStartTime()

const Aws::Utils::DateTime& Aws::EC2::Model::Snapshot::GetStartTime ( ) const
inline

The time stamp when the snapshot was initiated.

Definition at line 373 of file Snapshot.h.

◆ GetState()

const SnapshotState& Aws::EC2::Model::Snapshot::GetState ( ) const
inline

The snapshot state.

Definition at line 404 of file Snapshot.h.

◆ GetStateMessage()

const Aws::String& Aws::EC2::Model::Snapshot::GetStateMessage ( ) const
inline

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.

Definition at line 439 of file Snapshot.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::EC2::Model::Snapshot::GetTags ( ) const
inline

Any tags assigned to the snapshot.

Definition at line 716 of file Snapshot.h.

◆ GetVolumeId()

const Aws::String& Aws::EC2::Model::Snapshot::GetVolumeId ( ) const
inline

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.

Definition at line 510 of file Snapshot.h.

◆ GetVolumeSize()

int Aws::EC2::Model::Snapshot::GetVolumeSize ( ) const
inline

The size of the volume, in GiB.

Definition at line 565 of file Snapshot.h.

◆ KmsKeyIdHasBeenSet()

bool Aws::EC2::Model::Snapshot::KmsKeyIdHasBeenSet ( ) const
inline

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.

Definition at line 200 of file Snapshot.h.

◆ operator=()

Snapshot& Aws::EC2::Model::Snapshot::operator= ( const Aws::Utils::Xml::XmlNode xmlNode)

◆ OutpostArnHasBeenSet()

bool Aws::EC2::Model::Snapshot::OutpostArnHasBeenSet ( ) const
inline

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.

Definition at line 656 of file Snapshot.h.

◆ OutputToStream() [1/2]

void Aws::EC2::Model::Snapshot::OutputToStream ( Aws::OStream oStream,
const char *  location 
) const

◆ OutputToStream() [2/2]

void Aws::EC2::Model::Snapshot::OutputToStream ( Aws::OStream ostream,
const char *  location,
unsigned  index,
const char *  locationValue 
) const

◆ OwnerAliasHasBeenSet()

bool Aws::EC2::Model::Snapshot::OwnerAliasHasBeenSet ( ) const
inline

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.

Definition at line 595 of file Snapshot.h.

◆ OwnerIdHasBeenSet()

bool Aws::EC2::Model::Snapshot::OwnerIdHasBeenSet ( ) const
inline

The ID of the Amazon Web Services account that owns the EBS snapshot.

Definition at line 247 of file Snapshot.h.

◆ ProgressHasBeenSet()

bool Aws::EC2::Model::Snapshot::ProgressHasBeenSet ( ) const
inline

The progress of the snapshot, as a percentage.

Definition at line 288 of file Snapshot.h.

◆ ResponseMetadataHasBeenSet()

bool Aws::EC2::Model::Snapshot::ResponseMetadataHasBeenSet ( ) const
inline

Definition at line 758 of file Snapshot.h.

◆ SetDataEncryptionKeyId() [1/3]

void Aws::EC2::Model::Snapshot::SetDataEncryptionKeyId ( Aws::String &&  value)
inline

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.

Definition at line 85 of file Snapshot.h.

◆ SetDataEncryptionKeyId() [2/3]

void Aws::EC2::Model::Snapshot::SetDataEncryptionKeyId ( const Aws::String value)
inline

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.

Definition at line 75 of file Snapshot.h.

◆ SetDataEncryptionKeyId() [3/3]

void Aws::EC2::Model::Snapshot::SetDataEncryptionKeyId ( const char *  value)
inline

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.

Definition at line 95 of file Snapshot.h.

◆ SetDescription() [1/3]

void Aws::EC2::Model::Snapshot::SetDescription ( Aws::String &&  value)
inline

The description for the snapshot.

Definition at line 146 of file Snapshot.h.

◆ SetDescription() [2/3]

void Aws::EC2::Model::Snapshot::SetDescription ( const Aws::String value)
inline

The description for the snapshot.

Definition at line 141 of file Snapshot.h.

◆ SetDescription() [3/3]

void Aws::EC2::Model::Snapshot::SetDescription ( const char *  value)
inline

The description for the snapshot.

Definition at line 151 of file Snapshot.h.

◆ SetEncrypted()

void Aws::EC2::Model::Snapshot::SetEncrypted ( bool  value)
inline

Indicates whether the snapshot is encrypted.

Definition at line 182 of file Snapshot.h.

◆ SetKmsKeyId() [1/3]

void Aws::EC2::Model::Snapshot::SetKmsKeyId ( Aws::String &&  value)
inline

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.

Definition at line 212 of file Snapshot.h.

◆ SetKmsKeyId() [2/3]

void Aws::EC2::Model::Snapshot::SetKmsKeyId ( const Aws::String value)
inline

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.

Definition at line 206 of file Snapshot.h.

◆ SetKmsKeyId() [3/3]

void Aws::EC2::Model::Snapshot::SetKmsKeyId ( const char *  value)
inline

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.

Definition at line 218 of file Snapshot.h.

◆ SetOutpostArn() [1/3]

void Aws::EC2::Model::Snapshot::SetOutpostArn ( Aws::String &&  value)
inline

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.

Definition at line 674 of file Snapshot.h.

◆ SetOutpostArn() [2/3]

void Aws::EC2::Model::Snapshot::SetOutpostArn ( const Aws::String value)
inline

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.

Definition at line 665 of file Snapshot.h.

◆ SetOutpostArn() [3/3]

void Aws::EC2::Model::Snapshot::SetOutpostArn ( const char *  value)
inline

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.

Definition at line 683 of file Snapshot.h.

◆ SetOwnerAlias() [1/3]

void Aws::EC2::Model::Snapshot::SetOwnerAlias ( Aws::String &&  value)
inline

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.

Definition at line 609 of file Snapshot.h.

◆ SetOwnerAlias() [2/3]

void Aws::EC2::Model::Snapshot::SetOwnerAlias ( const Aws::String value)
inline

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.

Definition at line 602 of file Snapshot.h.

◆ SetOwnerAlias() [3/3]

void Aws::EC2::Model::Snapshot::SetOwnerAlias ( const char *  value)
inline

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.

Definition at line 616 of file Snapshot.h.

◆ SetOwnerId() [1/3]

void Aws::EC2::Model::Snapshot::SetOwnerId ( Aws::String &&  value)
inline

The ID of the Amazon Web Services account that owns the EBS snapshot.

Definition at line 257 of file Snapshot.h.

◆ SetOwnerId() [2/3]

void Aws::EC2::Model::Snapshot::SetOwnerId ( const Aws::String value)
inline

The ID of the Amazon Web Services account that owns the EBS snapshot.

Definition at line 252 of file Snapshot.h.

◆ SetOwnerId() [3/3]

void Aws::EC2::Model::Snapshot::SetOwnerId ( const char *  value)
inline

The ID of the Amazon Web Services account that owns the EBS snapshot.

Definition at line 262 of file Snapshot.h.

◆ SetProgress() [1/3]

void Aws::EC2::Model::Snapshot::SetProgress ( Aws::String &&  value)
inline

The progress of the snapshot, as a percentage.

Definition at line 298 of file Snapshot.h.

◆ SetProgress() [2/3]

void Aws::EC2::Model::Snapshot::SetProgress ( const Aws::String value)
inline

The progress of the snapshot, as a percentage.

Definition at line 293 of file Snapshot.h.

◆ SetProgress() [3/3]

void Aws::EC2::Model::Snapshot::SetProgress ( const char *  value)
inline

The progress of the snapshot, as a percentage.

Definition at line 303 of file Snapshot.h.

◆ SetResponseMetadata() [1/2]

void Aws::EC2::Model::Snapshot::SetResponseMetadata ( const ResponseMetadata value)
inline

Definition at line 761 of file Snapshot.h.

◆ SetResponseMetadata() [2/2]

void Aws::EC2::Model::Snapshot::SetResponseMetadata ( ResponseMetadata &&  value)
inline

Definition at line 764 of file Snapshot.h.

◆ SetSnapshotId() [1/3]

void Aws::EC2::Model::Snapshot::SetSnapshotId ( Aws::String &&  value)
inline

The ID of the snapshot. Each snapshot receives a unique identifier when it is created.

Definition at line 343 of file Snapshot.h.

◆ SetSnapshotId() [2/3]

void Aws::EC2::Model::Snapshot::SetSnapshotId ( const Aws::String value)
inline

The ID of the snapshot. Each snapshot receives a unique identifier when it is created.

Definition at line 337 of file Snapshot.h.

◆ SetSnapshotId() [3/3]

void Aws::EC2::Model::Snapshot::SetSnapshotId ( const char *  value)
inline

The ID of the snapshot. Each snapshot receives a unique identifier when it is created.

Definition at line 349 of file Snapshot.h.

◆ SetStartTime() [1/2]

void Aws::EC2::Model::Snapshot::SetStartTime ( Aws::Utils::DateTime &&  value)
inline

The time stamp when the snapshot was initiated.

Definition at line 388 of file Snapshot.h.

◆ SetStartTime() [2/2]

void Aws::EC2::Model::Snapshot::SetStartTime ( const Aws::Utils::DateTime value)
inline

The time stamp when the snapshot was initiated.

Definition at line 383 of file Snapshot.h.

◆ SetState() [1/2]

void Aws::EC2::Model::Snapshot::SetState ( const SnapshotState value)
inline

The snapshot state.

Definition at line 414 of file Snapshot.h.

◆ SetState() [2/2]

void Aws::EC2::Model::Snapshot::SetState ( SnapshotState &&  value)
inline

The snapshot state.

Definition at line 419 of file Snapshot.h.

◆ SetStateMessage() [1/3]

void Aws::EC2::Model::Snapshot::SetStateMessage ( Aws::String &&  value)
inline

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.

Definition at line 466 of file Snapshot.h.

◆ SetStateMessage() [2/3]

void Aws::EC2::Model::Snapshot::SetStateMessage ( const Aws::String value)
inline

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.

Definition at line 457 of file Snapshot.h.

◆ SetStateMessage() [3/3]

void Aws::EC2::Model::Snapshot::SetStateMessage ( const char *  value)
inline

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.

Definition at line 475 of file Snapshot.h.

◆ SetTags() [1/2]

void Aws::EC2::Model::Snapshot::SetTags ( Aws::Vector< Tag > &&  value)
inline

Any tags assigned to the snapshot.

Definition at line 731 of file Snapshot.h.

◆ SetTags() [2/2]

void Aws::EC2::Model::Snapshot::SetTags ( const Aws::Vector< Tag > &  value)
inline

Any tags assigned to the snapshot.

Definition at line 726 of file Snapshot.h.

◆ SetVolumeId() [1/3]

void Aws::EC2::Model::Snapshot::SetVolumeId ( Aws::String &&  value)
inline

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.

Definition at line 531 of file Snapshot.h.

◆ SetVolumeId() [2/3]

void Aws::EC2::Model::Snapshot::SetVolumeId ( const Aws::String value)
inline

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.

Definition at line 524 of file Snapshot.h.

◆ SetVolumeId() [3/3]

void Aws::EC2::Model::Snapshot::SetVolumeId ( const char *  value)
inline

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.

Definition at line 538 of file Snapshot.h.

◆ SetVolumeSize()

void Aws::EC2::Model::Snapshot::SetVolumeSize ( int  value)
inline

The size of the volume, in GiB.

Definition at line 575 of file Snapshot.h.

◆ SnapshotIdHasBeenSet()

bool Aws::EC2::Model::Snapshot::SnapshotIdHasBeenSet ( ) const
inline

The ID of the snapshot. Each snapshot receives a unique identifier when it is created.

Definition at line 331 of file Snapshot.h.

◆ StartTimeHasBeenSet()

bool Aws::EC2::Model::Snapshot::StartTimeHasBeenSet ( ) const
inline

The time stamp when the snapshot was initiated.

Definition at line 378 of file Snapshot.h.

◆ StateHasBeenSet()

bool Aws::EC2::Model::Snapshot::StateHasBeenSet ( ) const
inline

The snapshot state.

Definition at line 409 of file Snapshot.h.

◆ StateMessageHasBeenSet()

bool Aws::EC2::Model::Snapshot::StateMessageHasBeenSet ( ) const
inline

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.

Definition at line 448 of file Snapshot.h.

◆ TagsHasBeenSet()

bool Aws::EC2::Model::Snapshot::TagsHasBeenSet ( ) const
inline

Any tags assigned to the snapshot.

Definition at line 721 of file Snapshot.h.

◆ VolumeIdHasBeenSet()

bool Aws::EC2::Model::Snapshot::VolumeIdHasBeenSet ( ) const
inline

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.

Definition at line 517 of file Snapshot.h.

◆ VolumeSizeHasBeenSet()

bool Aws::EC2::Model::Snapshot::VolumeSizeHasBeenSet ( ) const
inline

The size of the volume, in GiB.

Definition at line 570 of file Snapshot.h.

◆ WithDataEncryptionKeyId() [1/3]

Snapshot& Aws::EC2::Model::Snapshot::WithDataEncryptionKeyId ( Aws::String &&  value)
inline

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.

Definition at line 115 of file Snapshot.h.

◆ WithDataEncryptionKeyId() [2/3]

Snapshot& Aws::EC2::Model::Snapshot::WithDataEncryptionKeyId ( const Aws::String value)
inline

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.

Definition at line 105 of file Snapshot.h.

◆ WithDataEncryptionKeyId() [3/3]

Snapshot& Aws::EC2::Model::Snapshot::WithDataEncryptionKeyId ( const char *  value)
inline

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.

Definition at line 125 of file Snapshot.h.

◆ WithDescription() [1/3]

Snapshot& Aws::EC2::Model::Snapshot::WithDescription ( Aws::String &&  value)
inline

The description for the snapshot.

Definition at line 161 of file Snapshot.h.

◆ WithDescription() [2/3]

Snapshot& Aws::EC2::Model::Snapshot::WithDescription ( const Aws::String value)
inline

The description for the snapshot.

Definition at line 156 of file Snapshot.h.

◆ WithDescription() [3/3]

Snapshot& Aws::EC2::Model::Snapshot::WithDescription ( const char *  value)
inline

The description for the snapshot.

Definition at line 166 of file Snapshot.h.

◆ WithEncrypted()

Snapshot& Aws::EC2::Model::Snapshot::WithEncrypted ( bool  value)
inline

Indicates whether the snapshot is encrypted.

Definition at line 187 of file Snapshot.h.

◆ WithKmsKeyId() [1/3]

Snapshot& Aws::EC2::Model::Snapshot::WithKmsKeyId ( Aws::String &&  value)
inline

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.

Definition at line 230 of file Snapshot.h.

◆ WithKmsKeyId() [2/3]

Snapshot& Aws::EC2::Model::Snapshot::WithKmsKeyId ( const Aws::String value)
inline

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.

Definition at line 224 of file Snapshot.h.

◆ WithKmsKeyId() [3/3]

Snapshot& Aws::EC2::Model::Snapshot::WithKmsKeyId ( const char *  value)
inline

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.

Definition at line 236 of file Snapshot.h.

◆ WithOutpostArn() [1/3]

Snapshot& Aws::EC2::Model::Snapshot::WithOutpostArn ( Aws::String &&  value)
inline

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.

Definition at line 701 of file Snapshot.h.

◆ WithOutpostArn() [2/3]

Snapshot& Aws::EC2::Model::Snapshot::WithOutpostArn ( const Aws::String value)
inline

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.

Definition at line 692 of file Snapshot.h.

◆ WithOutpostArn() [3/3]

Snapshot& Aws::EC2::Model::Snapshot::WithOutpostArn ( const char *  value)
inline

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.

Definition at line 710 of file Snapshot.h.

◆ WithOwnerAlias() [1/3]

Snapshot& Aws::EC2::Model::Snapshot::WithOwnerAlias ( Aws::String &&  value)
inline

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.

Definition at line 630 of file Snapshot.h.

◆ WithOwnerAlias() [2/3]

Snapshot& Aws::EC2::Model::Snapshot::WithOwnerAlias ( const Aws::String value)
inline

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.

Definition at line 623 of file Snapshot.h.

◆ WithOwnerAlias() [3/3]

Snapshot& Aws::EC2::Model::Snapshot::WithOwnerAlias ( const char *  value)
inline

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.

Definition at line 637 of file Snapshot.h.

◆ WithOwnerId() [1/3]

Snapshot& Aws::EC2::Model::Snapshot::WithOwnerId ( Aws::String &&  value)
inline

The ID of the Amazon Web Services account that owns the EBS snapshot.

Definition at line 272 of file Snapshot.h.

◆ WithOwnerId() [2/3]

Snapshot& Aws::EC2::Model::Snapshot::WithOwnerId ( const Aws::String value)
inline

The ID of the Amazon Web Services account that owns the EBS snapshot.

Definition at line 267 of file Snapshot.h.

◆ WithOwnerId() [3/3]

Snapshot& Aws::EC2::Model::Snapshot::WithOwnerId ( const char *  value)
inline

The ID of the Amazon Web Services account that owns the EBS snapshot.

Definition at line 277 of file Snapshot.h.

◆ WithProgress() [1/3]

Snapshot& Aws::EC2::Model::Snapshot::WithProgress ( Aws::String &&  value)
inline

The progress of the snapshot, as a percentage.

Definition at line 313 of file Snapshot.h.

◆ WithProgress() [2/3]

Snapshot& Aws::EC2::Model::Snapshot::WithProgress ( const Aws::String value)
inline

The progress of the snapshot, as a percentage.

Definition at line 308 of file Snapshot.h.

◆ WithProgress() [3/3]

Snapshot& Aws::EC2::Model::Snapshot::WithProgress ( const char *  value)
inline

The progress of the snapshot, as a percentage.

Definition at line 318 of file Snapshot.h.

◆ WithResponseMetadata() [1/2]

Snapshot& Aws::EC2::Model::Snapshot::WithResponseMetadata ( const ResponseMetadata value)
inline

Definition at line 767 of file Snapshot.h.

◆ WithResponseMetadata() [2/2]

Snapshot& Aws::EC2::Model::Snapshot::WithResponseMetadata ( ResponseMetadata &&  value)
inline

Definition at line 770 of file Snapshot.h.

◆ WithSnapshotId() [1/3]

Snapshot& Aws::EC2::Model::Snapshot::WithSnapshotId ( Aws::String &&  value)
inline

The ID of the snapshot. Each snapshot receives a unique identifier when it is created.

Definition at line 361 of file Snapshot.h.

◆ WithSnapshotId() [2/3]

Snapshot& Aws::EC2::Model::Snapshot::WithSnapshotId ( const Aws::String value)
inline

The ID of the snapshot. Each snapshot receives a unique identifier when it is created.

Definition at line 355 of file Snapshot.h.

◆ WithSnapshotId() [3/3]

Snapshot& Aws::EC2::Model::Snapshot::WithSnapshotId ( const char *  value)
inline

The ID of the snapshot. Each snapshot receives a unique identifier when it is created.

Definition at line 367 of file Snapshot.h.

◆ WithStartTime() [1/2]

Snapshot& Aws::EC2::Model::Snapshot::WithStartTime ( Aws::Utils::DateTime &&  value)
inline

The time stamp when the snapshot was initiated.

Definition at line 398 of file Snapshot.h.

◆ WithStartTime() [2/2]

Snapshot& Aws::EC2::Model::Snapshot::WithStartTime ( const Aws::Utils::DateTime value)
inline

The time stamp when the snapshot was initiated.

Definition at line 393 of file Snapshot.h.

◆ WithState() [1/2]

Snapshot& Aws::EC2::Model::Snapshot::WithState ( const SnapshotState value)
inline

The snapshot state.

Definition at line 424 of file Snapshot.h.

◆ WithState() [2/2]

Snapshot& Aws::EC2::Model::Snapshot::WithState ( SnapshotState &&  value)
inline

The snapshot state.

Definition at line 429 of file Snapshot.h.

◆ WithStateMessage() [1/3]

Snapshot& Aws::EC2::Model::Snapshot::WithStateMessage ( Aws::String &&  value)
inline

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.

Definition at line 493 of file Snapshot.h.

◆ WithStateMessage() [2/3]

Snapshot& Aws::EC2::Model::Snapshot::WithStateMessage ( const Aws::String value)
inline

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.

Definition at line 484 of file Snapshot.h.

◆ WithStateMessage() [3/3]

Snapshot& Aws::EC2::Model::Snapshot::WithStateMessage ( const char *  value)
inline

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.

Definition at line 502 of file Snapshot.h.

◆ WithTags() [1/2]

Snapshot& Aws::EC2::Model::Snapshot::WithTags ( Aws::Vector< Tag > &&  value)
inline

Any tags assigned to the snapshot.

Definition at line 741 of file Snapshot.h.

◆ WithTags() [2/2]

Snapshot& Aws::EC2::Model::Snapshot::WithTags ( const Aws::Vector< Tag > &  value)
inline

Any tags assigned to the snapshot.

Definition at line 736 of file Snapshot.h.

◆ WithVolumeId() [1/3]

Snapshot& Aws::EC2::Model::Snapshot::WithVolumeId ( Aws::String &&  value)
inline

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.

Definition at line 552 of file Snapshot.h.

◆ WithVolumeId() [2/3]

Snapshot& Aws::EC2::Model::Snapshot::WithVolumeId ( const Aws::String value)
inline

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.

Definition at line 545 of file Snapshot.h.

◆ WithVolumeId() [3/3]

Snapshot& Aws::EC2::Model::Snapshot::WithVolumeId ( const char *  value)
inline

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.

Definition at line 559 of file Snapshot.h.

◆ WithVolumeSize()

Snapshot& Aws::EC2::Model::Snapshot::WithVolumeSize ( int  value)
inline

The size of the volume, in GiB.

Definition at line 580 of file Snapshot.h.


The documentation for this class was generated from the following file: