Service/Amazon/Ec2/Instance/Reserved.php

Show:

inherited

Classes
- \Zend_Service_Amazon_Ec2_Instance_Reserved

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

\Zend_Service_Amazon_Ec2_Instance_Reserved
jump to top

Package: Zend\Service\Amazon\Ec2

Allows you to interface with the reserved instances on Amazon Ec2

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

inherited

Amazon Access Key

Inherited from: \Zend_Service_Amazon_Abstract::$$_accessKey \Zend_Service_Amazon_Ec2_Abstract::$$_accessKey

Details

Type: string
Inherited_from: \Zend_Service_Amazon_Abstract::$$_accessKey
Inherited_from: \Zend_Service_Amazon_Ec2_Abstract::$$_accessKey

string $_defaultAccessKey = null

staticinherited

Amazon Access Key

Inherited from: \Zend_Service_Amazon_Abstract::$$_defaultAccessKey \Zend_Service_Amazon_Ec2_Abstract::$$_defaultAccessKey

Default valuenullDetails

Type: string
Inherited_from: \Zend_Service_Amazon_Abstract::$$_defaultAccessKey
Inherited_from: \Zend_Service_Amazon_Ec2_Abstract::$$_defaultAccessKey

string $_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

string $_defaultSecretKey = null

staticinherited

Amazon Secret Key

Inherited from: \Zend_Service_Amazon_Abstract::$$_defaultSecretKey \Zend_Service_Amazon_Ec2_Abstract::$$_defaultSecretKey

Default valuenullDetails

Type: string
Inherited_from: \Zend_Service_Amazon_Abstract::$$_defaultSecretKey
Inherited_from: \Zend_Service_Amazon_Ec2_Abstract::$$_defaultSecretKey

$_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

$_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

$_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

$_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

\Zend_Http_Client $_httpClient = null

staticinherited

HTTP Client used to query all web services

Inherited from: \Zend_Service_Abstract::$$_httpClient \Zend_Service_Amazon_Abstract::$$_httpClient \Zend_Service_Amazon_Ec2_Abstract::$$_httpClient

Default valuenullDetails

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 = 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

string $_region

inherited

Amazon Region

Inherited from: \Zend_Service_Amazon_Ec2_Abstract::$$_region

Details

Type: string
Inherited_from: \Zend_Service_Amazon_Ec2_Abstract::$$_region

string $_secretKey

inherited

Amazon Secret Key

Inherited from: \Zend_Service_Amazon_Abstract::$$_secretKey \Zend_Service_Amazon_Ec2_Abstract::$$_secretKey

Details

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

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

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

inherited

Create Amazon client.

Inherited from: \Zend_Service_Amazon_Ec2_Abstract::__construct()

Parameters

Name	Type	Description
$accessKey
$secretKey
$region	string	Sets the AWS Region

_getAccessKey() : string

inherited

Method to fetch the Access Key

Inherited from: \Zend_Service_Amazon_Abstract::_getAccessKey()\Zend_Service_Amazon_Ec2_Abstract::_getAccessKey()

Returns

Type	Description
string

_getRegion() : string

inherited

Method to fetch the AWS Region

Inherited from: \Zend_Service_Amazon_Ec2_Abstract::_getRegion()

Returns

Type	Description
string

_getSecretKey() : string

inherited

Method to fetch the Secret AWS Key

Inherited from: \Zend_Service_Amazon_Abstract::_getSecretKey()\Zend_Service_Amazon_Ec2_Abstract::_getSecretKey()

Returns

Type	Description
string

addRequiredParameters(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

Name	Type	Description
$parameters	array	the array to which to add the required parameters.

Returns

Type	Description
array

checkForErrors(\Zend_Service_Amazon_Ec2_Response $response) : void

inherited

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.

describeInstances(string | array $instanceId) : array

Describes Reserved Instances that you purchased.

Parameters

Name	Type	Description
$instanceId	string \| array	IDs of the Reserved Instance to describe.

Returns

Type	Description
array

describeOfferings() : array

Describes Reserved Instance offerings that are available for purchase.

With Amazon EC2 Reserved Instances, you purchase the right to launch Amazon EC2 instances for a period of time (without getting insufficient capacity errors) and pay a lower usage rate for the actual time used.

Returns

Type	Description
array

getHttpClient() : \Zend_Http_Client

staticfinalinherited

Gets the HTTP client object.

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

Returns

Type	Description
\Zend_Http_Client

purchaseOffering(string $offeringId, integer $intanceCount = 1) : string

Purchases a Reserved Instance for use with your account.

Parameters

Name	Type	Description
$offeringId	string	The offering ID of the Reserved Instance to purchase
$intanceCount	integer	The number of Reserved Instances to purchase.

Returns

Type	Description
string	The ID of the purchased Reserved Instances.

sendRequest(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

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

setHttpClient(\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

Name	Type	Description
$httpClient	\Zend_Http_Client

setKeys( $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

Name	Type	Description
$accessKey
$secretKey

setRegion(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

Name	Type	Description
$region	string

signParameters( $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:

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.

Parameters

Name	Type	Description
$paramaters

Returns

Type	Description
string	the signed data.

Service/Amazon/Ec2/Instance/Reserved.php

\Zend_Service_Amazon_Ec2_Instance_Reservedjump to top

Properties

Methods

\Zend_Service_Amazon_Ec2_Instance_Reserved
jump to top