AWS SDK for C++  1.9.157
AWS SDK for C++
Public Member Functions | List of all members
Aws::StorageGateway::Model::StorediSCSIVolume Class Reference

#include <StorediSCSIVolume.h>

Public Member Functions

 StorediSCSIVolume ()
 
 StorediSCSIVolume (Aws::Utils::Json::JsonView jsonValue)
 
StorediSCSIVolumeoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetVolumeARN () const
 
bool VolumeARNHasBeenSet () const
 
void SetVolumeARN (const Aws::String &value)
 
void SetVolumeARN (Aws::String &&value)
 
void SetVolumeARN (const char *value)
 
StorediSCSIVolumeWithVolumeARN (const Aws::String &value)
 
StorediSCSIVolumeWithVolumeARN (Aws::String &&value)
 
StorediSCSIVolumeWithVolumeARN (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)
 
StorediSCSIVolumeWithVolumeId (const Aws::String &value)
 
StorediSCSIVolumeWithVolumeId (Aws::String &&value)
 
StorediSCSIVolumeWithVolumeId (const char *value)
 
const Aws::StringGetVolumeType () const
 
bool VolumeTypeHasBeenSet () const
 
void SetVolumeType (const Aws::String &value)
 
void SetVolumeType (Aws::String &&value)
 
void SetVolumeType (const char *value)
 
StorediSCSIVolumeWithVolumeType (const Aws::String &value)
 
StorediSCSIVolumeWithVolumeType (Aws::String &&value)
 
StorediSCSIVolumeWithVolumeType (const char *value)
 
const Aws::StringGetVolumeStatus () const
 
bool VolumeStatusHasBeenSet () const
 
void SetVolumeStatus (const Aws::String &value)
 
void SetVolumeStatus (Aws::String &&value)
 
void SetVolumeStatus (const char *value)
 
StorediSCSIVolumeWithVolumeStatus (const Aws::String &value)
 
StorediSCSIVolumeWithVolumeStatus (Aws::String &&value)
 
StorediSCSIVolumeWithVolumeStatus (const char *value)
 
const Aws::StringGetVolumeAttachmentStatus () const
 
bool VolumeAttachmentStatusHasBeenSet () const
 
void SetVolumeAttachmentStatus (const Aws::String &value)
 
void SetVolumeAttachmentStatus (Aws::String &&value)
 
void SetVolumeAttachmentStatus (const char *value)
 
StorediSCSIVolumeWithVolumeAttachmentStatus (const Aws::String &value)
 
StorediSCSIVolumeWithVolumeAttachmentStatus (Aws::String &&value)
 
StorediSCSIVolumeWithVolumeAttachmentStatus (const char *value)
 
long long GetVolumeSizeInBytes () const
 
bool VolumeSizeInBytesHasBeenSet () const
 
void SetVolumeSizeInBytes (long long value)
 
StorediSCSIVolumeWithVolumeSizeInBytes (long long value)
 
double GetVolumeProgress () const
 
bool VolumeProgressHasBeenSet () const
 
void SetVolumeProgress (double value)
 
StorediSCSIVolumeWithVolumeProgress (double value)
 
const Aws::StringGetVolumeDiskId () const
 
bool VolumeDiskIdHasBeenSet () const
 
void SetVolumeDiskId (const Aws::String &value)
 
void SetVolumeDiskId (Aws::String &&value)
 
void SetVolumeDiskId (const char *value)
 
StorediSCSIVolumeWithVolumeDiskId (const Aws::String &value)
 
StorediSCSIVolumeWithVolumeDiskId (Aws::String &&value)
 
StorediSCSIVolumeWithVolumeDiskId (const char *value)
 
const Aws::StringGetSourceSnapshotId () const
 
bool SourceSnapshotIdHasBeenSet () const
 
void SetSourceSnapshotId (const Aws::String &value)
 
void SetSourceSnapshotId (Aws::String &&value)
 
void SetSourceSnapshotId (const char *value)
 
StorediSCSIVolumeWithSourceSnapshotId (const Aws::String &value)
 
StorediSCSIVolumeWithSourceSnapshotId (Aws::String &&value)
 
StorediSCSIVolumeWithSourceSnapshotId (const char *value)
 
bool GetPreservedExistingData () const
 
bool PreservedExistingDataHasBeenSet () const
 
void SetPreservedExistingData (bool value)
 
StorediSCSIVolumeWithPreservedExistingData (bool value)
 
const VolumeiSCSIAttributesGetVolumeiSCSIAttributes () const
 
bool VolumeiSCSIAttributesHasBeenSet () const
 
void SetVolumeiSCSIAttributes (const VolumeiSCSIAttributes &value)
 
void SetVolumeiSCSIAttributes (VolumeiSCSIAttributes &&value)
 
StorediSCSIVolumeWithVolumeiSCSIAttributes (const VolumeiSCSIAttributes &value)
 
StorediSCSIVolumeWithVolumeiSCSIAttributes (VolumeiSCSIAttributes &&value)
 
const Aws::Utils::DateTimeGetCreatedDate () const
 
bool CreatedDateHasBeenSet () const
 
void SetCreatedDate (const Aws::Utils::DateTime &value)
 
void SetCreatedDate (Aws::Utils::DateTime &&value)
 
StorediSCSIVolumeWithCreatedDate (const Aws::Utils::DateTime &value)
 
StorediSCSIVolumeWithCreatedDate (Aws::Utils::DateTime &&value)
 
long long GetVolumeUsedInBytes () const
 
bool VolumeUsedInBytesHasBeenSet () const
 
void SetVolumeUsedInBytes (long long value)
 
StorediSCSIVolumeWithVolumeUsedInBytes (long long value)
 
const Aws::StringGetKMSKey () const
 
bool KMSKeyHasBeenSet () const
 
void SetKMSKey (const Aws::String &value)
 
void SetKMSKey (Aws::String &&value)
 
void SetKMSKey (const char *value)
 
StorediSCSIVolumeWithKMSKey (const Aws::String &value)
 
StorediSCSIVolumeWithKMSKey (Aws::String &&value)
 
StorediSCSIVolumeWithKMSKey (const char *value)
 
const Aws::StringGetTargetName () const
 
bool TargetNameHasBeenSet () const
 
void SetTargetName (const Aws::String &value)
 
void SetTargetName (Aws::String &&value)
 
void SetTargetName (const char *value)
 
StorediSCSIVolumeWithTargetName (const Aws::String &value)
 
StorediSCSIVolumeWithTargetName (Aws::String &&value)
 
StorediSCSIVolumeWithTargetName (const char *value)
 

Detailed Description

Describes an iSCSI stored volume.

See Also:

AWS API Reference

Definition at line 33 of file StorediSCSIVolume.h.

Constructor & Destructor Documentation

◆ StorediSCSIVolume() [1/2]

Aws::StorageGateway::Model::StorediSCSIVolume::StorediSCSIVolume ( )

◆ StorediSCSIVolume() [2/2]

Aws::StorageGateway::Model::StorediSCSIVolume::StorediSCSIVolume ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ CreatedDateHasBeenSet()

bool Aws::StorageGateway::Model::StorediSCSIVolume::CreatedDateHasBeenSet ( ) const
inline

The date the volume was created. Volumes created prior to March 28, 2017 don’t have this timestamp.

Definition at line 523 of file StorediSCSIVolume.h.

◆ GetCreatedDate()

const Aws::Utils::DateTime& Aws::StorageGateway::Model::StorediSCSIVolume::GetCreatedDate ( ) const
inline

The date the volume was created. Volumes created prior to March 28, 2017 don’t have this timestamp.

Definition at line 517 of file StorediSCSIVolume.h.

◆ GetKMSKey()

const Aws::String& Aws::StorageGateway::Model::StorediSCSIVolume::GetKMSKey ( ) const
inline

Definition at line 596 of file StorediSCSIVolume.h.

◆ GetPreservedExistingData()

bool Aws::StorageGateway::Model::StorediSCSIVolume::GetPreservedExistingData ( ) const
inline

Indicates if when the stored volume was created, existing data on the underlying local disk was preserved.

Valid Values: true | false

Definition at line 452 of file StorediSCSIVolume.h.

◆ GetSourceSnapshotId()

const Aws::String& Aws::StorageGateway::Model::StorediSCSIVolume::GetSourceSnapshotId ( ) const
inline

If the stored volume was created from a snapshot, this field contains the snapshot ID used, e.g. snap-78e22663. Otherwise, this field is not included.

Definition at line 402 of file StorediSCSIVolume.h.

◆ GetTargetName()

const Aws::String& Aws::StorageGateway::Model::StorediSCSIVolume::GetTargetName ( ) const
inline

The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes on a gateway.

If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.

Definition at line 629 of file StorediSCSIVolume.h.

◆ GetVolumeARN()

const Aws::String& Aws::StorageGateway::Model::StorediSCSIVolume::GetVolumeARN ( ) const
inline

The Amazon Resource Name (ARN) of the storage volume.

Definition at line 45 of file StorediSCSIVolume.h.

◆ GetVolumeAttachmentStatus()

const Aws::String& Aws::StorageGateway::Model::StorediSCSIVolume::GetVolumeAttachmentStatus ( ) const
inline

A value that indicates whether a storage volume is attached to, detached from, or is in the process of detaching from a gateway. For more information, see Moving your volumes to a different gateway.

Definition at line 229 of file StorediSCSIVolume.h.

◆ GetVolumeDiskId()

const Aws::String& Aws::StorageGateway::Model::StorediSCSIVolume::GetVolumeDiskId ( ) const
inline

The ID of the local disk that was specified in the CreateStorediSCSIVolume operation.

Definition at line 353 of file StorediSCSIVolume.h.

◆ GetVolumeId()

const Aws::String& Aws::StorageGateway::Model::StorediSCSIVolume::GetVolumeId ( ) const
inline

The unique identifier of the volume, e.g., vol-AE4B946D.

Definition at line 86 of file StorediSCSIVolume.h.

◆ GetVolumeiSCSIAttributes()

const VolumeiSCSIAttributes& Aws::StorageGateway::Model::StorediSCSIVolume::GetVolumeiSCSIAttributes ( ) const
inline

An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.

Definition at line 480 of file StorediSCSIVolume.h.

◆ GetVolumeProgress()

double Aws::StorageGateway::Model::StorediSCSIVolume::GetVolumeProgress ( ) const
inline

Represents the percentage complete if the volume is restoring or bootstrapping that represents the percent of data transferred. This field does not appear in the response if the stored volume is not restoring or bootstrapping.

Definition at line 322 of file StorediSCSIVolume.h.

◆ GetVolumeSizeInBytes()

long long Aws::StorageGateway::Model::StorediSCSIVolume::GetVolumeSizeInBytes ( ) const
inline

The size of the volume in bytes.

Definition at line 298 of file StorediSCSIVolume.h.

◆ GetVolumeStatus()

const Aws::String& Aws::StorageGateway::Model::StorediSCSIVolume::GetVolumeStatus ( ) const
inline

One of the VolumeStatus values that indicates the state of the storage volume.

Definition at line 177 of file StorediSCSIVolume.h.

◆ GetVolumeType()

const Aws::String& Aws::StorageGateway::Model::StorediSCSIVolume::GetVolumeType ( ) const
inline

One of the VolumeType enumeration values describing the type of the volume.

Definition at line 128 of file StorediSCSIVolume.h.

◆ GetVolumeUsedInBytes()

long long Aws::StorageGateway::Model::StorediSCSIVolume::GetVolumeUsedInBytes ( ) const
inline

The size of the data stored on the volume in bytes. This value is calculated based on the number of blocks that are touched, instead of the actual amount of data written. This value can be useful for sequential write patterns but less accurate for random write patterns. VolumeUsedInBytes is different from the compressed size of the volume, which is the value that is used to calculate your bill.

This value is not available for volumes created prior to May 13, 2015, until you store data on the volume.

Definition at line 559 of file StorediSCSIVolume.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::StorageGateway::Model::StorediSCSIVolume::Jsonize ( ) const

◆ KMSKeyHasBeenSet()

bool Aws::StorageGateway::Model::StorediSCSIVolume::KMSKeyHasBeenSet ( ) const
inline

Definition at line 599 of file StorediSCSIVolume.h.

◆ operator=()

StorediSCSIVolume& Aws::StorageGateway::Model::StorediSCSIVolume::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ PreservedExistingDataHasBeenSet()

bool Aws::StorageGateway::Model::StorediSCSIVolume::PreservedExistingDataHasBeenSet ( ) const
inline

Indicates if when the stored volume was created, existing data on the underlying local disk was preserved.

Valid Values: true | false

Definition at line 459 of file StorediSCSIVolume.h.

◆ SetCreatedDate() [1/2]

void Aws::StorageGateway::Model::StorediSCSIVolume::SetCreatedDate ( Aws::Utils::DateTime &&  value)
inline

The date the volume was created. Volumes created prior to March 28, 2017 don’t have this timestamp.

Definition at line 535 of file StorediSCSIVolume.h.

◆ SetCreatedDate() [2/2]

void Aws::StorageGateway::Model::StorediSCSIVolume::SetCreatedDate ( const Aws::Utils::DateTime value)
inline

The date the volume was created. Volumes created prior to March 28, 2017 don’t have this timestamp.

Definition at line 529 of file StorediSCSIVolume.h.

◆ SetKMSKey() [1/3]

void Aws::StorageGateway::Model::StorediSCSIVolume::SetKMSKey ( Aws::String &&  value)
inline

Definition at line 605 of file StorediSCSIVolume.h.

◆ SetKMSKey() [2/3]

void Aws::StorageGateway::Model::StorediSCSIVolume::SetKMSKey ( const Aws::String value)
inline

Definition at line 602 of file StorediSCSIVolume.h.

◆ SetKMSKey() [3/3]

void Aws::StorageGateway::Model::StorediSCSIVolume::SetKMSKey ( const char *  value)
inline

Definition at line 608 of file StorediSCSIVolume.h.

◆ SetPreservedExistingData()

void Aws::StorageGateway::Model::StorediSCSIVolume::SetPreservedExistingData ( bool  value)
inline

Indicates if when the stored volume was created, existing data on the underlying local disk was preserved.

Valid Values: true | false

Definition at line 466 of file StorediSCSIVolume.h.

◆ SetSourceSnapshotId() [1/3]

void Aws::StorageGateway::Model::StorediSCSIVolume::SetSourceSnapshotId ( Aws::String &&  value)
inline

If the stored volume was created from a snapshot, this field contains the snapshot ID used, e.g. snap-78e22663. Otherwise, this field is not included.

Definition at line 420 of file StorediSCSIVolume.h.

◆ SetSourceSnapshotId() [2/3]

void Aws::StorageGateway::Model::StorediSCSIVolume::SetSourceSnapshotId ( const Aws::String value)
inline

If the stored volume was created from a snapshot, this field contains the snapshot ID used, e.g. snap-78e22663. Otherwise, this field is not included.

Definition at line 414 of file StorediSCSIVolume.h.

◆ SetSourceSnapshotId() [3/3]

void Aws::StorageGateway::Model::StorediSCSIVolume::SetSourceSnapshotId ( const char *  value)
inline

If the stored volume was created from a snapshot, this field contains the snapshot ID used, e.g. snap-78e22663. Otherwise, this field is not included.

Definition at line 426 of file StorediSCSIVolume.h.

◆ SetTargetName() [1/3]

void Aws::StorageGateway::Model::StorediSCSIVolume::SetTargetName ( Aws::String &&  value)
inline

The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes on a gateway.

If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.

Definition at line 662 of file StorediSCSIVolume.h.

◆ SetTargetName() [2/3]

void Aws::StorageGateway::Model::StorediSCSIVolume::SetTargetName ( const Aws::String value)
inline

The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes on a gateway.

If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.

Definition at line 651 of file StorediSCSIVolume.h.

◆ SetTargetName() [3/3]

void Aws::StorageGateway::Model::StorediSCSIVolume::SetTargetName ( const char *  value)
inline

The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes on a gateway.

If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.

Definition at line 673 of file StorediSCSIVolume.h.

◆ SetVolumeARN() [1/3]

void Aws::StorageGateway::Model::StorediSCSIVolume::SetVolumeARN ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the storage volume.

Definition at line 60 of file StorediSCSIVolume.h.

◆ SetVolumeARN() [2/3]

void Aws::StorageGateway::Model::StorediSCSIVolume::SetVolumeARN ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the storage volume.

Definition at line 55 of file StorediSCSIVolume.h.

◆ SetVolumeARN() [3/3]

void Aws::StorageGateway::Model::StorediSCSIVolume::SetVolumeARN ( const char *  value)
inline

The Amazon Resource Name (ARN) of the storage volume.

Definition at line 65 of file StorediSCSIVolume.h.

◆ SetVolumeAttachmentStatus() [1/3]

void Aws::StorageGateway::Model::StorediSCSIVolume::SetVolumeAttachmentStatus ( Aws::String &&  value)
inline

A value that indicates whether a storage volume is attached to, detached from, or is in the process of detaching from a gateway. For more information, see Moving your volumes to a different gateway.

Definition at line 256 of file StorediSCSIVolume.h.

◆ SetVolumeAttachmentStatus() [2/3]

void Aws::StorageGateway::Model::StorediSCSIVolume::SetVolumeAttachmentStatus ( const Aws::String value)
inline

A value that indicates whether a storage volume is attached to, detached from, or is in the process of detaching from a gateway. For more information, see Moving your volumes to a different gateway.

Definition at line 247 of file StorediSCSIVolume.h.

◆ SetVolumeAttachmentStatus() [3/3]

void Aws::StorageGateway::Model::StorediSCSIVolume::SetVolumeAttachmentStatus ( const char *  value)
inline

A value that indicates whether a storage volume is attached to, detached from, or is in the process of detaching from a gateway. For more information, see Moving your volumes to a different gateway.

Definition at line 265 of file StorediSCSIVolume.h.

◆ SetVolumeDiskId() [1/3]

void Aws::StorageGateway::Model::StorediSCSIVolume::SetVolumeDiskId ( Aws::String &&  value)
inline

The ID of the local disk that was specified in the CreateStorediSCSIVolume operation.

Definition at line 371 of file StorediSCSIVolume.h.

◆ SetVolumeDiskId() [2/3]

void Aws::StorageGateway::Model::StorediSCSIVolume::SetVolumeDiskId ( const Aws::String value)
inline

The ID of the local disk that was specified in the CreateStorediSCSIVolume operation.

Definition at line 365 of file StorediSCSIVolume.h.

◆ SetVolumeDiskId() [3/3]

void Aws::StorageGateway::Model::StorediSCSIVolume::SetVolumeDiskId ( const char *  value)
inline

The ID of the local disk that was specified in the CreateStorediSCSIVolume operation.

Definition at line 377 of file StorediSCSIVolume.h.

◆ SetVolumeId() [1/3]

void Aws::StorageGateway::Model::StorediSCSIVolume::SetVolumeId ( Aws::String &&  value)
inline

The unique identifier of the volume, e.g., vol-AE4B946D.

Definition at line 101 of file StorediSCSIVolume.h.

◆ SetVolumeId() [2/3]

void Aws::StorageGateway::Model::StorediSCSIVolume::SetVolumeId ( const Aws::String value)
inline

The unique identifier of the volume, e.g., vol-AE4B946D.

Definition at line 96 of file StorediSCSIVolume.h.

◆ SetVolumeId() [3/3]

void Aws::StorageGateway::Model::StorediSCSIVolume::SetVolumeId ( const char *  value)
inline

The unique identifier of the volume, e.g., vol-AE4B946D.

Definition at line 106 of file StorediSCSIVolume.h.

◆ SetVolumeiSCSIAttributes() [1/2]

void Aws::StorageGateway::Model::StorediSCSIVolume::SetVolumeiSCSIAttributes ( const VolumeiSCSIAttributes value)
inline

An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.

Definition at line 492 of file StorediSCSIVolume.h.

◆ SetVolumeiSCSIAttributes() [2/2]

void Aws::StorageGateway::Model::StorediSCSIVolume::SetVolumeiSCSIAttributes ( VolumeiSCSIAttributes &&  value)
inline

An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.

Definition at line 498 of file StorediSCSIVolume.h.

◆ SetVolumeProgress()

void Aws::StorageGateway::Model::StorediSCSIVolume::SetVolumeProgress ( double  value)
inline

Represents the percentage complete if the volume is restoring or bootstrapping that represents the percent of data transferred. This field does not appear in the response if the stored volume is not restoring or bootstrapping.

Definition at line 338 of file StorediSCSIVolume.h.

◆ SetVolumeSizeInBytes()

void Aws::StorageGateway::Model::StorediSCSIVolume::SetVolumeSizeInBytes ( long long  value)
inline

The size of the volume in bytes.

Definition at line 308 of file StorediSCSIVolume.h.

◆ SetVolumeStatus() [1/3]

void Aws::StorageGateway::Model::StorediSCSIVolume::SetVolumeStatus ( Aws::String &&  value)
inline

One of the VolumeStatus values that indicates the state of the storage volume.

Definition at line 195 of file StorediSCSIVolume.h.

◆ SetVolumeStatus() [2/3]

void Aws::StorageGateway::Model::StorediSCSIVolume::SetVolumeStatus ( const Aws::String value)
inline

One of the VolumeStatus values that indicates the state of the storage volume.

Definition at line 189 of file StorediSCSIVolume.h.

◆ SetVolumeStatus() [3/3]

void Aws::StorageGateway::Model::StorediSCSIVolume::SetVolumeStatus ( const char *  value)
inline

One of the VolumeStatus values that indicates the state of the storage volume.

Definition at line 201 of file StorediSCSIVolume.h.

◆ SetVolumeType() [1/3]

void Aws::StorageGateway::Model::StorediSCSIVolume::SetVolumeType ( Aws::String &&  value)
inline

One of the VolumeType enumeration values describing the type of the volume.

Definition at line 146 of file StorediSCSIVolume.h.

◆ SetVolumeType() [2/3]

void Aws::StorageGateway::Model::StorediSCSIVolume::SetVolumeType ( const Aws::String value)
inline

One of the VolumeType enumeration values describing the type of the volume.

Definition at line 140 of file StorediSCSIVolume.h.

◆ SetVolumeType() [3/3]

void Aws::StorageGateway::Model::StorediSCSIVolume::SetVolumeType ( const char *  value)
inline

One of the VolumeType enumeration values describing the type of the volume.

Definition at line 152 of file StorediSCSIVolume.h.

◆ SetVolumeUsedInBytes()

void Aws::StorageGateway::Model::StorediSCSIVolume::SetVolumeUsedInBytes ( long long  value)
inline

The size of the data stored on the volume in bytes. This value is calculated based on the number of blocks that are touched, instead of the actual amount of data written. This value can be useful for sequential write patterns but less accurate for random write patterns. VolumeUsedInBytes is different from the compressed size of the volume, which is the value that is used to calculate your bill.

This value is not available for volumes created prior to May 13, 2015, until you store data on the volume.

Definition at line 581 of file StorediSCSIVolume.h.

◆ SourceSnapshotIdHasBeenSet()

bool Aws::StorageGateway::Model::StorediSCSIVolume::SourceSnapshotIdHasBeenSet ( ) const
inline

If the stored volume was created from a snapshot, this field contains the snapshot ID used, e.g. snap-78e22663. Otherwise, this field is not included.

Definition at line 408 of file StorediSCSIVolume.h.

◆ TargetNameHasBeenSet()

bool Aws::StorageGateway::Model::StorediSCSIVolume::TargetNameHasBeenSet ( ) const
inline

The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes on a gateway.

If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.

Definition at line 640 of file StorediSCSIVolume.h.

◆ VolumeARNHasBeenSet()

bool Aws::StorageGateway::Model::StorediSCSIVolume::VolumeARNHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the storage volume.

Definition at line 50 of file StorediSCSIVolume.h.

◆ VolumeAttachmentStatusHasBeenSet()

bool Aws::StorageGateway::Model::StorediSCSIVolume::VolumeAttachmentStatusHasBeenSet ( ) const
inline

A value that indicates whether a storage volume is attached to, detached from, or is in the process of detaching from a gateway. For more information, see Moving your volumes to a different gateway.

Definition at line 238 of file StorediSCSIVolume.h.

◆ VolumeDiskIdHasBeenSet()

bool Aws::StorageGateway::Model::StorediSCSIVolume::VolumeDiskIdHasBeenSet ( ) const
inline

The ID of the local disk that was specified in the CreateStorediSCSIVolume operation.

Definition at line 359 of file StorediSCSIVolume.h.

◆ VolumeIdHasBeenSet()

bool Aws::StorageGateway::Model::StorediSCSIVolume::VolumeIdHasBeenSet ( ) const
inline

The unique identifier of the volume, e.g., vol-AE4B946D.

Definition at line 91 of file StorediSCSIVolume.h.

◆ VolumeiSCSIAttributesHasBeenSet()

bool Aws::StorageGateway::Model::StorediSCSIVolume::VolumeiSCSIAttributesHasBeenSet ( ) const
inline

An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.

Definition at line 486 of file StorediSCSIVolume.h.

◆ VolumeProgressHasBeenSet()

bool Aws::StorageGateway::Model::StorediSCSIVolume::VolumeProgressHasBeenSet ( ) const
inline

Represents the percentage complete if the volume is restoring or bootstrapping that represents the percent of data transferred. This field does not appear in the response if the stored volume is not restoring or bootstrapping.

Definition at line 330 of file StorediSCSIVolume.h.

◆ VolumeSizeInBytesHasBeenSet()

bool Aws::StorageGateway::Model::StorediSCSIVolume::VolumeSizeInBytesHasBeenSet ( ) const
inline

The size of the volume in bytes.

Definition at line 303 of file StorediSCSIVolume.h.

◆ VolumeStatusHasBeenSet()

bool Aws::StorageGateway::Model::StorediSCSIVolume::VolumeStatusHasBeenSet ( ) const
inline

One of the VolumeStatus values that indicates the state of the storage volume.

Definition at line 183 of file StorediSCSIVolume.h.

◆ VolumeTypeHasBeenSet()

bool Aws::StorageGateway::Model::StorediSCSIVolume::VolumeTypeHasBeenSet ( ) const
inline

One of the VolumeType enumeration values describing the type of the volume.

Definition at line 134 of file StorediSCSIVolume.h.

◆ VolumeUsedInBytesHasBeenSet()

bool Aws::StorageGateway::Model::StorediSCSIVolume::VolumeUsedInBytesHasBeenSet ( ) const
inline

The size of the data stored on the volume in bytes. This value is calculated based on the number of blocks that are touched, instead of the actual amount of data written. This value can be useful for sequential write patterns but less accurate for random write patterns. VolumeUsedInBytes is different from the compressed size of the volume, which is the value that is used to calculate your bill.

This value is not available for volumes created prior to May 13, 2015, until you store data on the volume.

Definition at line 570 of file StorediSCSIVolume.h.

◆ WithCreatedDate() [1/2]

StorediSCSIVolume& Aws::StorageGateway::Model::StorediSCSIVolume::WithCreatedDate ( Aws::Utils::DateTime &&  value)
inline

The date the volume was created. Volumes created prior to March 28, 2017 don’t have this timestamp.

Definition at line 547 of file StorediSCSIVolume.h.

◆ WithCreatedDate() [2/2]

StorediSCSIVolume& Aws::StorageGateway::Model::StorediSCSIVolume::WithCreatedDate ( const Aws::Utils::DateTime value)
inline

The date the volume was created. Volumes created prior to March 28, 2017 don’t have this timestamp.

Definition at line 541 of file StorediSCSIVolume.h.

◆ WithKMSKey() [1/3]

StorediSCSIVolume& Aws::StorageGateway::Model::StorediSCSIVolume::WithKMSKey ( Aws::String &&  value)
inline

Definition at line 614 of file StorediSCSIVolume.h.

◆ WithKMSKey() [2/3]

StorediSCSIVolume& Aws::StorageGateway::Model::StorediSCSIVolume::WithKMSKey ( const Aws::String value)
inline

Definition at line 611 of file StorediSCSIVolume.h.

◆ WithKMSKey() [3/3]

StorediSCSIVolume& Aws::StorageGateway::Model::StorediSCSIVolume::WithKMSKey ( const char *  value)
inline

Definition at line 617 of file StorediSCSIVolume.h.

◆ WithPreservedExistingData()

StorediSCSIVolume& Aws::StorageGateway::Model::StorediSCSIVolume::WithPreservedExistingData ( bool  value)
inline

Indicates if when the stored volume was created, existing data on the underlying local disk was preserved.

Valid Values: true | false

Definition at line 473 of file StorediSCSIVolume.h.

◆ WithSourceSnapshotId() [1/3]

StorediSCSIVolume& Aws::StorageGateway::Model::StorediSCSIVolume::WithSourceSnapshotId ( Aws::String &&  value)
inline

If the stored volume was created from a snapshot, this field contains the snapshot ID used, e.g. snap-78e22663. Otherwise, this field is not included.

Definition at line 438 of file StorediSCSIVolume.h.

◆ WithSourceSnapshotId() [2/3]

StorediSCSIVolume& Aws::StorageGateway::Model::StorediSCSIVolume::WithSourceSnapshotId ( const Aws::String value)
inline

If the stored volume was created from a snapshot, this field contains the snapshot ID used, e.g. snap-78e22663. Otherwise, this field is not included.

Definition at line 432 of file StorediSCSIVolume.h.

◆ WithSourceSnapshotId() [3/3]

StorediSCSIVolume& Aws::StorageGateway::Model::StorediSCSIVolume::WithSourceSnapshotId ( const char *  value)
inline

If the stored volume was created from a snapshot, this field contains the snapshot ID used, e.g. snap-78e22663. Otherwise, this field is not included.

Definition at line 444 of file StorediSCSIVolume.h.

◆ WithTargetName() [1/3]

StorediSCSIVolume& Aws::StorageGateway::Model::StorediSCSIVolume::WithTargetName ( Aws::String &&  value)
inline

The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes on a gateway.

If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.

Definition at line 695 of file StorediSCSIVolume.h.

◆ WithTargetName() [2/3]

StorediSCSIVolume& Aws::StorageGateway::Model::StorediSCSIVolume::WithTargetName ( const Aws::String value)
inline

The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes on a gateway.

If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.

Definition at line 684 of file StorediSCSIVolume.h.

◆ WithTargetName() [3/3]

StorediSCSIVolume& Aws::StorageGateway::Model::StorediSCSIVolume::WithTargetName ( const char *  value)
inline

The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes on a gateway.

If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.

Definition at line 706 of file StorediSCSIVolume.h.

◆ WithVolumeARN() [1/3]

StorediSCSIVolume& Aws::StorageGateway::Model::StorediSCSIVolume::WithVolumeARN ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the storage volume.

Definition at line 75 of file StorediSCSIVolume.h.

◆ WithVolumeARN() [2/3]

StorediSCSIVolume& Aws::StorageGateway::Model::StorediSCSIVolume::WithVolumeARN ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the storage volume.

Definition at line 70 of file StorediSCSIVolume.h.

◆ WithVolumeARN() [3/3]

StorediSCSIVolume& Aws::StorageGateway::Model::StorediSCSIVolume::WithVolumeARN ( const char *  value)
inline

The Amazon Resource Name (ARN) of the storage volume.

Definition at line 80 of file StorediSCSIVolume.h.

◆ WithVolumeAttachmentStatus() [1/3]

StorediSCSIVolume& Aws::StorageGateway::Model::StorediSCSIVolume::WithVolumeAttachmentStatus ( Aws::String &&  value)
inline

A value that indicates whether a storage volume is attached to, detached from, or is in the process of detaching from a gateway. For more information, see Moving your volumes to a different gateway.

Definition at line 283 of file StorediSCSIVolume.h.

◆ WithVolumeAttachmentStatus() [2/3]

StorediSCSIVolume& Aws::StorageGateway::Model::StorediSCSIVolume::WithVolumeAttachmentStatus ( const Aws::String value)
inline

A value that indicates whether a storage volume is attached to, detached from, or is in the process of detaching from a gateway. For more information, see Moving your volumes to a different gateway.

Definition at line 274 of file StorediSCSIVolume.h.

◆ WithVolumeAttachmentStatus() [3/3]

StorediSCSIVolume& Aws::StorageGateway::Model::StorediSCSIVolume::WithVolumeAttachmentStatus ( const char *  value)
inline

A value that indicates whether a storage volume is attached to, detached from, or is in the process of detaching from a gateway. For more information, see Moving your volumes to a different gateway.

Definition at line 292 of file StorediSCSIVolume.h.

◆ WithVolumeDiskId() [1/3]

StorediSCSIVolume& Aws::StorageGateway::Model::StorediSCSIVolume::WithVolumeDiskId ( Aws::String &&  value)
inline

The ID of the local disk that was specified in the CreateStorediSCSIVolume operation.

Definition at line 389 of file StorediSCSIVolume.h.

◆ WithVolumeDiskId() [2/3]

StorediSCSIVolume& Aws::StorageGateway::Model::StorediSCSIVolume::WithVolumeDiskId ( const Aws::String value)
inline

The ID of the local disk that was specified in the CreateStorediSCSIVolume operation.

Definition at line 383 of file StorediSCSIVolume.h.

◆ WithVolumeDiskId() [3/3]

StorediSCSIVolume& Aws::StorageGateway::Model::StorediSCSIVolume::WithVolumeDiskId ( const char *  value)
inline

The ID of the local disk that was specified in the CreateStorediSCSIVolume operation.

Definition at line 395 of file StorediSCSIVolume.h.

◆ WithVolumeId() [1/3]

StorediSCSIVolume& Aws::StorageGateway::Model::StorediSCSIVolume::WithVolumeId ( Aws::String &&  value)
inline

The unique identifier of the volume, e.g., vol-AE4B946D.

Definition at line 116 of file StorediSCSIVolume.h.

◆ WithVolumeId() [2/3]

StorediSCSIVolume& Aws::StorageGateway::Model::StorediSCSIVolume::WithVolumeId ( const Aws::String value)
inline

The unique identifier of the volume, e.g., vol-AE4B946D.

Definition at line 111 of file StorediSCSIVolume.h.

◆ WithVolumeId() [3/3]

StorediSCSIVolume& Aws::StorageGateway::Model::StorediSCSIVolume::WithVolumeId ( const char *  value)
inline

The unique identifier of the volume, e.g., vol-AE4B946D.

Definition at line 121 of file StorediSCSIVolume.h.

◆ WithVolumeiSCSIAttributes() [1/2]

StorediSCSIVolume& Aws::StorageGateway::Model::StorediSCSIVolume::WithVolumeiSCSIAttributes ( const VolumeiSCSIAttributes value)
inline

An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.

Definition at line 504 of file StorediSCSIVolume.h.

◆ WithVolumeiSCSIAttributes() [2/2]

StorediSCSIVolume& Aws::StorageGateway::Model::StorediSCSIVolume::WithVolumeiSCSIAttributes ( VolumeiSCSIAttributes &&  value)
inline

An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.

Definition at line 510 of file StorediSCSIVolume.h.

◆ WithVolumeProgress()

StorediSCSIVolume& Aws::StorageGateway::Model::StorediSCSIVolume::WithVolumeProgress ( double  value)
inline

Represents the percentage complete if the volume is restoring or bootstrapping that represents the percent of data transferred. This field does not appear in the response if the stored volume is not restoring or bootstrapping.

Definition at line 346 of file StorediSCSIVolume.h.

◆ WithVolumeSizeInBytes()

StorediSCSIVolume& Aws::StorageGateway::Model::StorediSCSIVolume::WithVolumeSizeInBytes ( long long  value)
inline

The size of the volume in bytes.

Definition at line 313 of file StorediSCSIVolume.h.

◆ WithVolumeStatus() [1/3]

StorediSCSIVolume& Aws::StorageGateway::Model::StorediSCSIVolume::WithVolumeStatus ( Aws::String &&  value)
inline

One of the VolumeStatus values that indicates the state of the storage volume.

Definition at line 213 of file StorediSCSIVolume.h.

◆ WithVolumeStatus() [2/3]

StorediSCSIVolume& Aws::StorageGateway::Model::StorediSCSIVolume::WithVolumeStatus ( const Aws::String value)
inline

One of the VolumeStatus values that indicates the state of the storage volume.

Definition at line 207 of file StorediSCSIVolume.h.

◆ WithVolumeStatus() [3/3]

StorediSCSIVolume& Aws::StorageGateway::Model::StorediSCSIVolume::WithVolumeStatus ( const char *  value)
inline

One of the VolumeStatus values that indicates the state of the storage volume.

Definition at line 219 of file StorediSCSIVolume.h.

◆ WithVolumeType() [1/3]

StorediSCSIVolume& Aws::StorageGateway::Model::StorediSCSIVolume::WithVolumeType ( Aws::String &&  value)
inline

One of the VolumeType enumeration values describing the type of the volume.

Definition at line 164 of file StorediSCSIVolume.h.

◆ WithVolumeType() [2/3]

StorediSCSIVolume& Aws::StorageGateway::Model::StorediSCSIVolume::WithVolumeType ( const Aws::String value)
inline

One of the VolumeType enumeration values describing the type of the volume.

Definition at line 158 of file StorediSCSIVolume.h.

◆ WithVolumeType() [3/3]

StorediSCSIVolume& Aws::StorageGateway::Model::StorediSCSIVolume::WithVolumeType ( const char *  value)
inline

One of the VolumeType enumeration values describing the type of the volume.

Definition at line 170 of file StorediSCSIVolume.h.

◆ WithVolumeUsedInBytes()

StorediSCSIVolume& Aws::StorageGateway::Model::StorediSCSIVolume::WithVolumeUsedInBytes ( long long  value)
inline

The size of the data stored on the volume in bytes. This value is calculated based on the number of blocks that are touched, instead of the actual amount of data written. This value can be useful for sequential write patterns but less accurate for random write patterns. VolumeUsedInBytes is different from the compressed size of the volume, which is the value that is used to calculate your bill.

This value is not available for volumes created prior to May 13, 2015, until you store data on the volume.

Definition at line 592 of file StorediSCSIVolume.h.


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