Zend Framework API Documentation » \Zend_Service_Amazon_Ec2

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

category	Zend
package	Zend_Service_Amazon
subpackage	Ec2
copyright	Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license	New BSD License
inherited_from	\Zend_Service_Amazon_Ec2_Abstract

Methods

Create Amazon client.

__construct($accessKey = null, $secretKey = null) : void

Inherited

Parameters

$accessKey

$secretKey

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

deregister(string $imageId) : boolean

Parameters

$imageId

string

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

Returns

boolean

Returns information about AMIs, AKIs, and ARIs available to the user.

describe(string|array $imageId = null, string|array $owner = null, string|array $executableBy = null) : array

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

$imageId

stringarray

A list of image descriptions

$owner

stringarray

Owners of AMIs to describe.

$executableBy

stringarray

AMIs for which specified users have access.

Returns

array

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

describeAttribute(string $imageId, string $attribute)

Parameters

$imageId

string

ID of the AMI for which an attribute will be described.

$attribute

string

Specifies the attribute to describe. Valid Attributes are launchPermission, productCodes

Gets the HTTP client object.

getHttpClient() : \Zend_Http_Client

InheritedStatic

Returns

\Zend_Http_Client

Modifies an attribute of an AMI.

modifyAttribute(string $imageId, string $attribute, string $operationType = 'add', string|array $userId = null, string|array $userGroup = null, string $productCode = null) : boolean

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

$imageId

string

AMI ID to modify.

$attribute

string

Specifies the attribute to modify. See the preceding attributes table for supported attributes.

$operationType

string

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

$userId

stringarray

User IDs to add to or remove from the launchPermission attribute. Required for launchPermssion Attribute

$userGroup

stringarray

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

$productCode

string

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

Registers an AMI with Amazon EC2. Images must be registered before they can be launched.

register(string $imageLocation) : string

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

$imageLocation

string

Full path to your AMI manifest in Amazon S3 storage.

Returns

stringThe ami fro the newly registred image;

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

resetAttribute(string $imageId, String $attribute) : boolean

Parameters

$imageId

string

ID of the AMI for which an attribute will be reset.

$attribute

String

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

Sets the HTTP client object to use for retrieving the feeds. If none is set, the default Zend_Http_Client will be used.

setHttpClient(\Zend_Http_Client $httpClient)

InheritedStatic

Parameters

$httpClient

\Zend_Http_Client

Set the keys to use when accessing SQS.

setKeys($accessKey, $secretKey) : void

InheritedStatic

Parameters

$accessKey

$secretKey

Set which region you are working in. It will append the end point automaticly

setRegion(string $region)

InheritedStatic

Parameters

$region

string

Method to fetch the Access Key

_getAccessKey() : string

Inherited

Returns

string

Method to fetch the AWS Region

_getRegion() : string

Inherited

Returns

string

Method to fetch the Secret AWS Key

_getSecretKey() : string

Inherited

Returns

string

Adds required authentication and version parameters to an array of parameters

addRequiredParameters(array $parameters) : array

Inherited

The required parameters are:

AWSAccessKey
SignatureVersion
Timestamp
Version and
Signature

If a required parameter is already set in the $parameters array, it is overwritten.

Parameters

$parameters

array

the array to which to add the required parameters.

Returns

array

Sends a HTTP request to the queue service using Zend_Http_Client

sendRequest(array $params = array()) : \Zend_Service_Amazon_Ec2_Response

Inherited

Parameters

$params

array

List of parameters to send with the request

Exceptions

`\Zend_Service_Amazon_Ec2_Exception`

Returns

\Zend_Service_Amazon_Ec2_Response

Computes the RFC 2104-compliant HMAC signature for request parameters

signParameters(array $paramaters) : string

Inherited

This implements the Amazon Web Services signature, as per the following specification:

Sort all request parameters (including SignatureVersion and excluding Signature, the value of which is being created), ignoring case.
Iterate over the sorted list and append the parameter name (in its original case) and then its value. Do not URL-encode the parameter values before constructing this string. Do not use any separator characters when appending strings.

Parameters

$paramaters

Returns

stringthe signed data.

Checks for errors responses from Amazon

checkForErrors(\Zend_Service_Amazon_Ec2_Response $response) : void

Inherited

Parameters

$response

\Zend_Service_Amazon_Ec2_Response

the response object to check.

Exceptions

`\Zend_Service_Amazon_Ec2_Exception`	if one or more errors are returned from Amazon.

Properties

Amazon Access Key

$_accessKey : string

Default

Amazon Access Key

$_defaultAccessKey : string

Default

null

Static

Amazon Region

$_defaultRegion : string

Default

null

Static

Amazon Secret Key

$_defaultSecretKey : string

Default

null

Static

The API version to use

$_ec2ApiVersion

Default

'2009-04-04'

The HTTP query server

$_ec2Endpoint

Default

'ec2.amazonaws.com'

Signature Encoding Method

$_ec2SignatureMethod

Default

'HmacSHA256'

Signature Version

$_ec2SignatureVersion

Default

'2'

HTTP Client used to query all web services

$_httpClient : \Zend_Http_Client

Default

null

Static

Period after which HTTP request will timeout in seconds

$_httpTimeout

Default

10

Amazon Region

$_region : string

Default

Amazon Secret Key

$_secretKey : string

Default

An array that contains all the valid Amazon Ec2 Regions.

$_validEc2Regions : array

Default

array('eu-west-1', 'us-east-1')

Static