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

#include <CachediSCSIVolume.h>

Public Member Functions

 CachediSCSIVolume ()
 
 CachediSCSIVolume (Aws::Utils::Json::JsonView jsonValue)
 
CachediSCSIVolumeoperator= (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)
 
CachediSCSIVolumeWithVolumeARN (const Aws::String &value)
 
CachediSCSIVolumeWithVolumeARN (Aws::String &&value)
 
CachediSCSIVolumeWithVolumeARN (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)
 
CachediSCSIVolumeWithVolumeId (const Aws::String &value)
 
CachediSCSIVolumeWithVolumeId (Aws::String &&value)
 
CachediSCSIVolumeWithVolumeId (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)
 
CachediSCSIVolumeWithVolumeType (const Aws::String &value)
 
CachediSCSIVolumeWithVolumeType (Aws::String &&value)
 
CachediSCSIVolumeWithVolumeType (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)
 
CachediSCSIVolumeWithVolumeStatus (const Aws::String &value)
 
CachediSCSIVolumeWithVolumeStatus (Aws::String &&value)
 
CachediSCSIVolumeWithVolumeStatus (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)
 
CachediSCSIVolumeWithVolumeAttachmentStatus (const Aws::String &value)
 
CachediSCSIVolumeWithVolumeAttachmentStatus (Aws::String &&value)
 
CachediSCSIVolumeWithVolumeAttachmentStatus (const char *value)
 
long long GetVolumeSizeInBytes () const
 
bool VolumeSizeInBytesHasBeenSet () const
 
void SetVolumeSizeInBytes (long long value)
 
CachediSCSIVolumeWithVolumeSizeInBytes (long long value)
 
double GetVolumeProgress () const
 
bool VolumeProgressHasBeenSet () const
 
void SetVolumeProgress (double value)
 
CachediSCSIVolumeWithVolumeProgress (double value)
 
const Aws::StringGetSourceSnapshotId () const
 
bool SourceSnapshotIdHasBeenSet () const
 
void SetSourceSnapshotId (const Aws::String &value)
 
void SetSourceSnapshotId (Aws::String &&value)
 
void SetSourceSnapshotId (const char *value)
 
CachediSCSIVolumeWithSourceSnapshotId (const Aws::String &value)
 
CachediSCSIVolumeWithSourceSnapshotId (Aws::String &&value)
 
CachediSCSIVolumeWithSourceSnapshotId (const char *value)
 
const VolumeiSCSIAttributesGetVolumeiSCSIAttributes () const
 
bool VolumeiSCSIAttributesHasBeenSet () const
 
void SetVolumeiSCSIAttributes (const VolumeiSCSIAttributes &value)
 
void SetVolumeiSCSIAttributes (VolumeiSCSIAttributes &&value)
 
CachediSCSIVolumeWithVolumeiSCSIAttributes (const VolumeiSCSIAttributes &value)
 
CachediSCSIVolumeWithVolumeiSCSIAttributes (VolumeiSCSIAttributes &&value)
 
const Aws::Utils::DateTimeGetCreatedDate () const
 
bool CreatedDateHasBeenSet () const
 
void SetCreatedDate (const Aws::Utils::DateTime &value)
 
void SetCreatedDate (Aws::Utils::DateTime &&value)
 
CachediSCSIVolumeWithCreatedDate (const Aws::Utils::DateTime &value)
 
CachediSCSIVolumeWithCreatedDate (Aws::Utils::DateTime &&value)
 
long long GetVolumeUsedInBytes () const
 
bool VolumeUsedInBytesHasBeenSet () const
 
void SetVolumeUsedInBytes (long long value)
 
CachediSCSIVolumeWithVolumeUsedInBytes (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)
 
CachediSCSIVolumeWithKMSKey (const Aws::String &value)
 
CachediSCSIVolumeWithKMSKey (Aws::String &&value)
 
CachediSCSIVolumeWithKMSKey (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)
 
CachediSCSIVolumeWithTargetName (const Aws::String &value)
 
CachediSCSIVolumeWithTargetName (Aws::String &&value)
 
CachediSCSIVolumeWithTargetName (const char *value)
 

Detailed Description

Describes an iSCSI cached volume.

See Also:

AWS API Reference

Definition at line 33 of file CachediSCSIVolume.h.

Constructor & Destructor Documentation

◆ CachediSCSIVolume() [1/2]

Aws::StorageGateway::Model::CachediSCSIVolume::CachediSCSIVolume ( )

◆ CachediSCSIVolume() [2/2]

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

Member Function Documentation

◆ CreatedDateHasBeenSet()

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

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

Definition at line 445 of file CachediSCSIVolume.h.

◆ GetCreatedDate()

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

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

Definition at line 439 of file CachediSCSIVolume.h.

◆ GetKMSKey()

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

Definition at line 518 of file CachediSCSIVolume.h.

◆ GetSourceSnapshotId()

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

If the cached 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 346 of file CachediSCSIVolume.h.

◆ GetTargetName()

const Aws::String& Aws::StorageGateway::Model::CachediSCSIVolume::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 551 of file CachediSCSIVolume.h.

◆ GetVolumeARN()

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

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

Definition at line 45 of file CachediSCSIVolume.h.

◆ GetVolumeAttachmentStatus()

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

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

Definition at line 228 of file CachediSCSIVolume.h.

◆ GetVolumeId()

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

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

Definition at line 86 of file CachediSCSIVolume.h.

◆ GetVolumeiSCSIAttributes()

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

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

Definition at line 402 of file CachediSCSIVolume.h.

◆ GetVolumeProgress()

double Aws::StorageGateway::Model::CachediSCSIVolume::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 cached volume is not restoring or bootstrapping.

Definition at line 314 of file CachediSCSIVolume.h.

◆ GetVolumeSizeInBytes()

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

The size, in bytes, of the volume capacity.

Definition at line 290 of file CachediSCSIVolume.h.

◆ GetVolumeStatus()

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

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

Definition at line 177 of file CachediSCSIVolume.h.

◆ GetVolumeType()

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

One of the VolumeType enumeration values that describes the type of the volume.

Definition at line 128 of file CachediSCSIVolume.h.

◆ GetVolumeUsedInBytes()

long long Aws::StorageGateway::Model::CachediSCSIVolume::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 481 of file CachediSCSIVolume.h.

◆ Jsonize()

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

◆ KMSKeyHasBeenSet()

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

Definition at line 521 of file CachediSCSIVolume.h.

◆ operator=()

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

◆ SetCreatedDate() [1/2]

void Aws::StorageGateway::Model::CachediSCSIVolume::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 457 of file CachediSCSIVolume.h.

◆ SetCreatedDate() [2/2]

void Aws::StorageGateway::Model::CachediSCSIVolume::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 451 of file CachediSCSIVolume.h.

◆ SetKMSKey() [1/3]

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

Definition at line 527 of file CachediSCSIVolume.h.

◆ SetKMSKey() [2/3]

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

Definition at line 524 of file CachediSCSIVolume.h.

◆ SetKMSKey() [3/3]

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

Definition at line 530 of file CachediSCSIVolume.h.

◆ SetSourceSnapshotId() [1/3]

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

If the cached 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 367 of file CachediSCSIVolume.h.

◆ SetSourceSnapshotId() [2/3]

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

If the cached 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 360 of file CachediSCSIVolume.h.

◆ SetSourceSnapshotId() [3/3]

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

If the cached 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 374 of file CachediSCSIVolume.h.

◆ SetTargetName() [1/3]

void Aws::StorageGateway::Model::CachediSCSIVolume::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 584 of file CachediSCSIVolume.h.

◆ SetTargetName() [2/3]

void Aws::StorageGateway::Model::CachediSCSIVolume::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 573 of file CachediSCSIVolume.h.

◆ SetTargetName() [3/3]

void Aws::StorageGateway::Model::CachediSCSIVolume::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 595 of file CachediSCSIVolume.h.

◆ SetVolumeARN() [1/3]

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

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

Definition at line 60 of file CachediSCSIVolume.h.

◆ SetVolumeARN() [2/3]

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

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

Definition at line 55 of file CachediSCSIVolume.h.

◆ SetVolumeARN() [3/3]

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

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

Definition at line 65 of file CachediSCSIVolume.h.

◆ SetVolumeAttachmentStatus() [1/3]

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

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

Definition at line 252 of file CachediSCSIVolume.h.

◆ SetVolumeAttachmentStatus() [2/3]

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

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

Definition at line 244 of file CachediSCSIVolume.h.

◆ SetVolumeAttachmentStatus() [3/3]

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

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

Definition at line 260 of file CachediSCSIVolume.h.

◆ SetVolumeId() [1/3]

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

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

Definition at line 101 of file CachediSCSIVolume.h.

◆ SetVolumeId() [2/3]

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

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

Definition at line 96 of file CachediSCSIVolume.h.

◆ SetVolumeId() [3/3]

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

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

Definition at line 106 of file CachediSCSIVolume.h.

◆ SetVolumeiSCSIAttributes() [1/2]

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

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

Definition at line 414 of file CachediSCSIVolume.h.

◆ SetVolumeiSCSIAttributes() [2/2]

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

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

Definition at line 420 of file CachediSCSIVolume.h.

◆ SetVolumeProgress()

void Aws::StorageGateway::Model::CachediSCSIVolume::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 cached volume is not restoring or bootstrapping.

Definition at line 330 of file CachediSCSIVolume.h.

◆ SetVolumeSizeInBytes()

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

The size, in bytes, of the volume capacity.

Definition at line 300 of file CachediSCSIVolume.h.

◆ SetVolumeStatus() [1/3]

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

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

Definition at line 195 of file CachediSCSIVolume.h.

◆ SetVolumeStatus() [2/3]

void Aws::StorageGateway::Model::CachediSCSIVolume::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 CachediSCSIVolume.h.

◆ SetVolumeStatus() [3/3]

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

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

Definition at line 201 of file CachediSCSIVolume.h.

◆ SetVolumeType() [1/3]

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

One of the VolumeType enumeration values that describes the type of the volume.

Definition at line 146 of file CachediSCSIVolume.h.

◆ SetVolumeType() [2/3]

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

One of the VolumeType enumeration values that describes the type of the volume.

Definition at line 140 of file CachediSCSIVolume.h.

◆ SetVolumeType() [3/3]

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

One of the VolumeType enumeration values that describes the type of the volume.

Definition at line 152 of file CachediSCSIVolume.h.

◆ SetVolumeUsedInBytes()

void Aws::StorageGateway::Model::CachediSCSIVolume::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 503 of file CachediSCSIVolume.h.

◆ SourceSnapshotIdHasBeenSet()

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

If the cached 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 353 of file CachediSCSIVolume.h.

◆ TargetNameHasBeenSet()

bool Aws::StorageGateway::Model::CachediSCSIVolume::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 562 of file CachediSCSIVolume.h.

◆ VolumeARNHasBeenSet()

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

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

Definition at line 50 of file CachediSCSIVolume.h.

◆ VolumeAttachmentStatusHasBeenSet()

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

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

Definition at line 236 of file CachediSCSIVolume.h.

◆ VolumeIdHasBeenSet()

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

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

Definition at line 91 of file CachediSCSIVolume.h.

◆ VolumeiSCSIAttributesHasBeenSet()

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

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

Definition at line 408 of file CachediSCSIVolume.h.

◆ VolumeProgressHasBeenSet()

bool Aws::StorageGateway::Model::CachediSCSIVolume::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 cached volume is not restoring or bootstrapping.

Definition at line 322 of file CachediSCSIVolume.h.

◆ VolumeSizeInBytesHasBeenSet()

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

The size, in bytes, of the volume capacity.

Definition at line 295 of file CachediSCSIVolume.h.

◆ VolumeStatusHasBeenSet()

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

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

Definition at line 183 of file CachediSCSIVolume.h.

◆ VolumeTypeHasBeenSet()

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

One of the VolumeType enumeration values that describes the type of the volume.

Definition at line 134 of file CachediSCSIVolume.h.

◆ VolumeUsedInBytesHasBeenSet()

bool Aws::StorageGateway::Model::CachediSCSIVolume::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 492 of file CachediSCSIVolume.h.

◆ WithCreatedDate() [1/2]

CachediSCSIVolume& Aws::StorageGateway::Model::CachediSCSIVolume::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 469 of file CachediSCSIVolume.h.

◆ WithCreatedDate() [2/2]

CachediSCSIVolume& Aws::StorageGateway::Model::CachediSCSIVolume::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 463 of file CachediSCSIVolume.h.

◆ WithKMSKey() [1/3]

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

Definition at line 536 of file CachediSCSIVolume.h.

◆ WithKMSKey() [2/3]

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

Definition at line 533 of file CachediSCSIVolume.h.

◆ WithKMSKey() [3/3]

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

Definition at line 539 of file CachediSCSIVolume.h.

◆ WithSourceSnapshotId() [1/3]

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

If the cached 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 388 of file CachediSCSIVolume.h.

◆ WithSourceSnapshotId() [2/3]

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

If the cached 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 381 of file CachediSCSIVolume.h.

◆ WithSourceSnapshotId() [3/3]

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

If the cached 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 395 of file CachediSCSIVolume.h.

◆ WithTargetName() [1/3]

CachediSCSIVolume& Aws::StorageGateway::Model::CachediSCSIVolume::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 617 of file CachediSCSIVolume.h.

◆ WithTargetName() [2/3]

CachediSCSIVolume& Aws::StorageGateway::Model::CachediSCSIVolume::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 606 of file CachediSCSIVolume.h.

◆ WithTargetName() [3/3]

CachediSCSIVolume& Aws::StorageGateway::Model::CachediSCSIVolume::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 628 of file CachediSCSIVolume.h.

◆ WithVolumeARN() [1/3]

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

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

Definition at line 75 of file CachediSCSIVolume.h.

◆ WithVolumeARN() [2/3]

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

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

Definition at line 70 of file CachediSCSIVolume.h.

◆ WithVolumeARN() [3/3]

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

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

Definition at line 80 of file CachediSCSIVolume.h.

◆ WithVolumeAttachmentStatus() [1/3]

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

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

Definition at line 276 of file CachediSCSIVolume.h.

◆ WithVolumeAttachmentStatus() [2/3]

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

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

Definition at line 268 of file CachediSCSIVolume.h.

◆ WithVolumeAttachmentStatus() [3/3]

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

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

Definition at line 284 of file CachediSCSIVolume.h.

◆ WithVolumeId() [1/3]

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

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

Definition at line 116 of file CachediSCSIVolume.h.

◆ WithVolumeId() [2/3]

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

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

Definition at line 111 of file CachediSCSIVolume.h.

◆ WithVolumeId() [3/3]

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

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

Definition at line 121 of file CachediSCSIVolume.h.

◆ WithVolumeiSCSIAttributes() [1/2]

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

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

Definition at line 426 of file CachediSCSIVolume.h.

◆ WithVolumeiSCSIAttributes() [2/2]

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

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

Definition at line 432 of file CachediSCSIVolume.h.

◆ WithVolumeProgress()

CachediSCSIVolume& Aws::StorageGateway::Model::CachediSCSIVolume::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 cached volume is not restoring or bootstrapping.

Definition at line 338 of file CachediSCSIVolume.h.

◆ WithVolumeSizeInBytes()

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

The size, in bytes, of the volume capacity.

Definition at line 305 of file CachediSCSIVolume.h.

◆ WithVolumeStatus() [1/3]

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

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

Definition at line 213 of file CachediSCSIVolume.h.

◆ WithVolumeStatus() [2/3]

CachediSCSIVolume& Aws::StorageGateway::Model::CachediSCSIVolume::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 CachediSCSIVolume.h.

◆ WithVolumeStatus() [3/3]

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

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

Definition at line 219 of file CachediSCSIVolume.h.

◆ WithVolumeType() [1/3]

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

One of the VolumeType enumeration values that describes the type of the volume.

Definition at line 164 of file CachediSCSIVolume.h.

◆ WithVolumeType() [2/3]

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

One of the VolumeType enumeration values that describes the type of the volume.

Definition at line 158 of file CachediSCSIVolume.h.

◆ WithVolumeType() [3/3]

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

One of the VolumeType enumeration values that describes the type of the volume.

Definition at line 170 of file CachediSCSIVolume.h.

◆ WithVolumeUsedInBytes()

CachediSCSIVolume& Aws::StorageGateway::Model::CachediSCSIVolume::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 514 of file CachediSCSIVolume.h.


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