.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "VM::EC2::REST::elastic_ip 3pm"
.TH VM::EC2::REST::elastic_ip 3pm "2016-06-04" "perl v5.22.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME VM::EC2::REST::elastic_ip \- Allocate, attach and delete elastic IP addresses"
.IX Header "NAME VM::EC2::REST::elastic_ip - Allocate, attach and delete elastic IP addresses"
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use VM::EC2 \*(Aq:standard\*(Aq;
.Ve
.SH "METHODS"
.IX Header "METHODS"
The methods in this section allow you to allocate elastic \s-1IP\s0
addresses, attach them to instances, and delete them. See
VM::EC2::ElasticAddress.
.PP
Implemented:
 AllocateAddress
 AssociateAddress
 DescribeAddresses
 DissociateAddress
 ReleaseAddress
.PP
Unimplemented:
 (none)
.ie n .SS "@addr = $ec2\->describe_addresses(@public_ips)"
.el .SS "\f(CW@addr\fP = \f(CW$ec2\fP\->describe_addresses(@public_ips)"
.IX Subsection "@addr = $ec2->describe_addresses(@public_ips)"
.ie n .SS "@addr = $ec2\->describe_addresses(\-public_ip=>\e@addr,\-allocation_id=>\e@id,\-filter\->\e%filters)"
.el .SS "\f(CW@addr\fP = \f(CW$ec2\fP\->describe_addresses(\-public_ip=>\e@addr,\-allocation_id=>\e@id,\-filter\->\e%filters)"
.IX Subsection "@addr = $ec2->describe_addresses(-public_ip=>@addr,-allocation_id=>@id,-filter->%filters)"
Queries \s-1AWS\s0 for a list of elastic \s-1IP\s0 addresses already allocated to
you. All arguments are optional:
.PP
.Vb 6
\& \-public_ip     \-\- An IP address (in dotted format) or an arrayref of
\&                   addresses to return information about.
\& \-allocation_id \-\- An allocation ID or arrayref of such IDs. Only 
\&                   applicable to VPC addresses.
\& \-filter        \-\- A hashref of tag=>value pairs to filter the response
\&                   on.
.Ve
.PP
The list of applicable filters can be found at
http://docs.amazonwebservices.com/AWSEC2/latest/APIReference/ApiReference\-query\-DescribeAddresses.html.
.PP
This method returns a list of VM::EC2::ElasticAddress.
.ie n .SS "$address_info = $ec2\->allocate_address([\-vpc=>1])"
.el .SS "\f(CW$address_info\fP = \f(CW$ec2\fP\->allocate_address([\-vpc=>1])"
.IX Subsection "$address_info = $ec2->allocate_address([-vpc=>1])"
Request an elastic \s-1IP\s0 address. Pass \-vpc=>1 to allocate a \s-1VPC\s0 elastic
address. The return object is a VM::EC2::ElasticAddress.
.ie n .SS "$boolean = $ec2\->release_address($addr)"
.el .SS "\f(CW$boolean\fP = \f(CW$ec2\fP\->release_address($addr)"
.IX Subsection "$boolean = $ec2->release_address($addr)"
Release an elastic \s-1IP\s0 address. For non-VPC addresses, you may provide
either an \s-1IP\s0 address string, or a VM::EC2::ElasticAddress. For \s-1VPC\s0
addresses, you must obtain a VM::EC2::ElasticAddress first 
(e.g. with describe_addresses) and then pass that to the method.
.ie n .SS "$result = $ec2\->associate_address($elastic_addr => $instance_id)"
.el .SS "\f(CW$result\fP = \f(CW$ec2\fP\->associate_address($elastic_addr => \f(CW$instance_id\fP)"
.IX Subsection "$result = $ec2->associate_address($elastic_addr => $instance_id)"
Associate an elastic address with an instance id. Both arguments are
mandatory. If you are associating a \s-1VPC\s0 elastic \s-1IP\s0 address with the
instance, the result code will indicate the associationId. Otherwise
it will be a simple perl truth value (\*(L"1\*(R") if successful, undef if
false.
.PP
If this is an ordinary \s-1EC2\s0 Elastic \s-1IP\s0 address, the first argument may
either be an ordinary string (xx.xx.xx.xx format) or a
VM::EC2::ElasticAddress object. However, if it is a \s-1VPC\s0 elastic
\&\s-1IP\s0 address, then the argument must be a VM::EC2::ElasticAddress
as returned by \fIdescribe_addresses()\fR. The reason for this is that the
allocationId must be retrieved from the object in order to use in the
call.
.ie n .SS "$bool = $ec2\->disassociate_address($elastic_addr)"
.el .SS "\f(CW$bool\fP = \f(CW$ec2\fP\->disassociate_address($elastic_addr)"
.IX Subsection "$bool = $ec2->disassociate_address($elastic_addr)"
Disassociate an elastic address from whatever instance it is currently
associated with, if any. The result will be true if disassociation was
successful.
.PP
If this is an ordinary \s-1EC2\s0 Elastic \s-1IP\s0 address, the argument may
either be an ordinary string (xx.xx.xx.xx format) or a
VM::EC2::ElasticAddress object. However, if it is a \s-1VPC\s0 elastic
\&\s-1IP\s0 address, then the argument must be a VM::EC2::ElasticAddress
as returned by \fIdescribe_addresses()\fR. The reason for this is that the
allocationId must be retrieved from the object in order to use in the
call.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\s-1VM::EC2\s0
.SH "AUTHOR"
.IX Header "AUTHOR"
Lincoln Stein <lincoln.stein@gmail.com>.
.PP
Copyright (c) 2011 Ontario Institute for Cancer Research
.PP
This package and its accompanying libraries is free software; you can
redistribute it and/or modify it under the terms of the \s-1GPL \s0(either
version 1, or at your option, any later version) or the Artistic
License 2.0.  Refer to \s-1LICENSE\s0 for the full license text. In addition,
please see \s-1DISCLAIMER\s0.txt for disclaimers of warranty.