API Documentation

Zend/Service/Amazon/Ec2/Keypair.php

Show: inherited
Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Service_Amazon  
Subpackage
Ec2  
Version
$Id: Keypair.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Service_Amazon_Ec2_Keypair

Package: Zend\Service\Amazon\Ec2

An Amazon EC2 interface to create, delete and describe Ec2 KeyPairs.

Parent(s)
\Zend_Service_Amazon_Ec2_Abstract < \Zend_Service_Amazon_Abstract < \Zend_Service_Abstract
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Methods

methodpubliccreate( string $keyName ) : array

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
Name Type Description
$keyName string

A unique name for the key pair.

Returns
Type Description
array
Throws
Exception Description
\Zend_Service_Amazon_Ec2_Exception
methodpublicdelete( string $keyName ) : boolean

Deletes a key pair

Parameters
Name Type Description
$keyName string

Name of the key pair to delete.

Returns
Type Description
boolean Return true or false from the deletion.
Throws
Exception Description
\Zend_Service_Amazon_Ec2_Exception
methodpublicdescribe( string|\rarray $keyName = null ) : array

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
Name Type Description
$keyName string|\rarray

Key pair IDs to describe.

Returns
Type Description
array
Documentation was generated by DocBlox 0.15.1.