Service/Amazon/Ec2/Instance/Windows.php
inherited
Classes
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 [email protected] 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
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
string $_accessKey = - Type
- string
- Inherited_from
- \Zend_Service_Amazon_Abstract::$$_accessKey
- Inherited_from
- \Zend_Service_Amazon_Ec2_Abstract::$$_accessKey
string $_defaultAccessKey = nullnullDetails- Type
- string
- Inherited_from
- \Zend_Service_Amazon_Abstract::$$_defaultAccessKey
- Inherited_from
- \Zend_Service_Amazon_Ec2_Abstract::$$_defaultAccessKey
string $_defaultRegion = nullnullDetails- Type
- string
- Inherited_from
- \Zend_Service_Amazon_Ec2_Abstract::$$_defaultRegion
string $_defaultSecretKey = nullnullDetails- Type
- string
- Inherited_from
- \Zend_Service_Amazon_Abstract::$$_defaultSecretKey
- Inherited_from
- \Zend_Service_Amazon_Ec2_Abstract::$$_defaultSecretKey
$_ec2ApiVersion = '2009-04-04'
'2009-04-04'Details- Type
- n/a
- Inherited_from
- \Zend_Service_Amazon_Ec2_Abstract::$$_ec2ApiVersion
$_ec2Endpoint = 'ec2.amazonaws.com'
'ec2.amazonaws.com'Details- Type
- n/a
- Inherited_from
- \Zend_Service_Amazon_Ec2_Abstract::$$_ec2Endpoint
$_ec2SignatureMethod = 'HmacSHA256'Signature Encoding Method
Inherited from: \Zend_Service_Amazon_Ec2_Abstract::$$_ec2SignatureMethod'HmacSHA256'Details- Type
- n/a
- Inherited_from
- \Zend_Service_Amazon_Ec2_Abstract::$$_ec2SignatureMethod
$_ec2SignatureVersion = '2'Signature Version
Inherited from: \Zend_Service_Amazon_Ec2_Abstract::$$_ec2SignatureVersion'2'Details- Type
- n/a
- Inherited_from
- \Zend_Service_Amazon_Ec2_Abstract::$$_ec2SignatureVersion
\Zend_Http_Client $_httpClient = nullHTTP Client used to query all web services
Inherited from: \Zend_Service_Abstract::$$_httpClient\Zend_Service_Amazon_Abstract::$$_httpClient\Zend_Service_Amazon_Ec2_Abstract::$$_httpClientnullDetails- Type
- \Zend_Http_Client
- Inherited_from
- \Zend_Service_Abstract::$$_httpClient
- Inherited_from
- \Zend_Service_Amazon_Abstract::$$_httpClient
- Inherited_from
- \Zend_Service_Amazon_Ec2_Abstract::$$_httpClient
$_httpTimeout = 10Period after which HTTP request will timeout in seconds
Inherited from: \Zend_Service_Amazon_Ec2_Abstract::$$_httpTimeout10Details- Type
- n/a
- Inherited_from
- \Zend_Service_Amazon_Ec2_Abstract::$$_httpTimeout
string $_region = - Type
- string
- Inherited_from
- \Zend_Service_Amazon_Ec2_Abstract::$$_region
string $_secretKey = - Type
- string
- Inherited_from
- \Zend_Service_Amazon_Abstract::$$_secretKey
- Inherited_from
- \Zend_Service_Amazon_Ec2_Abstract::$$_secretKey
array $_validEc2Regions = array('eu-west-1', 'us-east-1')An array that contains all the valid Amazon Ec2 Regions.
Inherited from: \Zend_Service_Amazon_Ec2_Abstract::$$_validEc2Regionsarray('eu-west-1', 'us-east-1')Details- Type
- array
- Inherited_from
- \Zend_Service_Amazon_Ec2_Abstract::$$_validEc2Regions
Methods
__construct( $accessKey = null, $secretKey = null, string $region = null) : void| Name | Type | Description |
|---|---|---|
| $accessKey | ||
| $secretKey | ||
| $region | string | Sets the AWS Region |
_getAccessKey() : stringMethod to fetch the Access Key
Inherited from: \Zend_Service_Amazon_Abstract::_getAccessKey()\Zend_Service_Amazon_Ec2_Abstract::_getAccessKey()| Type | Description |
|---|---|
| string |
_getRegion() : stringMethod to fetch the AWS Region
Inherited from: \Zend_Service_Amazon_Ec2_Abstract::_getRegion()| Type | Description |
|---|---|
| string |
_getS3UploadPolicy(string $bucketName, string $prefix, integer $expireInMinutes = 1440) : stringGenerates 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() : stringMethod to fetch the Secret AWS Key
Inherited from: \Zend_Service_Amazon_Abstract::_getSecretKey()\Zend_Service_Amazon_Ec2_Abstract::_getSecretKey()| Type | Description |
|---|---|
| string |
_signS3UploadPolicy(string $policy) : stringSigned 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) : arrayAdds 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) : arrayBundles 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) : arrayCancels 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) : voidChecks 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 = '') : arrayDescribes 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 |
getHttpClient() : \Zend_Http_ClientGets the HTTP client object.
Inherited from: \Zend_Service_Abstract::getHttpClient()\Zend_Service_Amazon_Abstract::getHttpClient()\Zend_Service_Amazon_Ec2_Abstract::getHttpClient()| Type | Description |
|---|---|
| \Zend_Http_Client |
sendRequest(array $params = array()) : \Zend_Service_Amazon_Ec2_ResponseSends 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) : voidSets 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.
| Name | Type | Description |
|---|---|---|
| $httpClient | \Zend_Http_Client |
setKeys( $accessKey, $secretKey) : voidSet the keys to use when accessing SQS.
Inherited from: \Zend_Service_Amazon_Abstract::setKeys()\Zend_Service_Amazon_Ec2_Abstract::setKeys()| Name | Type | Description |
|---|---|---|
| $accessKey | ||
| $secretKey |
setRegion(string $region) : voidSet which region you are working in.
Inherited from: \Zend_Service_Amazon_Ec2_Abstract::setRegion()It will append the end point automaticly
| Name | Type | Description |
|---|---|---|
| $region | string |
signParameters( $paramaters) : stringComputes 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. |