You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

Describes an iSCSI stored volume.

Instance Attribute Summary collapse

Instance Attribute Details

#created_dateTime

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

Returns:

  • (Time)


4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 4154

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)
  include Aws::Structure
end

#kms_keyString

The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.

Returns:

  • (String)


4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 4154

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)
  include Aws::Structure
end

#preserved_existing_dataBoolean

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

Valid Values: true, false

Returns:

  • (Boolean)


4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 4154

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)
  include Aws::Structure
end

#source_snapshot_idString

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)


4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 4154

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)
  include Aws::Structure
end

#target_nameString

The name of the iSCSI target that is 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.

Returns:

  • (String)


4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 4154

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)
  include Aws::Structure
end

#volume_arnString

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

Returns:

  • (String)


4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 4154

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)
  include Aws::Structure
end

#volume_attachment_statusString

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

Returns:

  • (String)


4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 4154

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)
  include Aws::Structure
end

#volume_disk_idString

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

Returns:

  • (String)


4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 4154

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)
  include Aws::Structure
end

#volume_idString

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

Returns:

  • (String)


4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 4154

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)
  include Aws::Structure
end

#volume_iscsi_attributesTypes::VolumeiSCSIAttributes

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



4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 4154

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)
  include Aws::Structure
end

#volume_progressFloat

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)


4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 4154

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)
  include Aws::Structure
end

#volume_size_in_bytesInteger

The size of the volume in bytes.

Returns:

  • (Integer)


4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 4154

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)
  include Aws::Structure
end

#volume_statusString

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

Returns:

  • (String)


4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 4154

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)
  include Aws::Structure
end

#volume_typeString

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

Returns:

  • (String)


4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 4154

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)
  include Aws::Structure
end

#volume_used_in_bytesInteger

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

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

Returns:

  • (Integer)


4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 4154

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)
  include Aws::Structure
end