[ Index ]

PHP Cross Reference of moodle-2.8

title

Body

[close]

/lib/zend/Zend/Service/Amazon/Ec2/ -> Image.php (summary)

Zend Framework LICENSE

Copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
License: http://framework.zend.com/license/new-bsd New BSD License
Version: $Id$
File Size: 333 lines (15 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Zend_Service_Amazon_Ec2_Image:: (6 methods):
  register()
  describe()
  deregister()
  modifyAttribute()
  describeAttribute()
  resetAttribute()


Class: Zend_Service_Amazon_Ec2_Image  - X-Ref

An Amazon EC2 interface to register, describe and deregister Amamzon Machine Instances (AMI)

register($imageLocation)   X-Ref
Registers an AMI with Amazon EC2. Images must be registered before
they can be launched.

Each AMI is associated with an unique ID which is provided by the Amazon
EC2 service through the RegisterImage operation. During registration, Amazon
EC2 retrieves the specified image manifest from Amazon S3 and verifies that
the image is owned by the user registering the image.

The image manifest is retrieved once and stored within the Amazon EC2.
Any modifications to an image in Amazon S3 invalidates this registration.
If you make changes to an image, deregister the previous image and register
the new image. For more information, see DeregisterImage.

param: string $imageLocation         Full path to your AMI manifest in Amazon S3 storage.
return: string                       The ami fro the newly registred image;

describe($imageId = null, $owner = null, $executableBy = null)   X-Ref
Returns information about AMIs, AKIs, and ARIs available to the user.
Information returned includes image type, product codes, architecture,
and kernel and RAM disk IDs. Images available to the user include public
images available for any user to launch, private images owned by the user
making the request, and private images owned by other users for which the
user has explicit launch permissions.

Launch permissions fall into three categories:
public: The owner of the AMI granted launch permissions for the AMI
to the all group. All users have launch permissions for these AMIs.
explicit: The owner of the AMI granted launch permissions to a specific user.
implicit: A user has implicit launch permissions for all AMIs he or she owns.

The list of AMIs returned can be modified by specifying AMI IDs, AMI owners,
or users with launch permissions. If no options are specified, Amazon EC2 returns
all AMIs for which the user has launch permissions.

If you specify one or more AMI IDs, only AMIs that have the specified IDs are returned.
If you specify an invalid AMI ID, a fault is returned. If you specify an AMI ID for which
you do not have access, it will not be included in the returned results.

If you specify one or more AMI owners, only AMIs from the specified owners and for
which you have access are returned. The results can include the account IDs of the
specified owners, amazon for AMIs owned by Amazon or self for AMIs that you own.

If you specify a list of executable users, only users that have launch permissions
for the AMIs are returned. You can specify account IDs (if you own the AMI(s)), self
for AMIs for which you own or have explicit permissions, or all for public AMIs.

param: string|array $imageId             A list of image descriptions
param: string|array $owner               Owners of AMIs to describe.
param: string|array $executableBy        AMIs for which specified users have access.
return: array

deregister($imageId)   X-Ref
Deregisters an AMI. Once deregistered, instances of the AMI can no longer be launched.

param: string $imageId                   Unique ID of a machine image, returned by a call
return: boolean

modifyAttribute($imageId, $attribute, $operationType = 'add', $userId = null, $userGroup = null, $productCode = null)   X-Ref
Modifies an attribute of an AMI.

Valid Attributes:
launchPermission:  Controls who has permission to launch the AMI. Launch permissions
can be granted to specific users by adding userIds.
To make the AMI public, add the all group.
productCodes:      Associates a product code with AMIs. This allows developers to
charge users for using AMIs. The user must be signed up for the
product before they can launch the AMI. This is a write once attribute;
after it is set, it cannot be changed or removed.

param: string $imageId                   AMI ID to modify.
param: string $attribute                 Specifies the attribute to modify. See the preceding
param: string $operationType             Specifies the operation to perform on the attribute.
param: string|array $userId              User IDs to add to or remove from the launchPermission attribute.
param: string|array $userGroup           User groups to add to or remove from the launchPermission attribute.
param: string $productCode               Attaches a product code to the AMI. Currently only one product code
return: boolean

describeAttribute($imageId, $attribute)   X-Ref
Returns information about an attribute of an AMI. Only one attribute can be specified per call.

param: string $imageId                   ID of the AMI for which an attribute will be described.
param: string $attribute                 Specifies the attribute to describe.  Valid Attributes are

resetAttribute($imageId, $attribute)   X-Ref
Resets an attribute of an AMI to its default value.  The productCodes attribute cannot be reset

param: string $imageId                   ID of the AMI for which an attribute will be reset.
param: String $attribute                 Specifies the attribute to reset. Currently, only launchPermission is supported.
return: boolean



Generated: Fri Nov 28 20:29:05 2014 Cross-referenced by PHPXref 0.7.1