1VM::EC2::BlockDevice::MUaspeprinCgo:n:tErBiSb(u3t)ed PerVlM:D:oEcCu2m:e:nBtlaotcikoDnevice::Mapping::EBS(3)
2
3
4

NAME

6       VM::EC2::BlockDevice::Mapping::EBS - Object describing an EBS volume
7       that has been mapped onto an Amazon EC2 instance
8

SYNOPSIS

10         use VM::EC2;
11
12         my $instance  = $ec2->describe_instances(-instance_id=>'i-123456');
13         my @devices   = $instance->blockDeviceMapping;
14         for my $d (@devices) {
15           my $ebs = $d->ebs;
16           $volume_id = $ebs->volumeId;
17           $status    = $ebs->status;
18           $atime     = $ebs->attachmentTime;
19           $delete    = $ebs->delete;
20           $volume    = $ebs->volume;
21         }
22

DESCRIPTION

24       This object is used to describe an Amazon EBS volume that is mapped
25       onto an EC2 block device. It is returned by
26       VM::EC2->describe_instances().
27
28       It is easy to confuse this with VM::EC2::BlockDevice::EBS, which
29       describes the parameters needed to create the EBS volume when an image
30       is launched. This class is instead used to describe an active mapping
31       between an instance's block device and the underlying EBS volume.
32
33       Because all the methods in this class are passed through to
34       VM::EC2::BlockDeviceMapping, it is somewhat simpler to call them
35       directly on the BlockDeviceMapping object:
36
37         my $instance  = $ec2->describe_instances(-instance_id=>'i-123456');
38         my @devices   = $instance->blockDeviceMapping;
39         for my $d (@devices) {
40           $volume_id = $d->volumeId;
41           $status    = $d->status;
42           $atime     = $d->attachmentTime;
43           $delete    = $d->delete;
44           $volume    = $d->volume;
45         }
46

METHODS

48       The following object methods are supported:
49
50        volumeId         -- ID of the volume.
51        status           -- One of "attaching", "attached", "detaching", "detached"
52        attachTime       -- Time this volume was attached
53        deleteOnTermination -- Whether the volume will be deleted when its attached
54                             instance is deleted. Note that this returns the perl
55                             0/1 booleans rather than "false"/"true" strings.
56
57       In addition, the following convenience method is supported:
58
59   $vol = $ebs->volume
60       This returns the VM::EC2::Volume object that corresponds to this EBS.
61       The volume will provide additional information, such as availabilit
62       zone.
63

STRING OVERLOADING

65       NONE
66

SEE ALSO

68       VM::EC2 VM::EC2::Generic VM::EC2::Snapshot VM::EC2::BlockDevice
69       VM::EC2::BlockDevice::Attachment
70

AUTHOR

72       Lincoln Stein <lincoln.stein@gmail.com>.
73
74       Copyright (c) 2011 Ontario Institute for Cancer Research
75
76       This package and its accompanying libraries is free software; you can
77       redistribute it and/or modify it under the terms of the GPL (either
78       version 1, or at your option, any later version) or the Artistic
79       License 2.0.  Refer to LICENSE for the full license text. In addition,
80       please see DISCLAIMER.txt for disclaimers of warranty.
81
82
83
84perl v5.34.0                      2021-07-V2M7::EC2::BlockDevice::Mapping::EBS(3)
Impressum