Class: Aws::StorageGateway::Types::StorediSCSIVolume

Inherits:

Struct

• Object
• Struct
• Aws::StorageGateway::Types::StorediSCSIVolume

Defined in:

gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb

Overview

Describes an iSCSI stored volume.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #created_date ⇒ Time

  The date the volume was created.

• #kms_key ⇒ String

  Optional.

• #preserved_existing_data ⇒ Boolean

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

• #source_snapshot_id ⇒ String

  If the stored volume was created from a snapshot, this field contains the snapshot ID used, e.g.

• #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.

• #volume_arn ⇒ String

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

• #volume_attachment_status ⇒ String

  A value that indicates whether a storage volume is attached to, detached from, or is in the process of detaching from a gateway.

• #volume_disk_id ⇒ String

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

• #volume_id ⇒ String

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

• #volume_iscsi_attributes ⇒ Types::VolumeiSCSIAttributes

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

• #volume_progress ⇒ Float

  Represents the percentage complete if the volume is restoring or bootstrapping that represents the percent of data transferred.

• #volume_size_in_bytes ⇒ Integer

  The size of the volume in bytes.

• #volume_status ⇒ String

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

• #volume_type ⇒ String

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

• #volume_used_in_bytes ⇒ Integer

  The size of the data stored on the volume in bytes.

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)

# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 6629

class StorediSCSIVolume < Struct.new(
  :volume_arn,
  :volume_id,
  :volume_type,
  :volume_status,
  :volume_attachment_status,
  :volume_size_in_bytes,
  :volume_progress,
  :volume_disk_id,
  :source_snapshot_id,
  :preserved_existing_data,
  :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)

# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 6629

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

#preserved_existing_data ⇒ Boolean

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

Valid Values: true | false

Returns:

• (Boolean)

# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 6629

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

#source_snapshot_id ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 6629

class StorediSCSIVolume < Struct.new(
  :volume_arn,
  :volume_id,
  :volume_type,
  :volume_status,
  :volume_attachment_status,
  :volume_size_in_bytes,
  :volume_progress,
  :volume_disk_id,
  :source_snapshot_id,
  :preserved_existing_data,
  :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)

# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 6629

class StorediSCSIVolume < Struct.new(
  :volume_arn,
  :volume_id,
  :volume_type,
  :volume_status,
  :volume_attachment_status,
  :volume_size_in_bytes,
  :volume_progress,
  :volume_disk_id,
  :source_snapshot_id,
  :preserved_existing_data,
  :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)

# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 6629

class StorediSCSIVolume < Struct.new(
  :volume_arn,
  :volume_id,
  :volume_type,
  :volume_status,
  :volume_attachment_status,
  :volume_size_in_bytes,
  :volume_progress,
  :volume_disk_id,
  :source_snapshot_id,
  :preserved_existing_data,
  :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, detached from, or is in the process of detaching from a gateway. For more information, see Moving your volumes to a different gateway.

Returns:

• (String)

# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 6629

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

#volume_disk_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 6629

class StorediSCSIVolume < Struct.new(
  :volume_arn,
  :volume_id,
  :volume_type,
  :volume_status,
  :volume_attachment_status,
  :volume_size_in_bytes,
  :volume_progress,
  :volume_disk_id,
  :source_snapshot_id,
  :preserved_existing_data,
  :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)

# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 6629

class StorediSCSIVolume < Struct.new(
  :volume_arn,
  :volume_id,
  :volume_type,
  :volume_status,
  :volume_attachment_status,
  :volume_size_in_bytes,
  :volume_progress,
  :volume_disk_id,
  :source_snapshot_id,
  :preserved_existing_data,
  :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:

• (Types::VolumeiSCSIAttributes)

# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 6629

class StorediSCSIVolume < Struct.new(
  :volume_arn,
  :volume_id,
  :volume_type,
  :volume_status,
  :volume_attachment_status,
  :volume_size_in_bytes,
  :volume_progress,
  :volume_disk_id,
  :source_snapshot_id,
  :preserved_existing_data,
  :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 stored volume is not restoring or bootstrapping.

Returns:

• (Float)

# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 6629

class StorediSCSIVolume < Struct.new(
  :volume_arn,
  :volume_id,
  :volume_type,
  :volume_status,
  :volume_attachment_status,
  :volume_size_in_bytes,
  :volume_progress,
  :volume_disk_id,
  :source_snapshot_id,
  :preserved_existing_data,
  :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 of the volume in bytes.

Returns:

• (Integer)

# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 6629

class StorediSCSIVolume < Struct.new(
  :volume_arn,
  :volume_id,
  :volume_type,
  :volume_status,
  :volume_attachment_status,
  :volume_size_in_bytes,
  :volume_progress,
  :volume_disk_id,
  :source_snapshot_id,
  :preserved_existing_data,
  :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)

# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 6629

class StorediSCSIVolume < Struct.new(
  :volume_arn,
  :volume_id,
  :volume_type,
  :volume_status,
  :volume_attachment_status,
  :volume_size_in_bytes,
  :volume_progress,
  :volume_disk_id,
  :source_snapshot_id,
  :preserved_existing_data,
  :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 describing the type of the volume.

Returns:

• (String)

# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 6629

class StorediSCSIVolume < Struct.new(
  :volume_arn,
  :volume_id,
  :volume_type,
  :volume_status,
  :volume_attachment_status,
  :volume_size_in_bytes,
  :volume_progress,
  :volume_disk_id,
  :source_snapshot_id,
  :preserved_existing_data,
  :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.

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

Returns:

• (Integer)

# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 6629

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