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.
An Amazon EC2 interface that allows yout to run, terminate, reboot and describe Amazon Ec2 Instances.

__construct(
$accessKey
=
null, $secretKey
=
null, string $region
=
null
)
:
void
Create Amazon client.
Inherited from: \Zend_Service_Amazon_Ec2_Abstract::__construct()Name | Type | Description |
---|---|---|
$accessKey | ||
$secretKey | ||
$region | string | Sets the AWS Region |

_getAccessKey(
)
:
string
Method to fetch the Access Key
Inherited from: \Zend_Service_Amazon_Abstract::_getAccessKey()Type | Description |
---|---|
string |

_getRegion(
)
:
string
Method to fetch the AWS Region
Inherited from: \Zend_Service_Amazon_Ec2_Abstract::_getRegion()Type | Description |
---|---|
string |

_getS3UploadPolicy(
string $bucketName, string $prefix, integer $expireInMinutes
=
1440
)
:
string
Generates the S3 Upload Policy Information
Name | Type | Description |
---|---|---|
$bucketName | string | Which bucket you want the ami to live in on S3 |
$prefix | string | The prefix you want to assign to the AMI on S3 |
$expireInMinutes | integer | The expiration of the upload policy. Amazon recommends 12 hours or longer. This is based in nubmer of minutes. Default is 1440 minutes (24 hours) |
Type | Description |
---|---|
string | Base64 encoded string that is the upload policy |

_getSecretKey(
)
:
string
Method to fetch the Secret AWS Key
Inherited from: \Zend_Service_Amazon_Abstract::_getSecretKey()Type | Description |
---|---|
string |

_signS3UploadPolicy(
string $policy
)
:
string
Signed S3 Upload Policy
Name | Type | Description |
---|---|---|
$policy | string | Base64 Encoded string that is the upload policy |
Type | Description |
---|---|
string | SHA1 encoded S3 Upload Policy |

addRequiredParameters(
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.
Name | Type | Description |
---|---|---|
$parameters | array | the array to which to add the required parameters. |
Type | Description |
---|---|
array |

bundle(
string $instanceId, string $s3Bucket, string $s3Prefix, integer $uploadExpiration
=
1440
)
:
array
Bundles an Amazon EC2 instance running Windows
Name | Type | Description |
---|---|---|
$instanceId | string | The instance you want to bundle |
$s3Bucket | string | Where you want the ami to live on S3 |
$s3Prefix | string | The prefix you want to assign to the AMI on S3 |
$uploadExpiration | integer | The expiration of the upload policy. Amazon recommends 12 hours or longer. This is based in nubmer of minutes. Default is 1440 minutes (24 hours) |
Type | Description |
---|---|
array | containing the information on the new bundle operation |

cancelBundle(
string $bundleId
)
:
array
Cancels an Amazon EC2 bundling operation
Name | Type | Description |
---|---|---|
$bundleId | string | The ID of the bundle task to cancel |
Type | Description |
---|---|
array | Information on the bundle task |

checkForErrors(
\Zend_Service_Amazon_Ec2_Response $response
)
:
void
Checks for errors responses from Amazon
Inherited from: \Zend_Service_Amazon_Ec2_Abstract::checkForErrors()Name | Type | Description |
---|---|---|
$response | \Zend_Service_Amazon_Ec2_Response | the response object to check. |
Exception | Description |
---|---|
\Zend_Service_Amazon_Ec2_Exception | if one or more errors are returned from Amazon. |

describeBundle(
string|array $bundleId
)
:
array
Describes current bundling tasks
Name | Type | Description |
---|---|---|
$bundleId | string|array | A single or a list of bundle tasks that you want to find information for. |
Type | Description |
---|---|
array | Information for the task that you requested |

sendRequest(
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()Name | Type | Description |
---|---|---|
$params | array | List of parameters to send with the request |
Type | Description |
---|---|
\Zend_Service_Amazon_Ec2_Response |
Exception | Description |
---|---|
\Zend_Service_Amazon_Ec2_Exception |

setHttpClient(
\Zend_Http_Client $httpClient
)
:
void
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()Name | Type | Description |
---|---|---|
$httpClient | \Zend_Http_Client |

setKeys(
$accessKey, $secretKey
)
:
void
Set the keys to use when accessing SQS.
Inherited from: \Zend_Service_Amazon_Abstract::setKeys()Name | Type | Description |
---|---|---|
$accessKey | ||
$secretKey |

setRegion(
string $region
)
:
void
Set which region you are working in. It will append the end point automaticly
Inherited from: \Zend_Service_Amazon_Ec2_Abstract::setRegion()Name | Type | Description |
---|---|---|
$region | string |

signParameters(
$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:
Sort all request parameters (including SignatureVersion and excluding Signature, the value of which is being created), ignoring case.
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.
Name | Type | Description |
---|---|---|
$paramaters |
Type | Description |
---|---|
string | the signed data. |