Class Zend_Service_Amazon_Ec2_Ebs

Description
Description | Vars | Methods (details)

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

  • copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
  • license: New BSD License

Located in /Service/Amazon/Ec2/Ebs.php (line 38) 

Zend_Service_Abstract
   |
   --Zend_Service_Amazon_Abstract
      |
      --Zend_Service_Amazon_Ec2_Abstract
         |
         --Zend_Service_Amazon_Ec2_Ebs
Method Summary
Description | Vars | Methods (details)
array attachVolume (string $volumeId, string $instanceId, string $device)
array createNewVolume (string $size, string $availabilityZone)
array createSnapshot (string $volumeId)
array createVolumeFromSnapshot (string $snapshotId, string $availabilityZone)
boolean deleteSnapshot (string $snapshotId)
boolean deleteVolume (string $volumeId)
void describeAttachedVolumes ( $instanceId)
array describeSnapshot ([string|array $snapshotId = null])
array describeVolume ([string|array $volumeId = null])
array detachVolume (string $volumeId, [string $instanceId = null], [string $device = null], [boolean $force = false])
Variables
Description | Vars (details) | Methods (details)

Inherited Variables

Inherited from Zend_Service_Amazon_Ec2_Abstract

Zend_Service_Amazon_Ec2_Abstract::$_defaultRegion
 Zend_Service_Amazon_Ec2_Abstract::$_ec2ApiVersion
 Zend_Service_Amazon_Ec2_Abstract::$_ec2Endpoint
 Zend_Service_Amazon_Ec2_Abstract::$_ec2SignatureMethod
 Zend_Service_Amazon_Ec2_Abstract::$_ec2SignatureVersion
 Zend_Service_Amazon_Ec2_Abstract::$_httpTimeout
 Zend_Service_Amazon_Ec2_Abstract::$_region
 Zend_Service_Amazon_Ec2_Abstract::$_validEc2Regions

Inherited from Zend_Service_Amazon_Abstract

Zend_Service_Amazon_Abstract::$_accessKey
 Zend_Service_Amazon_Abstract::$_defaultAccessKey
 Zend_Service_Amazon_Abstract::$_defaultSecretKey
 Zend_Service_Amazon_Abstract::$_secretKey

Inherited from Zend_Service_Abstract

Zend_Service_Abstract::$_httpClient
Methods
Description | Vars Methods (details)
attachVolume (line 176)

Attaches an Amazon EBS volume to an instance

  • access: public
array attachVolume (string $volumeId, string $instanceId, string $device)
  • string $volumeId: The ID of the Amazon EBS volume
  • string $instanceId: The ID of the instance to which the volume attaches
  • string $device: Specifies how the device is exposed to the instance (e.g., /dev/sdh).
createNewVolume (line 50)

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.

  • access: public
array createNewVolume (string $size, string $availabilityZone)
  • string $size: The size of the volume, in GiB.
  • string $availabilityZone: The availability zone in which to create the new volume.
createSnapshot (line 262)

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

  • access: public
array createSnapshot (string $volumeId)
  • string $volumeId: The ID of the Amazon EBS volume to snapshot
createVolumeFromSnapshot (line 80)

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.

  • access: public
array createVolumeFromSnapshot (string $snapshotId, string $availabilityZone)
  • string $snapshotId: The snapshot from which to create the new volume.
  • string $availabilityZone: The availability zone in which to create the new volume.
deleteSnapshot (line 329)

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

  • access: public
boolean deleteSnapshot (string $snapshotId)
  • string $snapshotId: The ID of the Amazon EBS snapshot to delete
deleteVolume (line 241)

Deletes an Amazon EBS volume

  • access: public
boolean deleteVolume (string $volumeId)
  • string $volumeId: The ID of the volume to delete
describeAttachedVolumes (line 154)
  • access: public
void describeAttachedVolumes ( $instanceId)
  • $instanceId
describeSnapshot (line 288)

Describes the status of Amazon EBS snapshots

  • access: public
array describeSnapshot ([string|array $snapshotId = null])
  • string|array $snapshotId: The ID or arry of ID's of the Amazon EBS snapshot
describeVolume (line 108)

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.

  • access: public
array describeVolume ([string|array $volumeId = null])
  • string|array $volumeId: The ID or array of ID's of the volume(s) to list
detachVolume (line 212)

Detaches an Amazon EBS volume from an instance

  • access: public
array detachVolume (string $volumeId, [string $instanceId = null], [string $device = null], [boolean $force = false])
  • string $volumeId: The ID of the Amazon EBS volume
  • string $instanceId: The ID of the instance from which the volume will detach
  • string $device: The device name
  • boolean $force: 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.

Inherited Methods

Inherited From Zend_Service_Amazon_Ec2_Abstract

Zend_Service_Amazon_Ec2_Abstract::__construct()
Zend_Service_Amazon_Ec2_Abstract::addRequiredParameters()
Zend_Service_Amazon_Ec2_Abstract::sendRequest()
Zend_Service_Amazon_Ec2_Abstract::setRegion()
Zend_Service_Amazon_Ec2_Abstract::signParameters()
Zend_Service_Amazon_Ec2_Abstract::_getRegion()

Inherited From Zend_Service_Amazon_Abstract

Zend_Service_Amazon_Abstract::__construct()
Zend_Service_Amazon_Abstract::setKeys()
Zend_Service_Amazon_Abstract::_getAccessKey()
Zend_Service_Amazon_Abstract::_getSecretKey()

Inherited From Zend_Service_Abstract

Zend_Service_Abstract::getHttpClient()
Zend_Service_Abstract::setHttpClient()

Documentation generated on Mon, 21 Jun 2010 15:18:24 -0400 by phpDocumentor 1.4.3