Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data CachediSCSIVolume = CachediSCSIVolume' {
- createdDate :: Maybe POSIX
- kmsKey :: Maybe Text
- sourceSnapshotId :: Maybe Text
- targetName :: Maybe Text
- volumeARN :: Maybe Text
- volumeAttachmentStatus :: Maybe Text
- volumeId :: Maybe Text
- volumeProgress :: Maybe Double
- volumeSizeInBytes :: Maybe Integer
- volumeStatus :: Maybe Text
- volumeType :: Maybe Text
- volumeUsedInBytes :: Maybe Integer
- volumeiSCSIAttributes :: Maybe VolumeiSCSIAttributes
- newCachediSCSIVolume :: CachediSCSIVolume
- cachediSCSIVolume_createdDate :: Lens' CachediSCSIVolume (Maybe UTCTime)
- cachediSCSIVolume_kmsKey :: Lens' CachediSCSIVolume (Maybe Text)
- cachediSCSIVolume_sourceSnapshotId :: Lens' CachediSCSIVolume (Maybe Text)
- cachediSCSIVolume_targetName :: Lens' CachediSCSIVolume (Maybe Text)
- cachediSCSIVolume_volumeARN :: Lens' CachediSCSIVolume (Maybe Text)
- cachediSCSIVolume_volumeAttachmentStatus :: Lens' CachediSCSIVolume (Maybe Text)
- cachediSCSIVolume_volumeId :: Lens' CachediSCSIVolume (Maybe Text)
- cachediSCSIVolume_volumeProgress :: Lens' CachediSCSIVolume (Maybe Double)
- cachediSCSIVolume_volumeSizeInBytes :: Lens' CachediSCSIVolume (Maybe Integer)
- cachediSCSIVolume_volumeStatus :: Lens' CachediSCSIVolume (Maybe Text)
- cachediSCSIVolume_volumeType :: Lens' CachediSCSIVolume (Maybe Text)
- cachediSCSIVolume_volumeUsedInBytes :: Lens' CachediSCSIVolume (Maybe Integer)
- cachediSCSIVolume_volumeiSCSIAttributes :: Lens' CachediSCSIVolume (Maybe VolumeiSCSIAttributes)
Documentation
data CachediSCSIVolume Source #
Describes an iSCSI cached volume.
See: newCachediSCSIVolume
smart constructor.
CachediSCSIVolume' | |
|
Instances
newCachediSCSIVolume :: CachediSCSIVolume Source #
Create a value of CachediSCSIVolume
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:createdDate:CachediSCSIVolume'
, cachediSCSIVolume_createdDate
- The date the volume was created. Volumes created prior to March 28, 2017
don’t have this timestamp.
$sel:kmsKey:CachediSCSIVolume'
, cachediSCSIVolume_kmsKey
- Undocumented member.
$sel:sourceSnapshotId:CachediSCSIVolume'
, cachediSCSIVolume_sourceSnapshotId
- 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.
$sel:targetName:CachediSCSIVolume'
, cachediSCSIVolume_targetName
- 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.
$sel:volumeARN:CachediSCSIVolume'
, cachediSCSIVolume_volumeARN
- The Amazon Resource Name (ARN) of the storage volume.
$sel:volumeAttachmentStatus:CachediSCSIVolume'
, cachediSCSIVolume_volumeAttachmentStatus
- 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.
$sel:volumeId:CachediSCSIVolume'
, cachediSCSIVolume_volumeId
- The unique identifier of the volume, e.g., vol-AE4B946D.
$sel:volumeProgress:CachediSCSIVolume'
, cachediSCSIVolume_volumeProgress
- 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.
$sel:volumeSizeInBytes:CachediSCSIVolume'
, cachediSCSIVolume_volumeSizeInBytes
- The size, in bytes, of the volume capacity.
$sel:volumeStatus:CachediSCSIVolume'
, cachediSCSIVolume_volumeStatus
- One of the VolumeStatus values that indicates the state of the storage
volume.
$sel:volumeType:CachediSCSIVolume'
, cachediSCSIVolume_volumeType
- One of the VolumeType enumeration values that describes the type of the
volume.
$sel:volumeUsedInBytes:CachediSCSIVolume'
, cachediSCSIVolume_volumeUsedInBytes
- 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.
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.
$sel:volumeiSCSIAttributes:CachediSCSIVolume'
, cachediSCSIVolume_volumeiSCSIAttributes
- An VolumeiSCSIAttributes object that represents a collection of iSCSI
attributes for one stored volume.
cachediSCSIVolume_createdDate :: Lens' CachediSCSIVolume (Maybe UTCTime) Source #
The date the volume was created. Volumes created prior to March 28, 2017 don’t have this timestamp.
cachediSCSIVolume_kmsKey :: Lens' CachediSCSIVolume (Maybe Text) Source #
Undocumented member.
cachediSCSIVolume_sourceSnapshotId :: Lens' CachediSCSIVolume (Maybe Text) Source #
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.
cachediSCSIVolume_targetName :: Lens' CachediSCSIVolume (Maybe Text) Source #
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.
cachediSCSIVolume_volumeARN :: Lens' CachediSCSIVolume (Maybe Text) Source #
The Amazon Resource Name (ARN) of the storage volume.
cachediSCSIVolume_volumeAttachmentStatus :: Lens' CachediSCSIVolume (Maybe Text) Source #
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.
cachediSCSIVolume_volumeId :: Lens' CachediSCSIVolume (Maybe Text) Source #
The unique identifier of the volume, e.g., vol-AE4B946D.
cachediSCSIVolume_volumeProgress :: Lens' CachediSCSIVolume (Maybe Double) Source #
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.
cachediSCSIVolume_volumeSizeInBytes :: Lens' CachediSCSIVolume (Maybe Integer) Source #
The size, in bytes, of the volume capacity.
cachediSCSIVolume_volumeStatus :: Lens' CachediSCSIVolume (Maybe Text) Source #
One of the VolumeStatus values that indicates the state of the storage volume.
cachediSCSIVolume_volumeType :: Lens' CachediSCSIVolume (Maybe Text) Source #
One of the VolumeType enumeration values that describes the type of the volume.
cachediSCSIVolume_volumeUsedInBytes :: Lens' CachediSCSIVolume (Maybe Integer) Source #
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.
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.
cachediSCSIVolume_volumeiSCSIAttributes :: Lens' CachediSCSIVolume (Maybe VolumeiSCSIAttributes) Source #
An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.