Class: Aws::StorageGateway::Types::CachediSCSIVolume

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-storagegateway/types.rb

Overview

Describes an iSCSI cached volume.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#created_date ⇒ Time

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

Returns:

  • (Time) 


802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
 
# File 'lib/aws-sdk-storagegateway/types.rb', line 802

class CachediSCSIVolume < Struct.new(
  :volume_arn,
  :volume_id,
  :volume_type,
  :volume_status,
  :volume_attachment_status,
  :volume_size_in_bytes,
  :volume_progress,
  :source_snapshot_id,
  :volume_iscsi_attributes,
  :created_date,
  :volume_used_in_bytes,
  :kms_key,
  :target_name)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key ⇒ String

Optional. The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value must be set if ‘KMSEncrypted` is `true`, or if `EncryptionType` is `SseKms` or `DsseKms`.

Returns:

  • (String) 


802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
 
# File 'lib/aws-sdk-storagegateway/types.rb', line 802

class CachediSCSIVolume < Struct.new(
  :volume_arn,
  :volume_id,
  :volume_type,
  :volume_status,
  :volume_attachment_status,
  :volume_size_in_bytes,
  :volume_progress,
  :source_snapshot_id,
  :volume_iscsi_attributes,
  :created_date,
  :volume_used_in_bytes,
  :kms_key,
  :target_name)
  SENSITIVE = []
  include Aws::Structure
end

#source_snapshot_id ⇒ String

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.

Returns:

  • (String) 


802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
 
# File 'lib/aws-sdk-storagegateway/types.rb', line 802

class CachediSCSIVolume < Struct.new(
  :volume_arn,
  :volume_id,
  :volume_type,
  :volume_status,
  :volume_attachment_status,
  :volume_size_in_bytes,
  :volume_progress,
  :source_snapshot_id,
  :volume_iscsi_attributes,
  :created_date,
  :volume_used_in_bytes,
  :kms_key,
  :target_name)
  SENSITIVE = []
  include Aws::Structure
end

#target_name ⇒ String

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.

Returns:

  • (String) 


802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
 
# File 'lib/aws-sdk-storagegateway/types.rb', line 802

class CachediSCSIVolume < Struct.new(
  :volume_arn,
  :volume_id,
  :volume_type,
  :volume_status,
  :volume_attachment_status,
  :volume_size_in_bytes,
  :volume_progress,
  :source_snapshot_id,
  :volume_iscsi_attributes,
  :created_date,
  :volume_used_in_bytes,
  :kms_key,
  :target_name)
  SENSITIVE = []
  include Aws::Structure
end

#volume_arn ⇒ String

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

Returns:

  • (String) 


802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
 
# File 'lib/aws-sdk-storagegateway/types.rb', line 802

class CachediSCSIVolume < Struct.new(
  :volume_arn,
  :volume_id,
  :volume_type,
  :volume_status,
  :volume_attachment_status,
  :volume_size_in_bytes,
  :volume_progress,
  :source_snapshot_id,
  :volume_iscsi_attributes,
  :created_date,
  :volume_used_in_bytes,
  :kms_key,
  :target_name)
  SENSITIVE = []
  include Aws::Structure
end

#volume_attachment_status ⇒ String

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].

[1]: docs.aws.amazon.com/storagegateway/latest/userguide/managing-volumes.html#attach-detach-volume

Returns:

  • (String) 


802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
 
# File 'lib/aws-sdk-storagegateway/types.rb', line 802

class CachediSCSIVolume < Struct.new(
  :volume_arn,
  :volume_id,
  :volume_type,
  :volume_status,
  :volume_attachment_status,
  :volume_size_in_bytes,
  :volume_progress,
  :source_snapshot_id,
  :volume_iscsi_attributes,
  :created_date,
  :volume_used_in_bytes,
  :kms_key,
  :target_name)
  SENSITIVE = []
  include Aws::Structure
end

#volume_id ⇒ String

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

Returns:

  • (String) 


802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
 
# File 'lib/aws-sdk-storagegateway/types.rb', line 802

class CachediSCSIVolume < Struct.new(
  :volume_arn,
  :volume_id,
  :volume_type,
  :volume_status,
  :volume_attachment_status,
  :volume_size_in_bytes,
  :volume_progress,
  :source_snapshot_id,
  :volume_iscsi_attributes,
  :created_date,
  :volume_used_in_bytes,
  :kms_key,
  :target_name)
  SENSITIVE = []
  include Aws::Structure
end

#volume_iscsi_attributes ⇒ Types::VolumeiSCSIAttributes

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

Returns:



802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
 
# File 'lib/aws-sdk-storagegateway/types.rb', line 802

class CachediSCSIVolume < Struct.new(
  :volume_arn,
  :volume_id,
  :volume_type,
  :volume_status,
  :volume_attachment_status,
  :volume_size_in_bytes,
  :volume_progress,
  :source_snapshot_id,
  :volume_iscsi_attributes,
  :created_date,
  :volume_used_in_bytes,
  :kms_key,
  :target_name)
  SENSITIVE = []
  include Aws::Structure
end

#volume_progress ⇒ Float

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.

Returns:

  • (Float) 


802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
 
# File 'lib/aws-sdk-storagegateway/types.rb', line 802

class CachediSCSIVolume < Struct.new(
  :volume_arn,
  :volume_id,
  :volume_type,
  :volume_status,
  :volume_attachment_status,
  :volume_size_in_bytes,
  :volume_progress,
  :source_snapshot_id,
  :volume_iscsi_attributes,
  :created_date,
  :volume_used_in_bytes,
  :kms_key,
  :target_name)
  SENSITIVE = []
  include Aws::Structure
end

#volume_size_in_bytes ⇒ Integer

The size, in bytes, of the volume capacity.

Returns:

  • (Integer) 


802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
 
# File 'lib/aws-sdk-storagegateway/types.rb', line 802

class CachediSCSIVolume < Struct.new(
  :volume_arn,
  :volume_id,
  :volume_type,
  :volume_status,
  :volume_attachment_status,
  :volume_size_in_bytes,
  :volume_progress,
  :source_snapshot_id,
  :volume_iscsi_attributes,
  :created_date,
  :volume_used_in_bytes,
  :kms_key,
  :target_name)
  SENSITIVE = []
  include Aws::Structure
end

#volume_status ⇒ String

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

Returns:

  • (String) 


802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
 
# File 'lib/aws-sdk-storagegateway/types.rb', line 802

class CachediSCSIVolume < Struct.new(
  :volume_arn,
  :volume_id,
  :volume_type,
  :volume_status,
  :volume_attachment_status,
  :volume_size_in_bytes,
  :volume_progress,
  :source_snapshot_id,
  :volume_iscsi_attributes,
  :created_date,
  :volume_used_in_bytes,
  :kms_key,
  :target_name)
  SENSITIVE = []
  include Aws::Structure
end

#volume_type ⇒ String

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

Returns:

  • (String) 


802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
 
# File 'lib/aws-sdk-storagegateway/types.rb', line 802

class CachediSCSIVolume < Struct.new(
  :volume_arn,
  :volume_id,
  :volume_type,
  :volume_status,
  :volume_attachment_status,
  :volume_size_in_bytes,
  :volume_progress,
  :source_snapshot_id,
  :volume_iscsi_attributes,
  :created_date,
  :volume_used_in_bytes,
  :kms_key,
  :target_name)
  SENSITIVE = []
  include Aws::Structure
end

#volume_used_in_bytes ⇒ Integer

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.

<note markdown=“1”> This value is not available for volumes created prior to May 13, 2015, until you store data on the volume.

If you use a delete tool that overwrites the data on your volume

with random data, your usage will not be reduced. This is because the random data is not compressible. If you want to reduce the amount of billed storage on your volume, we recommend overwriting your files with zeros to compress the data to a negligible amount of actual storage.

</note>

Returns:

  • (Integer) 


802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
 
# File 'lib/aws-sdk-storagegateway/types.rb', line 802

class CachediSCSIVolume < Struct.new(
  :volume_arn,
  :volume_id,
  :volume_type,
  :volume_status,
  :volume_attachment_status,
  :volume_size_in_bytes,
  :volume_progress,
  :source_snapshot_id,
  :volume_iscsi_attributes,
  :created_date,
  :volume_used_in_bytes,
  :kms_key,
  :target_name)
  SENSITIVE = []
  include Aws::Structure
end