Lincoln D. Stein > VM-EC2-1.28 > VM::EC2::Instance::StatusItem

Download:
VM-EC2-1.28.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  4
Open  1
View/Report Bugs
Source  

NAME ^

VM::EC2::Instance::StatusItem - Object describing a instance status event

SYNOPSIS ^

 @status_items = $ec2->describe_instance_status();
 for my $i (@status_items) {
    print $i->instance_id,
           ': instance check=',$i->instance_status,
           ', system check=',$i->system_status,"\n";
    if (my $e = $i->events) {
       print $i->instance_id,' event = ',$e;
    }
 }

DESCRIPTION ^

This object represents an instance status returned by $ec2->describe_instance_status().

METHODS ^

These object methods are supported:

 instanceId            -- The ID of the affected instance.
 instance              -- The VM::EC2::Instance object
 availabilityZone      -- The availability zone of this instance.
 events                -- A list of VM::EC2::Instance::Status::Event objects
                           representing a scheduled maintenance events on this
                           instance (see note).
 instanceState         -- The state of this instance (e.g. "running")
 systemStatus          -- A VM::EC2::Instance::Status object indicating the
                            status of the system check.
 instanceStatus        -- A VM::EC2::Instance::Status object indicating the
                            status of the instance availability check.

NOTE: There is an inconsistency in the AWS documentation for this data type. The events field is documented as being a list, but the examples shown return a single object. At release time, I was unable to verify which is correct and have written the code such that it will always return a list, which may be single elementin length.

In a string context, this object will interpolate as:

 "$instanceId: XX/2 tests passed"

where XX is the number of checks that passed.

In the case of an instance that is not running, the interpolation will be:

 "$instanceId: $state"

Where $state is the state of the instance (e.g. "stopped").

SEE ALSO ^

VM::EC2 VM::EC2::Generic VM::EC2::Instance VM::EC2::Tag

AUTHOR ^

Lincoln Stein <lincoln.stein@gmail.com>.

Copyright (c) 2012 Ontario Institute for Cancer Research

This package and its accompanying libraries is free software; you can redistribute it and/or modify it under the terms of the GPL (either version 1, or at your option, any later version) or the Artistic License 2.0. Refer to LICENSE for the full license text. In addition, please see DISCLAIMER.txt for disclaimers of warranty.

syntax highlighting: