API Documentation

Zend/Service/Amazon/Ec2/Elasticip.php

Show: inherited
Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Service_Amazon  
Subpackage
Ec2  
Version
$Id: Elasticip.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Service_Amazon_Ec2_Elasticip

Package: Zend\Service\Amazon\Ec2

An Amazon EC2 interface to allocate, associate, describe and release Elastic IP address from your account.

Parent(s)
\Zend_Service_Amazon_Ec2_Abstract < \Zend_Service_Amazon_Abstract < \Zend_Service_Abstract
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Methods

methodpublicallocate( ) : string

Acquires an elastic IP address for use with your account

Returns
Type Description
string Returns the newly Allocated IP Address
methodpublicassociate( string $instanceId, string $publicIp ) : boolean

Associates an elastic IP address with an instance

Parameters
Name Type Description
$instanceId string

The instance to which the IP address is assigned

$publicIp string

IP address that you are assigning to the instance.

Returns
Type Description
boolean
methodpublicdescribe( string|array $publicIp = null ) : array

Lists elastic IP addresses assigned to your account.

Parameters
Name Type Description
$publicIp string|array

Elastic IP or list of addresses to describe.

Returns
Type Description
array
methodpublicdisassocate( string $publicIp ) : boolean

Disassociates the specified elastic IP address from the instance to which it is assigned.

This is an idempotent operation. If you enter it more than once, Amazon EC2 does not return an error.

Parameters
Name Type Description
$publicIp string

IP address that you are disassociating from the instance.

Returns
Type Description
boolean
methodpublicrelease( string $publicIp ) : boolean

Releases an elastic IP address that is associated with your account

Parameters
Name Type Description
$publicIp string

IP address that you are releasing from your account.

Returns
Type Description
boolean
Documentation was generated by DocBlox 0.15.1.