API Documentation

Zend/Service/Amazon/Ec2/Ebs.php

Show: inherited
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: Ebs.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Service_Amazon_Ec2_Ebs

Package: Zend\Service\Amazon\Ec2

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

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  

Methods

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
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
Documentation was generated by DocBlox 0.15.1.