Service/Amazon/Ec2/Instance/Windows.php

Show: PublicProtectedPrivateinherited
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: Windows.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Service_Amazon_Ec2_Instance_Windows

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

Properties

>VPropertyprotectedstring $_defaultAccessKey = null
Default valuenullDetails
Type
string
Inherited_from
\Zend_Service_Amazon_Abstract::$$_defaultAccessKey  
Inherited_from
\Zend_Service_Amazon_Ec2_Abstract::$$_defaultAccessKey  
>VPropertyprotectedstring $_defaultRegion = null
staticinherited

Amazon Region

Inherited from: \Zend_Service_Amazon_Ec2_Abstract::$$_defaultRegion
Default valuenullDetails
Type
string
Inherited_from
\Zend_Service_Amazon_Ec2_Abstract::$$_defaultRegion  
>VPropertyprotectedstring $_defaultSecretKey = null
Default valuenullDetails
Type
string
Inherited_from
\Zend_Service_Amazon_Abstract::$$_defaultSecretKey  
Inherited_from
\Zend_Service_Amazon_Ec2_Abstract::$$_defaultSecretKey  
>VPropertyprotected$_ec2ApiVersion = '2009-04-04'
inherited
The API version to use
Inherited from: \Zend_Service_Amazon_Ec2_Abstract::$$_ec2ApiVersion
Default value'2009-04-04'Details
Type
n/a
Inherited_from
\Zend_Service_Amazon_Ec2_Abstract::$$_ec2ApiVersion  
>VPropertyprotected$_ec2Endpoint = 'ec2.amazonaws.com'
inherited
The HTTP query server
Inherited from: \Zend_Service_Amazon_Ec2_Abstract::$$_ec2Endpoint
Default value'ec2.amazonaws.com'Details
Type
n/a
Inherited_from
\Zend_Service_Amazon_Ec2_Abstract::$$_ec2Endpoint  
>VPropertyprotected$_ec2SignatureMethod = 'HmacSHA256'
inherited
Signature Encoding Method
Inherited from: \Zend_Service_Amazon_Ec2_Abstract::$$_ec2SignatureMethod
Default value'HmacSHA256'Details
Type
n/a
Inherited_from
\Zend_Service_Amazon_Ec2_Abstract::$$_ec2SignatureMethod  
>VPropertyprotected$_ec2SignatureVersion = '2'
inherited
Signature Version
Inherited from: \Zend_Service_Amazon_Ec2_Abstract::$$_ec2SignatureVersion
Default value'2'Details
Type
n/a
Inherited_from
\Zend_Service_Amazon_Ec2_Abstract::$$_ec2SignatureVersion  
>VPropertyprotected\Zend_Http_Client $_httpClient = null
>VPropertyprotected$_httpTimeout = 10
inherited
Period after which HTTP request will timeout in seconds
Inherited from: \Zend_Service_Amazon_Ec2_Abstract::$$_httpTimeout
Default value10Details
Type
n/a
Inherited_from
\Zend_Service_Amazon_Ec2_Abstract::$$_httpTimeout  
>VPropertyprotectedstring $_region
inherited

Amazon Region

Inherited from: \Zend_Service_Amazon_Ec2_Abstract::$$_region
Details
Type
string
Inherited_from
\Zend_Service_Amazon_Ec2_Abstract::$$_region  
>VPropertyprotectedarray $_validEc2Regions = array('eu-west-1', 'us-east-1')
staticinherited
An array that contains all the valid Amazon Ec2 Regions.
Inherited from: \Zend_Service_Amazon_Ec2_Abstract::$$_validEc2Regions
Default valuearray('eu-west-1', 'us-east-1')Details
Type
array
Inherited_from
\Zend_Service_Amazon_Ec2_Abstract::$$_validEc2Regions  

Methods

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

Create Amazon client.

Inherited from: \Zend_Service_Amazon_Ec2_Abstract::__construct()
Parameters
NameTypeDescription
$accessKey
$secretKey
$regionstring

Sets the AWS Region

methodprotected_getAccessKey() : string
Returns
TypeDescription
string
methodprotected_getRegion() : string
inherited

Method to fetch the AWS Region

Inherited from: \Zend_Service_Amazon_Ec2_Abstract::_getRegion()
Returns
TypeDescription
string
methodprotected_getS3UploadPolicy(string $bucketName, string $prefix, integer $expireInMinutes = 1440) : string

Generates the S3 Upload Policy Information

Parameters
NameTypeDescription
$bucketNamestring

Which bucket you want the ami to live in on S3

$prefixstring

The prefix you want to assign to the AMI on S3

$expireInMinutesinteger

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
TypeDescription
stringBase64 encoded string that is the upload policy
methodprotected_getSecretKey() : string
Returns
TypeDescription
string
methodprotected_signS3UploadPolicy(string $policy) : string

Signed S3 Upload Policy

Parameters
NameTypeDescription
$policystring

Base64 Encoded string that is the upload policy

Returns
TypeDescription
stringSHA1 encoded S3 Upload Policy
methodprotectedaddRequiredParameters(array $parameters) : array
inherited

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
NameTypeDescription
$parametersarray

the array to which to add the required parameters.

Returns
TypeDescription
array
methodpublicbundle(string $instanceId, string $s3Bucket, string $s3Prefix, integer $uploadExpiration = 1440) : array

Bundles an Amazon EC2 instance running Windows

Parameters
NameTypeDescription
$instanceIdstring

The instance you want to bundle

$s3Bucketstring

Where you want the ami to live on S3

$s3Prefixstring

The prefix you want to assign to the AMI on S3

$uploadExpirationinteger

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
TypeDescription
arraycontaining the information on the new bundle operation
methodpubliccancelBundle(string $bundleId) : array

Cancels an Amazon EC2 bundling operation

Parameters
NameTypeDescription
$bundleIdstring

The ID of the bundle task to cancel

Returns
TypeDescription
arrayInformation on the bundle task
methodprivatecheckForErrors(\Zend_Service_Amazon_Ec2_Response $response) : void
inherited

Checks for errors responses from Amazon

Inherited from: \Zend_Service_Amazon_Ec2_Abstract::checkForErrors()
Parameters
NameTypeDescription
$response\Zend_Service_Amazon_Ec2_Response

the response object to check.

Throws
ExceptionDescription
\Zend_Service_Amazon_Ec2_Exceptionif one or more errors are returned from Amazon.
methodpublicdescribeBundle(string | array $bundleId = '') : array

Describes current bundling tasks

Parameters
NameTypeDescription
$bundleIdstring | array

A single or a list of bundle tasks that you want to find information for.

Returns
TypeDescription
arrayInformation for the task that you requested
methodprotectedsendRequest(array $params = array()) : \Zend_Service_Amazon_Ec2_Response
inherited

Sends a HTTP request to the queue service using Zend_Http_Client

Inherited from: \Zend_Service_Amazon_Ec2_Abstract::sendRequest()
Parameters
NameTypeDescription
$paramsarray

List of parameters to send with the request

Returns
TypeDescription
\Zend_Service_Amazon_Ec2_Response
Throws
ExceptionDescription
\Zend_Service_Amazon_Ec2_Exception
methodpublicsetHttpClient(\Zend_Http_Client $httpClient) : void
staticfinalinherited

Sets the HTTP client object to use for retrieving the feeds.

Inherited from: \Zend_Service_Abstract::setHttpClient()\Zend_Service_Amazon_Abstract::setHttpClient()\Zend_Service_Amazon_Ec2_Abstract::setHttpClient()

If none is set, the default Zend_Http_Client will be used.

Parameters
NameTypeDescription
$httpClient\Zend_Http_Client
methodpublicsetKeys( $accessKey,  $secretKey) : void
staticinherited

Set the keys to use when accessing SQS.

Inherited from: \Zend_Service_Amazon_Abstract::setKeys()\Zend_Service_Amazon_Ec2_Abstract::setKeys()
Parameters
NameTypeDescription
$accessKey
$secretKey
methodpublicsetRegion(string $region) : void
staticinherited

Set which region you are working in.

Inherited from: \Zend_Service_Amazon_Ec2_Abstract::setRegion()

It will append the end point automaticly

Parameters
NameTypeDescription
$regionstring
methodprotectedsignParameters( $paramaters) : string
inherited

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
NameTypeDescription
$paramaters
Returns
TypeDescription
stringthe signed data.
Documentation was generated by phpDocumentor 2.0.0a12.