Zend_Service_Amazon_Ec2_Image Class Reference

Inheritance diagram for Zend_Service_Amazon_Ec2_Image:

Collaboration diagram for Zend_Service_Amazon_Ec2_Image:

Public Member Functions
	register ($imageLocation)
	describe ($imageId=null, $owner=null, $executableBy=null)
	deregister ($imageId)
	modifyAttribute ($imageId, $attribute, $operationType= 'add', $userId=null, $userGroup=null, $productCode=null)
	describeAttribute ($imageId, $attribute)
	resetAttribute ($imageId, $attribute)

---

Detailed Description

Definition at line 37 of file Image.php.

---

Member Function Documentation

deregister

(

$

imageId

)

Deregisters an AMI. Once deregistered, instances of the AMI can no longer be launched.

Parameters:

string

$imageId

Unique ID of a machine image, returned by a call to RegisterImage or DescribeImages.

Returns:

boolean

Definition at line 168 of file Image.php.

Here is the call graph for this function:

describe	(	$	imageId = null,
		$	owner = null,
		$	executableBy = null
	)

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.

Parameters:

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

Returns:

array

Definition at line 105 of file Image.php.

Here is the call graph for this function:

describeAttribute	(	$	imageId,
		$	attribute
	)

Returns information about an attribute of an AMI. Only one attribute can be specified per call.

Parameters:

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

Definition at line 270 of file Image.php.

Here is the call graph for this function:

modifyAttribute	(	$	imageId,
		$	attribute,
		$	operationType = 'add',
		$	userId = null,
		$	userGroup = null,
		$	productCode = null
	)

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.

Parameters:

string	$imageId	AMI ID to modify.
string	$attribute	Specifies the attribute to modify. See the preceding attributes table for supported attributes.
string	$operationType	Specifies the operation to perform on the attribute. See the preceding attributes table for supported operations for attributes. Valid Values: add | remove Required for launchPermssion Attribute
string | array	$userId	User IDs to add to or remove from the launchPermission attribute. Required for launchPermssion Attribute
string | array	$userGroup	User groups to add to or remove from the launchPermission attribute. Currently, the all group is available, which will make it a public AMI. Required for launchPermssion Attribute
string	$productCode	Attaches a product code to the AMI. Currently only one product code can be associated with an AMI. Once set, the product code cannot be changed or reset. Required for productCodes Attribute

Returns:

boolean

Definition at line 212 of file Image.php.

Here is the call graph for this function:

register

(

$

imageLocation

)

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.

Parameters:

string

$imageLocation

Full path to your AMI manifest in Amazon S3 storage.

Returns:

string The ami fro the newly registred image;

Definition at line 56 of file Image.php.

Here is the call graph for this function:

resetAttribute	(	$	imageId,
		$	attribute
	)

Resets an attribute of an AMI to its default value. The productCodes attribute cannot be reset

Parameters:

string	$imageId	ID of the AMI for which an attribute will be reset.
String	$attribute	Specifies the attribute to reset. Currently, only launchPermission is supported. In the case of launchPermission, all public and explicit launch permissions for the AMI are revoked.

Returns:

boolean

Definition at line 319 of file Image.php.

Here is the call graph for this function:

---

The documentation for this class was generated from the following file:

• C:/xampp/htdocs/moodle/lib/zend/Zend/Service/Amazon/Ec2/Image.php