Lincoln D. Stein > VM-EC2 > VM::EC2::ELB::InstanceState

Download:
VM-EC2-1.28.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  5
Open  1
View/Report Bugs
Source  

NAME ^

VM::EC2::ELB:InstanceState - Object describing the state of an instance attached to a load balancer. It is the result of a DescribeInstanceHealth API call.

SYNOPSIS ^

 use VM::EC2;

 my $ec2          = VM::EC2->new(...);
 my $lb           = $ec2->describe_load_balancers('my-lb');
 my @instance_ids = map { $_->InstanceId } $lb->Instances();
 my @states       = $lb->describe_instance_health(-instances => \@instance_ids);
 my @down_ids     = map { $_->InstanceId } grep { $_->State eq 'OutOfService' } @states;

DESCRIPTION ^

This object is used to describe the parameters returned by a DescribeInstanceHealth API call.

METHODS ^

The following object methods are supported:

 InstanceId   -- The Instance ID of the instance attached to the load balancer
 State        -- Specifies the current status of the instance
 ReasonCode   -- Provides information about the cause of OutOfService instances.
                 Specifically, it indicates whether the cause is Elastic Load Balancing 
                 or the instance behind the load balancer
 Description  -- Description of why the instance is in the current state

The following convenience methods are supported:

 instance     -- Provides an L<VM::EC2::Instance> object

STRING OVERLOADING ^

When used in a string context, this object will interpolate the instance state.

SEE ALSO ^

VM::EC2 VM::EC2::Generic VM::EC2::ELB

AUTHOR ^

Lance Kinley <lkinley@loyaltymethods.com>.

Copyright (c) 2012 Loyalty Methods, Inc.

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: