Lincoln D. Stein > VM-EC2-1.23 > VM::EC2::Region

Download:
VM-EC2-1.23.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  3
Open  1
View/Report Bugs
Source   Latest Release: VM-EC2-1.25

NAME ^

VM::EC2::Region - Object describing an Amazon region

SYNOPSIS ^

  use VM::EC2;

  $ec2       = VM::EC2->new(...);
  @regions   = $ec2->describe_regions();

  $region  = $regions[0];
  $name    = $region->regionName;
  $url     = $region->regionEndpoint;
  @zones   = $region->zones;

DESCRIPTION ^

This object represents an Amazon EC2 region, and is returned by VM::EC2->describe_regions().

METHODS ^

These object methods are supported:

 regionName      -- Name of the region, e.g. "eu-west-1"
 regionEndpoint  -- URL endpoint for AWS API calls, e.g. 
                    "ec2.eu-west-1.amazonaws.com"
 zones           -- List of availability zones within this
                    region, as VM::EC2::AvailabilityZone
                    objects.

Note that you should prefix the endpoint with http:// or https:// before using it to change the VM::EC2 endpoint with the endpoint() call. If you do not do so, then http:// will be assumed.

STRING OVERLOADING ^

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

SEE ALSO ^

VM::EC2 VM::EC2::Generic

AUTHOR ^

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

Copyright (c) 2011 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: