API Documentation

Service/Amazon/Ec2/Elasticip.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Service_Amazon  
subpackage
Ec2  
version
$Id: Elasticip.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Service_Amazon_Ec2_Elasticip

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

Extends from
\Zend_Service_Amazon_Ec2_Abstract
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Service_Amazon  
subpackage
Ec2  

Methods

methodpublic__construct(  $accessKey = null,  $secretKey = null, string $region = null ) : void

Create Amazon client.

Inherited from: \Zend_Service_Amazon_Ec2_Abstract::__construct()
Parameters
Name Type Description
$accessKey
$secretKey
$region string Sets the AWS Region
methodprotected_getAccessKey( ) : string

Method to fetch the Access Key

Inherited from: \Zend_Service_Amazon_Abstract::_getAccessKey()
Returns
Type Description
string
methodprotected_getRegion( ) : string

Method to fetch the AWS Region

Inherited from: \Zend_Service_Amazon_Ec2_Abstract::_getRegion()
Returns
Type Description
string
methodprotected_getSecretKey( ) : string

Method to fetch the Secret AWS Key

Inherited from: \Zend_Service_Amazon_Abstract::_getSecretKey()
Returns
Type Description
string
methodprotectedaddRequiredParameters( array $parameters ) : array

Adds required authentication and version parameters to an array of parameters

Inherited from: \Zend_Service_Amazon_Ec2_Abstract::addRequiredParameters()

The required parameters are: - AWSAccessKey - SignatureVersion - Timestamp - Version and - Signature

If a required parameter is already set in the $parameters array, it is overwritten.

Parameters
Name Type Description
$parameters array the array to which to add the required parameters.
Returns
Type Description
array
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
methodprivatecheckForErrors( \Zend_Service_Amazon_Ec2_Response $response ) : void

Checks for errors responses from Amazon

Inherited from: \Zend_Service_Amazon_Ec2_Abstract::checkForErrors()
Parameters
Name Type Description
$response \Zend_Service_Amazon_Ec2_Response the response object to check.
Throws
Exception Description
\Zend_Service_Amazon_Ec2_Exception if one or more errors are returned from Amazon.
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
methodpublicgetHttpClient( ) : \Zend_Http_Client
static

Gets the HTTP client object.

Inherited from: \Zend_Service_Abstract::getHttpClient()
Returns
Type Description
\Zend_Http_Client
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
methodprotectedsendRequest( array $params = array ) : \Zend_Service_Amazon_Ec2_Response

Sends a HTTP request to the queue service using Zend_Http_Client

Inherited from: \Zend_Service_Amazon_Ec2_Abstract::sendRequest()
Parameters
Name Type Description
$params array List of parameters to send with the request
Returns
Type Description
\Zend_Service_Amazon_Ec2_Response
Throws
Exception Description
\Zend_Service_Amazon_Ec2_Exception
methodpublicsetHttpClient( \Zend_Http_Client $httpClient ) : void
static

Sets the HTTP client object to use for retrieving the feeds. If none is set, the default Zend_Http_Client will be used.

Inherited from: \Zend_Service_Abstract::setHttpClient()
Parameters
Name Type Description
$httpClient \Zend_Http_Client
methodpublicsetKeys(  $accessKey,  $secretKey ) : void
static

Set the keys to use when accessing SQS.

Inherited from: \Zend_Service_Amazon_Abstract::setKeys()
Parameters
Name Type Description
$accessKey
$secretKey
methodpublicsetRegion( string $region ) : void
static

Set which region you are working in. It will append the end point automaticly

Inherited from: \Zend_Service_Amazon_Ec2_Abstract::setRegion()
Parameters
Name Type Description
$region string
methodprotectedsignParameters(  $paramaters ) : string

Computes the RFC 2104-compliant HMAC signature for request parameters

Inherited from: \Zend_Service_Amazon_Ec2_Abstract::signParameters()

This implements the Amazon Web Services signature, as per the following specification:

  1. Sort all request parameters (including SignatureVersion and excluding Signature, the value of which is being created), ignoring case.

  2. Iterate over the sorted list and append the parameter name (in its original case) and then its value. Do not URL-encode the parameter values before constructing this string. Do not use any separator characters when appending strings.

Parameters
Name Type Description
$paramaters
Returns
Type Description
string the signed data.
Documentation was generated by DocBlox 0.13.3.