API Documentation

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

\Zend_Service_Amazon_Ec2_Ebs

An Amazon EC2 interface to create, describe, attach, detach and delete Elastic Block Storage Volumes and Snaphsots.

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_getSecretKey( ) : string

Method to fetch the Secret AWS Key

Inherited from: \Zend_Service_Amazon_Abstract::_getSecretKey()
Returns
Type Description
string
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
methodpublicattachVolume( string $volumeId, string $instanceId, string $device ) : array

Attaches an Amazon EBS volume to an instance

Parameters
Name Type Description
$volumeId string The ID of the Amazon EBS volume
$instanceId string The ID of the instance to which the volume attaches
$device string

Specifies how the device is exposed to the instance (e.g., /dev/sdh).

Returns
Type Description
array
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.
methodpubliccreateNewVolume( string $size, string $availabilityZone ) : array

Creates a new Amazon EBS volume that you can mount from any Amazon EC2 instance.

You must specify an availability zone when creating a volume. The volume and any instance to which it attaches must be in the same availability zone.

Parameters
Name Type Description
$size string The size of the volume, in GiB.
$availabilityZone string The availability zone in which to create the new volume.
Returns
Type Description
array
methodpubliccreateSnapshot( string $volumeId ) : array

Creates a snapshot of an Amazon EBS volume and stores it in Amazon S3. You can use snapshots for backups, to launch instances from identical snapshots, and to save data before shutting down an instance

Parameters
Name Type Description
$volumeId string The ID of the Amazon EBS volume to snapshot
Returns
Type Description
array
methodpubliccreateVolumeFromSnapshot( string $snapshotId, string $availabilityZone ) : array

Creates a new Amazon EBS volume that you can mount from any Amazon EC2 instance.

You must specify an availability zone when creating a volume. The volume and any instance to which it attaches must be in the same availability zone.

Parameters
Name Type Description
$snapshotId string The snapshot from which to create the new volume.
$availabilityZone string The availability zone in which to create the new volume.
Returns
Type Description
array
methodpublicdeleteSnapshot( string $snapshotId ) : boolean

Deletes a snapshot of an Amazon EBS volume that is stored in Amazon S3

Parameters
Name Type Description
$snapshotId string The ID of the Amazon EBS snapshot to delete
Returns
Type Description
boolean
methodpublicdeleteVolume( string $volumeId ) : boolean

Deletes an Amazon EBS volume

Parameters
Name Type Description
$volumeId string The ID of the volume to delete
Returns
Type Description
boolean
methodpublicdescribeAttachedVolumes(  $instanceId ) : void

Parameters
Name Type Description
$instanceId
methodpublicdescribeSnapshot( string|array $snapshotId = null ) : array

Describes the status of Amazon EBS snapshots

Parameters
Name Type Description
$snapshotId string|array

The ID or arry of ID's of the Amazon EBS snapshot

Returns
Type Description
array
methodpublicdescribeVolume( string|array $volumeId = null ) : array

Lists one or more Amazon EBS volumes that you own, If you do not specify any volumes, Amazon EBS returns all volumes that you own.

Parameters
Name Type Description
$volumeId string|array

The ID or array of ID's of the volume(s) to list

Returns
Type Description
array
methodpublicdetachVolume( string $volumeId, string $instanceId = null, string $device = null, boolean $force = false ) : array

Detaches an Amazon EBS volume from an instance

Parameters
Name Type Description
$volumeId string The ID of the Amazon EBS volume
$instanceId string The ID of the instance from which the volume will detach
$device string The device name
$force boolean

Forces detachment if the previous detachment attempt did not occur cleanly (logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach an instance from a failed instance. The instance will not have an opportunity to flush file system caches nor file system meta data.

Returns
Type Description
array
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.