Zend Framework  1.12
Public Member Functions | List of all members
Zend_Service_Amazon_Ec2_Keypair Class Reference

Public Member Functions

 create ($keyName)
 Creates a new 2048 bit RSA key pair and returns a unique ID that can be used to reference this key pair when launching new instances.
 
 describe ($keyName=null)
 Returns information about key pairs available to you.
 
 delete ($keyName)
 Deletes a key pair.
 
- Public Member Functions inherited from Zend_Service_Amazon_Ec2_Abstract
 __construct ($accessKey=null, $secretKey=null, $region=null)
 Create Amazon client.
 
- Public Member Functions inherited from Zend_Service_Amazon_Abstract
 __construct ($accessKey=null, $secretKey=null)
 Create Amazon client.
 

Additional Inherited Members

- Static Public Member Functions inherited from Zend_Service_Amazon_Ec2_Abstract
static setRegion ($region)
 Set which region you are working in.
 
- Protected Member Functions inherited from Zend_Service_Amazon_Ec2_Abstract
 _getRegion ()
 Method to fetch the AWS Region.
 
 sendRequest (array $params=array())
 Sends a HTTP request to the queue service using Zend_Http_Client.
 
 addRequiredParameters (array $parameters)
 Adds required authentication and version parameters to an array of parameters.
 
 signParameters (array $paramaters)
 Computes the RFC 2104-compliant HMAC signature for request parameters.
 
- Protected Attributes inherited from Zend_Service_Amazon_Ec2_Abstract
 $_ec2Endpoint = 'ec2.amazonaws.com'
 The HTTP query server.
 
 $_ec2ApiVersion = '2009-04-04'
 The API version to use.
 
 $_ec2SignatureVersion = '2'
 Signature Version.
 
 $_ec2SignatureMethod = 'HmacSHA256'
 Signature Encoding Method.
 
 $_httpTimeout = 10
 Period after which HTTP request will timeout in seconds.
 
 $_region
 
- Static Protected Attributes inherited from Zend_Service_Amazon_Ec2_Abstract
static $_defaultRegion = null
 
static $_validEc2Regions = array('eu-west-1', 'us-east-1')
 

Member Function Documentation

create (   $keyName)

Creates a new 2048 bit RSA key pair and returns a unique ID that can be used to reference this key pair when launching new instances.

Parameters
string$keyNameA unique name for the key pair.
Exceptions
Zend_Service_Amazon_Ec2_Exception
Returns
array
delete (   $keyName)

Deletes a key pair.

Parameters
string$keyNameName of the key pair to delete.
Exceptions
Zend_Service_Amazon_Ec2_Exception
Returns
boolean Return true or false from the deletion.
describe (   $keyName = null)

Returns information about key pairs available to you.

If you specify key pairs, information about those key pairs is returned. Otherwise, information for all registered key pairs is returned.

Parameters
string | rarray$keyNameKey pair IDs to describe.
Returns
array