Docs For Class Zend_Service_Amazon_Ec2

Description

An Amazon EC2 interface that allows yout to run, terminate, reboot and describe Amazon Ec2 Instances.

copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: New BSD License

Located in /Service/Amazon/Ec2/Instance.php (line 38)

Zend_Service_Abstract
   |
   --Zend_Service_Amazon_Abstract
      |
      --Zend_Service_Amazon_Ec2_Abstract
         |
         --Zend_Service_Amazon_Ec2_Instance

Class Constant Summary

HCPU_MEDIUM = 'c1.medium'

HCPU_XLARGE = 'c1.xlarge'

LARGE = 'm1.large'

SMALL = 'm1.small'

XLARGE = 'm1.xlarge'

Method Summary

array|boolean confirmProduct (string $productCode, string $instanceId)

array consoleOutput (string $instanceId)

array describe ([ $instanceId = null], [boolean $ignoreTerminated = false], string|array $instaceId)

array describeByImageId (string $imageId, [boolean $ignoreTerminated = false])

array monitor (array|string $instanceId)

boolean reboot (string|array $instanceId)

array run ( $options)

array terminate (string|array $instanceId)

array unmonitor (array|string $instanceId)

Variables

Inherited Variables

Inherited from Zend_Service_Amazon_Ec2_Abstract

Zend_Service_Amazon_Ec2_Abstract::$_defaultRegion
Zend_Service_Amazon_Ec2_Abstract::$_ec2ApiVersion
Zend_Service_Amazon_Ec2_Abstract::$_ec2Endpoint
Zend_Service_Amazon_Ec2_Abstract::$_ec2SignatureMethod
Zend_Service_Amazon_Ec2_Abstract::$_ec2SignatureVersion
Zend_Service_Amazon_Ec2_Abstract::$_httpTimeout
Zend_Service_Amazon_Ec2_Abstract::$_region
Zend_Service_Amazon_Ec2_Abstract::$_validEc2Regions

Inherited from Zend_Service_Amazon_Abstract

Zend_Service_Amazon_Abstract::$_accessKey
Zend_Service_Amazon_Abstract::$_defaultAccessKey
Zend_Service_Amazon_Abstract::$_defaultSecretKey
Zend_Service_Amazon_Abstract::$_secretKey

Inherited from Zend_Service_Abstract

Zend_Service_Abstract::$_httpClient

Methods

confirmProduct (line 433)

Returns true if the specified product code is attached to the specified instance.

The operation returns false if the product code is not attached to the instance.

The confirmProduct operation can only be executed by the owner of the AMI. This feature is useful when an AMI owner is providing support and wants to verify whether a user's instance is eligible.

return: An array if the product code is attached to the instance, false if it is not.
access: public

array|boolean confirmProduct (string $productCode, string $instanceId)

string $productCode: The product code to confirm.
string $instanceId: The instance for which to confirm the product code.

consoleOutput (line 403)

Retrieves console output for the specified instance.

Instance console output is buffered and posted shortly after instance boot, reboot, and termination. Amazon EC2 preserves the most recent 64 KB output which will be available for at least one hour after the most recent post.

access: public

array consoleOutput (string $instanceId)

string $instanceId: An instance ID

describe (line 229)

Returns information about instances that you own.

If you specify one or more instance IDs, Amazon EC2 returns information for those instances. If you do not specify instance IDs, Amazon EC2 returns information for all relevant instances. If you specify an invalid instance ID, a fault is returned. If you specify an instance that you do not own, it will not be included in the returned results.

Recently terminated instances might appear in the returned results. This interval is usually less than one hour.

access: public

array describe ([ $instanceId = null], [boolean $ignoreTerminated = false], string|array $instaceId)

string|array $instaceId: Set of instances IDs of which to get the status.
boolean $ignoreTerminated: Ture to ignore Terminated Instances.
$instanceId

describeByImageId (line 306)

Returns information about instances that you own that were started from a specific imageId

Recently terminated instances might appear in the returned results. This interval is usually less than one hour.

access: public

array describeByImageId (string $imageId, [boolean $ignoreTerminated = false])

string $imageId: The imageId used to start the Instance.
boolean $ignoreTerminated: Ture to ignore Terminated Instances.

monitor (line 461)

Turn on Amazon CloudWatch Monitoring for an instance or a list of instances

access: public

array monitor (array|string $instanceId)

array|string $instanceId: The instance or list of instances you want to enable monitoring for

reboot (line 373)

Requests a reboot of one or more instances.

This operation is asynchronous; it only queues a request to reboot the specified instance(s). The operation will succeed if the instances are valid and belong to the user. Requests to reboot terminated instances are ignored.

access: public

boolean reboot (string|array $instanceId)

string|array $instanceId: One or more instance IDs.

run (line 108)

Launches a specified number of Instances.

If Amazon EC2 cannot launch the minimum number AMIs you request, no instances launch. If there is insufficient capacity to launch the maximum number of AMIs you request, Amazon EC2 launches as many as possible to satisfy the requested maximum values.

Every instance is launched in a security group. If you do not specify a security group at launch, the instances start in your default security group. For more information on creating security groups, see CreateSecurityGroup.

An optional instance type can be specified. For information about instance types, see Instance Types.

You can provide an optional key pair ID for each image in the launch request (for more information, see CreateKeyPair). All instances that are created from images that use this key pair will have access to the associated public key at boot. You can use this key to provide secure access to an instance of an image on a per-instance basis. Amazon EC2 public images use this feature to provide secure access without passwords.

Launching public images without a key pair ID will leave them inaccessible.

access: public

array run ( $options)

array $options: An array that contins the options to start an instance. Required Values: imageId string ID of the AMI with which to launch instances. Optional Values: minCount integer Minimum number of instances to launch. maxCount integer Maximum number of instances to launch. keyName string Name of the key pair with which to launch instances. securityGruop string|array Names of the security groups with which to associate the instances. userData string The user data available to the launched instances. This should not be Base64 encoded. instanceType constant Specifies the instance type. placement string Specifies the availability zone in which to launch the instance(s). By default, Amazon EC2 selects an availability zone for you. kernelId string The ID of the kernel with which to launch the instance. ramdiskId string The ID of the RAM disk with which to launch the instance. blockDeviceVirtualName string Specifies the virtual name to map to the corresponding device name. For example: instancestore0 blockDeviceName string Specifies the device to which you are mapping a virtual name. For example: sdb monitor boolean Turn on CloudWatch Monitoring for an instance.

terminate (line 329)

Shuts down one or more instances. This operation is idempotent; if you terminate an instance more than once, each call will succeed.

Terminated instances will remain visible after termination (approximately one hour).

access: public

array terminate (string|array $instanceId)

string|array $instanceId: One or more instance IDs returned.

unmonitor (line 497)

Turn off Amazon CloudWatch Monitoring for an instance or a list of instances

access: public

array unmonitor (array|string $instanceId)

array|string $instanceId: The instance or list of instances you want to disable monitoring for

Inherited Methods

Inherited From Zend_Service_Amazon_Ec2_Abstract

Zend_Service_Amazon_Ec2_Abstract::__construct()
Zend_Service_Amazon_Ec2_Abstract::addRequiredParameters()
Zend_Service_Amazon_Ec2_Abstract::sendRequest()
Zend_Service_Amazon_Ec2_Abstract::setRegion()
Zend_Service_Amazon_Ec2_Abstract::signParameters()
Zend_Service_Amazon_Ec2_Abstract::_getRegion()

Inherited From Zend_Service_Amazon_Abstract

Zend_Service_Amazon_Abstract::__construct()
Zend_Service_Amazon_Abstract::setKeys()
Zend_Service_Amazon_Abstract::_getAccessKey()
Zend_Service_Amazon_Abstract::_getSecretKey()

Inherited From Zend_Service_Abstract

Zend_Service_Abstract::getHttpClient()
Zend_Service_Abstract::setHttpClient()

Class Constants

HCPU_MEDIUM = 'c1.medium' (line 58)

Constant for High CPU Medium Instance TYpe

HCPU_XLARGE = 'c1.xlarge' (line 63)

Constant for High CPU X-Large Instance TYpe

LARGE = 'm1.large' (line 48)

Constant for Large Instance TYpe

SMALL = 'm1.small' (line 43)

Constant for Small Instance TYpe

XLARGE = 'm1.xlarge' (line 53)

Constant for X-Large Instance TYpe