API Documentation

Zend/Service/Amazon/Ec2/Abstract.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: Abstract.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Service_Amazon_Ec2_Abstract

Package: Zend\Service\Amazon\Ec2

Provides the basic functionality to send a request to the Amazon Ec2 Query API

Parent(s)
\Zend_Service_Amazon_Abstract < \Zend_Service_Abstract
Children
\Zend_Service_Amazon_Ec2_Keypair
\Zend_Service_Amazon_Ec2_CloudWatch
\Zend_Service_Amazon_Ec2_Instance_Reserved
\Zend_Service_Amazon_Ec2_Instance_Windows
\Zend_Service_Amazon_Ec2_Elasticip
\Zend_Service_Amazon_Ec2_Image
\Zend_Service_Amazon_Ec2_Region
\Zend_Service_Amazon_Ec2_Instance
\Zend_Service_Amazon_Ec2_Availabilityzones
\Zend_Service_Amazon_Ec2_Securitygroups
\Zend_Service_Amazon_Ec2_Ebs
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotectedstring  $_defaultRegion= 'null'
static

Amazon Region
Default valuenullDetails
Type
string
Propertyprotected  $_ec2ApiVersion= ''2009-04-04''

The API version to use

Default value'2009-04-04'Details
Type
Propertyprotected  $_ec2Endpoint= ''ec2.amazonaws.com''

The HTTP query server

Default value'ec2.amazonaws.com'Details
Type
Propertyprotected  $_ec2SignatureMethod= ''HmacSHA256''

Signature Encoding Method

Default value'HmacSHA256'Details
Type
Propertyprotected  $_ec2SignatureVersion= ''2''

Signature Version

Default value'2'Details
Type
Propertyprotected  $_httpTimeout= '10'

Period after which HTTP request will timeout in seconds

Default value10Details
Type
Propertyprotectedstring  $_region= ''

Amazon Region
Details
Type
string
Propertyprotectedarray  $_validEc2Regions= 'array('eu-west-1''
static

An array that contains all the valid Amazon Ec2 Regions.

Default valuearray('eu-west-1'Details
Type
array

Methods

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

Create Amazon client.

Parameters
Name Type Description
$accessKey
$secretKey
$region string

Sets the AWS Region

methodprotected_getRegion( ) : string

Method to fetch the AWS Region

Returns
Type Description
string
methodprotectedaddRequiredParameters( array $parameters ) : array

Adds required authentication and version parameters to an array of parameters

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
methodprivatecheckForErrors( \Zend_Service_Amazon_Ec2_Response $response ) : void

Checks for errors responses from Amazon

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.
methodprotectedsendRequest( array $params = array() ) : \Zend_Service_Amazon_Ec2_Response

Sends a HTTP request to the queue service using Zend_Http_Client

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
methodpublicsetRegion( string $region ) : void
static

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

Parameters
Name Type Description
$region string
methodprotectedsignParameters(  $paramaters ) : string

Computes the RFC 2104-compliant HMAC signature for request parameters

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.15.1.