« blib/lib/Paws/StorageGateway/StorageGatewayError.pm
↑ Summary
blib/lib/Paws/StorageGateway/Tag.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::StorageGateway::StorediSCSIVolume; | ||
| 3 | use Moose; | ||
| 4 | has CreatedDate => (is => 'ro', isa => 'Str'); | ||
| 5 | has KMSKey => (is => 'ro', isa => 'Str'); | ||
| 6 | has PreservedExistingData => (is => 'ro', isa => 'Bool'); | ||
| 7 | has SourceSnapshotId => (is => 'ro', isa => 'Str'); | ||
| 8 | has TargetName => (is => 'ro', isa => 'Str'); | ||
| 9 | has VolumeARN => (is => 'ro', isa => 'Str'); | ||
| 10 | has VolumeAttachmentStatus => (is => 'ro', isa => 'Str'); | ||
| 11 | has VolumeDiskId => (is => 'ro', isa => 'Str'); | ||
| 12 | has VolumeId => (is => 'ro', isa => 'Str'); | ||
| 13 | has VolumeiSCSIAttributes => (is => 'ro', isa => 'Paws::StorageGateway::VolumeiSCSIAttributes'); | ||
| 14 | has VolumeProgress => (is => 'ro', isa => 'Num'); | ||
| 15 | has VolumeSizeInBytes => (is => 'ro', isa => 'Int'); | ||
| 16 | has VolumeStatus => (is => 'ro', isa => 'Str'); | ||
| 17 | has VolumeType => (is => 'ro', isa => 'Str'); | ||
| 18 | has VolumeUsedInBytes => (is => 'ro', isa => 'Int'); | ||
| 19 | |||
| 20 | 1; | ||
| 21 | |||
| 22 | ### main pod documentation begin ### | ||
| 23 | |||
| 24 | =head1 NAME | ||
| 25 | |||
| 26 | Paws::StorageGateway::StorediSCSIVolume | ||
| 27 | |||
| 28 | =head1 USAGE | ||
| 29 | |||
| 30 | This class represents one of two things: | ||
| 31 | |||
| 32 | =head3 Arguments in a call to a service | ||
| 33 | |||
| 34 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 35 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 36 | |||
| 37 | As an example, if Att1 is expected to be a Paws::StorageGateway::StorediSCSIVolume object: | ||
| 38 | |||
| 39 | $service_obj->Method(Att1 => { CreatedDate => $value, ..., VolumeUsedInBytes => $value }); | ||
| 40 | |||
| 41 | =head3 Results returned from an API call | ||
| 42 | |||
| 43 | Use accessors for each attribute. If Att1 is expected to be an Paws::StorageGateway::StorediSCSIVolume object: | ||
| 44 | |||
| 45 | $result = $service_obj->Method(...); | ||
| 46 | $result->Att1->CreatedDate | ||
| 47 | |||
| 48 | =head1 DESCRIPTION | ||
| 49 | |||
| 50 | Describes an iSCSI stored volume. | ||
| 51 | |||
| 52 | =head1 ATTRIBUTES | ||
| 53 | |||
| 54 | |||
| 55 | =head2 CreatedDate => Str | ||
| 56 | |||
| 57 | The date the volume was created. Volumes created prior to March 28, | ||
| 58 | 2017 donE<rsquo>t have this timestamp. | ||
| 59 | |||
| 60 | |||
| 61 | =head2 KMSKey => Str | ||
| 62 | |||
| 63 | |||
| 64 | |||
| 65 | |||
| 66 | =head2 PreservedExistingData => Bool | ||
| 67 | |||
| 68 | Indicates if when the stored volume was created, existing data on the | ||
| 69 | underlying local disk was preserved. | ||
| 70 | |||
| 71 | Valid Values: C<true> | C<false> | ||
| 72 | |||
| 73 | |||
| 74 | =head2 SourceSnapshotId => Str | ||
| 75 | |||
| 76 | If the stored volume was created from a snapshot, this field contains | ||
| 77 | the snapshot ID used, e.g. snap-78e22663. Otherwise, this field is not | ||
| 78 | included. | ||
| 79 | |||
| 80 | |||
| 81 | =head2 TargetName => Str | ||
| 82 | |||
| 83 | The name of the iSCSI target used by an initiator to connect to a | ||
| 84 | volume and used as a suffix for the target ARN. For example, specifying | ||
| 85 | C<TargetName> as I<myvolume> results in the target ARN of | ||
| 86 | C<arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume>. | ||
| 87 | The target name must be unique across all volumes on a gateway. | ||
| 88 | |||
| 89 | If you don't specify a value, Storage Gateway uses the value that was | ||
| 90 | previously used for this volume as the new target name. | ||
| 91 | |||
| 92 | |||
| 93 | =head2 VolumeARN => Str | ||
| 94 | |||
| 95 | The Amazon Resource Name (ARN) of the storage volume. | ||
| 96 | |||
| 97 | |||
| 98 | =head2 VolumeAttachmentStatus => Str | ||
| 99 | |||
| 100 | A value that indicates whether a storage volume is attached to, | ||
| 101 | detached from, or is in the process of detaching from a gateway. For | ||
| 102 | more information, see Moving your volumes to a different gateway | ||
| 103 | (https://docs.aws.amazon.com/storagegateway/latest/userguide/managing-volumes.html#attach-detach-volume). | ||
| 104 | |||
| 105 | |||
| 106 | =head2 VolumeDiskId => Str | ||
| 107 | |||
| 108 | The ID of the local disk that was specified in the | ||
| 109 | CreateStorediSCSIVolume operation. | ||
| 110 | |||
| 111 | |||
| 112 | =head2 VolumeId => Str | ||
| 113 | |||
| 114 | The unique identifier of the volume, e.g., vol-AE4B946D. | ||
| 115 | |||
| 116 | |||
| 117 | =head2 VolumeiSCSIAttributes => L<Paws::StorageGateway::VolumeiSCSIAttributes> | ||
| 118 | |||
| 119 | An VolumeiSCSIAttributes object that represents a collection of iSCSI | ||
| 120 | attributes for one stored volume. | ||
| 121 | |||
| 122 | |||
| 123 | =head2 VolumeProgress => Num | ||
| 124 | |||
| 125 | Represents the percentage complete if the volume is restoring or | ||
| 126 | bootstrapping that represents the percent of data transferred. This | ||
| 127 | field does not appear in the response if the stored volume is not | ||
| 128 | restoring or bootstrapping. | ||
| 129 | |||
| 130 | |||
| 131 | =head2 VolumeSizeInBytes => Int | ||
| 132 | |||
| 133 | The size of the volume in bytes. | ||
| 134 | |||
| 135 | |||
| 136 | =head2 VolumeStatus => Str | ||
| 137 | |||
| 138 | One of the VolumeStatus values that indicates the state of the storage | ||
| 139 | volume. | ||
| 140 | |||
| 141 | |||
| 142 | =head2 VolumeType => Str | ||
| 143 | |||
| 144 | One of the VolumeType enumeration values describing the type of the | ||
| 145 | volume. | ||
| 146 | |||
| 147 | |||
| 148 | =head2 VolumeUsedInBytes => Int | ||
| 149 | |||
| 150 | The size of the data stored on the volume in bytes. This value is | ||
| 151 | calculated based on the number of blocks that are touched, instead of | ||
| 152 | the actual amount of data written. This value can be useful for | ||
| 153 | sequential write patterns but less accurate for random write patterns. | ||
| 154 | C<VolumeUsedInBytes> is different from the compressed size of the | ||
| 155 | volume, which is the value that is used to calculate your bill. | ||
| 156 | |||
| 157 | This value is not available for volumes created prior to May 13, 2015, | ||
| 158 | until you store data on the volume. | ||
| 159 | |||
| 160 | |||
| 161 | |||
| 162 | =head1 SEE ALSO | ||
| 163 | |||
| 164 | This class forms part of L<Paws>, describing an object used in L<Paws::StorageGateway> | ||
| 165 | |||
| 166 | =head1 BUGS and CONTRIBUTIONS | ||
| 167 | |||
| 168 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 169 | |||
| 170 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 171 | |||
| 172 | =cut | ||
| 173 |