1VM::EC2::ReservedInstanUcsee(r3)Contributed Perl DocumenVtMa:t:iEoCn2::ReservedInstance(3)
2
3
4

NAME

6       VM::EC2::ReservedInstance - Object describing an Amazon EC2 reserved
7       instance
8

SYNOPSIS

10         use VM::EC2;
11
12         $ec2       = VM::EC2->new(...);
13         @offerings = $ec2->describe_reserved_instances();
14         for my $o (@offerings) {
15           print $o->reservedInstancesId,"\n";
16           print $o->instanceType,"\n";
17           print $o->availabilityZone,"\n";
18           print $o->start,"\n";
19           print $o->duration,"\n";
20           print $o->fixedPrice,"\n";
21           print $o->usagePrice,"\n";
22           print $o->instanceCount,"\n";
23           print $o->productDescription,"\n";
24           print $o->state,"\n";
25           print $o->instanceTenancy,"\n";
26           print $o->currencyCode,"\n";
27           $tags = $o->tags;
28         }
29       =head1 DESCRIPTION
30
31       This object represents an Amazon EC2 reserved instance reservation that
32       you have purchased, as returned by
33       VM::EC2->describe_reserved_instances().
34

METHODS

36       These object methods are supported:
37
38        reservedInstancesId -- ID of this reserved instance contract
39
40        instanceType        -- The instance type on which these reserved
41                                instance can be used.
42
43        availabilityZone    -- The availability zone in which these reserved
44                                instances can be used.
45
46        start               -- The date and time that this contract was established.
47
48        duration            -- The duration of this contract, in seconds.
49
50        fixedPrice          -- The purchase price of the reserved instance for the indicated
51                                version.
52
53        usagePrice          -- The usage price of the reserved instance, per hour.
54
55        instanceCount       -- The number of instances that were purchased under this contract.
56
57        productDescription  -- The reserved instance description. One of  "Linux/UNIX",
58                                "Linux/UNIX (Amazon VPC)", "Windows", and "Windows (Amazon VPC)"
59
60        state               -- The state of the reserved instance purchase. One of "payment-pending",
61                                "active", "payment-failed", and "retired".
62
63        tagSet              -- Tags for this reserved instance set. More conveniently accessed via
64                                the tags(), add_tags() and delete_tags() methods.
65
66        instanceTenancy     -- The tenancy of the reserved instance (VPC only).
67
68        currencyCode        -- The currency of the reserved instance offering prices.
69
70       This object supports the various tag manipulation methods described in
71       VM::EC2::Generic. In addition it supports the following methods:
72
73   $status = $reserved_instance->current_status
74       Refreshes the object and returns its state, one of "payment-pending",
75       "active", "payment-failed", and "retired". You can use this to monitor
76       the progress of a purchase.
77
78   $reserved_instance->refresh
79       Calls VM::EC2->describe_reserved_instances() to refresh the object
80       against current information in Amazon.
81

STRING OVERLOADING

83       When used in a string context, this object will interpolate the
84       reservedInstancesId.
85

SEE ALSO

87       VM::EC2 VM::EC2::Generic VM::EC2::ReservedInstances::Offering
88

AUTHOR

90       Lincoln Stein <lincoln.stein@gmail.com>.
91
92       Copyright (c) 2011 Ontario Institute for Cancer Research
93
94       This package and its accompanying libraries is free software; you can
95       redistribute it and/or modify it under the terms of the GPL (either
96       version 1, or at your option, any later version) or the Artistic
97       License 2.0.  Refer to LICENSE for the full license text. In addition,
98       please see DISCLAIMER.txt for disclaimers of warranty.
99
100
101
102perl v5.34.0                      2022-01-21      VM::EC2::ReservedInstance(3)