API Documentation

Service/Amazon/Ec2/Ebs.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Service_Amazon
subpackage
Ec2
version
$Id: Ebs.php 22048 2010-04-28 22:23:19Z shahar $
Classes
Zend_Service_Amazon_Ec2_Ebs

Description

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.

Zend_Service_Amazon_Ec2_Ebs
jump to top

Extends from
Zend_Service_Amazon_Ec2_Abstract
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Service_Amazon
subpackage
Ec2
Methods
createNewVolume
createVolumeFromSnapshot
describeVolume
describeAttachedVolumes
attachVolume
detachVolume
deleteVolume
createSnapshot
describeSnapshot
deleteSnapshot

Description

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

Methods

attachVolume
jump to class

attachVolume( string $volumeId, string $instanceId, string $device ) : array

Attaches an Amazon EBS volume to an instance

Arguments
$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).
Output
array
Details
visibility
public
final
false
static
false

createNewVolume
jump to class

createNewVolume( 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.

Arguments
$size
string
The size of the volume, in GiB.
$availabilityZone
string
The availability zone in which to create the new volume.
Output
array
Details
visibility
public
final
false
static
false

createSnapshot
jump to class

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

Arguments
$volumeId
string
The ID of the Amazon EBS volume to snapshot
Output
array
Details
visibility
public
final
false
static
false

createVolumeFromSnapshot
jump to class

createVolumeFromSnapshot( 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.

Arguments
$snapshotId
string
The snapshot from which to create the new volume.
$availabilityZone
string
The availability zone in which to create the new volume.
Output
array
Details
visibility
public
final
false
static
false

deleteSnapshot
jump to class

deleteSnapshot( string $snapshotId ) : boolean

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

Arguments
$snapshotId
string
The ID of the Amazon EBS snapshot to delete
Output
boolean
Details
visibility
public
final
false
static
false

deleteVolume
jump to class

deleteVolume( string $volumeId ) : boolean

Deletes an Amazon EBS volume

Arguments
$volumeId
string
The ID of the volume to delete
Output
boolean
Details
visibility
public
final
false
static
false

describeAttachedVolumes
jump to class

describeAttachedVolumes(  $instanceId ) :
Arguments
$instanceId
Details
visibility
public
final
false
static
false

describeSnapshot
jump to class

describeSnapshot( string|array $snapshotId = null ) : array

Describes the status of Amazon EBS snapshots

Arguments
$snapshotId
stringarray
The ID or arry of ID's of the Amazon EBS snapshot
Output
array
Details
visibility
public
final
false
static
false

describeVolume
jump to class

describeVolume( 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.

Arguments
$volumeId
stringarray
The ID or array of ID's of the volume(s) to list
Output
array
Details
visibility
public
final
false
static
false

detachVolume
jump to class

detachVolume( string $volumeId, string $instanceId = null, string $device = null, boolean $force = false ) : array

Detaches an Amazon EBS volume from an instance

Arguments
$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.
Output
array
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.