API Documentation

Service/Amazon/Ec2/Instance/Windows.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: Windows.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Service_Amazon_Ec2_Instance_Windows

An Amazon EC2 interface that allows yout to run, terminate, reboot and describe Amazon Ec2 Instances.

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_getS3UploadPolicy( string $bucketName, string $prefix, integer $expireInMinutes = 1440 ) : string

Generates the S3 Upload Policy Information

Parameters
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)

Returns
Type Description
string Base64 encoded string that is the upload policy
methodprotected_getSecretKey( ) : string

Method to fetch the Secret AWS Key

Inherited from: \Zend_Service_Amazon_Abstract::_getSecretKey()
Returns
Type Description
string
methodprotected_signS3UploadPolicy( string $policy ) : string

Signed S3 Upload Policy

Parameters
Name Type Description
$policy string Base64 Encoded string that is the upload policy
Returns
Type Description
string SHA1 encoded S3 Upload Policy
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
methodpublicbundle( string $instanceId, string $s3Bucket, string $s3Prefix, integer $uploadExpiration = 1440 ) : array

Bundles an Amazon EC2 instance running Windows

Parameters
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)

Returns
Type Description
array containing the information on the new bundle operation
methodpubliccancelBundle( string $bundleId ) : array

Cancels an Amazon EC2 bundling operation

Parameters
Name Type Description
$bundleId string The ID of the bundle task to cancel
Returns
Type Description
array Information on the bundle task
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.
methodpublicdescribeBundle( string|array $bundleId ) : array

Describes current bundling tasks

Parameters
Name Type Description
$bundleId string|array A single or a list of bundle tasks that you want to find information for.
Returns
Type Description
array Information for the task that you requested
methodpublicgetHttpClient( ) : \Zend_Http_Client
static

Gets the HTTP client object.

Inherited from: \Zend_Service_Abstract::getHttpClient()
Returns
Type Description
\Zend_Http_Client
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.