Service/Amazon/Ec2/Ebs.php

Show: PublicProtectedPrivateinherited
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 [email protected] so we can send you a copy immediately.
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Service_Amazon  
Subpackage
Ec2  
Version
$Id$  

\Zend_Service_Amazon_Ec2_Ebs
jump to top

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-2014 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
NameTypeDescription
$volumeIdstring

The ID of the Amazon EBS volume

$instanceIdstring

The ID of the instance to which the volume attaches

$devicestring

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

Returns
TypeDescription
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
NameTypeDescription
$sizestring

The size of the volume, in GiB.

$availabilityZonestring

The availability zone in which to create the new volume.

Returns
TypeDescription
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
NameTypeDescription
$volumeIdstring

The ID of the Amazon EBS volume to snapshot

Returns
TypeDescription
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
NameTypeDescription
$snapshotIdstring

The snapshot from which to create the new volume.

$availabilityZonestring

The availability zone in which to create the new volume.

Returns
TypeDescription
array
methodpublicdeleteSnapshot(string $snapshotId) : boolean

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

Parameters
NameTypeDescription
$snapshotIdstring

The ID of the Amazon EBS snapshot to delete

Returns
TypeDescription
boolean
methodpublicdeleteVolume(string $volumeId) : boolean

Deletes an Amazon EBS volume

Parameters
NameTypeDescription
$volumeIdstring

The ID of the volume to delete

Returns
TypeDescription
boolean
methodpublicdescribeAttachedVolumes( $instanceId) : void

Parameters
NameTypeDescription
$instanceId
methodpublicdescribeSnapshot(string | array $snapshotId = null) : array

Describes the status of Amazon EBS snapshots

Parameters
NameTypeDescription
$snapshotIdstring | array

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

Returns
TypeDescription
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
NameTypeDescription
$volumeIdstring | array

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

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

Detaches an Amazon EBS volume from an instance

Parameters
NameTypeDescription
$volumeIdstring

The ID of the Amazon EBS volume

$instanceIdstring

The ID of the instance from which the volume will detach

$devicestring

The device name

$forceboolean

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
TypeDescription
array
Documentation was generated by phpDocumentor 2.2.0 .