Advanced Alerting APIs
Public Member Functions
EC2Client Interface Reference

provides the ability to provision, start, stop, describe, and reboot EC2 instances. More...

List of all members.

Public Member Functions

object run (object request)
object start (object request)
object stop (object request)
void reboot (object request)
object status ()
object status (object request)

Detailed Description

provides the ability to provision, start, stop, describe, and reboot EC2 instances.

Author:
Matt Rodriguez

Member Function Documentation

void reboot ( object  request)

Reboot EC2 instances

Parameters:
requestis a javascript object which must contains instanceIds which is an array of strings, where each string is an id of a running instance.
object run ( object  request)

Run a new EC2 instance

Parameters:
requestis javascript object which must contain
  • imageId the AMI id
  • minCount the minimum number of instances to launch
  • maxCount the maximum number of instances to launch
and may contain
  • additionalInfo a string of addtional information associated with the instance(s)
  • addressingType a string of the addressing type.
  • blockDeviceMappings an array of block device mappings
  • clientToken a string identifier to ensure idempotency of the request.
  • disableApiTermination a boolean specifying whether the instances can be shutdown using an API request.
  • instanceInitiatedShutdownBehavior a string specifying whether EBS volumes are stopped or terminated when the instance is shut down.
  • instanceType a string of the instance type.
  • kernelId a string of the kernel Id
  • keyName a string the name of key pair
  • license an object with an attribute pool that specifies the license pool.
  • monitoring a boolean specifying whether to monitor the instance.
  • networkInterfaces a javascript object specifying the network interface.
  • placement a javascript object with availabilityZone,groupName, and tenancy attributes.
  • privateIpAddress a string of the private IP address.
  • ramdiskId a string of the ramdisk Id
  • securityGroupIds an array of security group ids
  • securityGroups an array of security group names
  • subnetId a string of the subnetId which to launch the instance(s) for Amazon Virtual Private Cloud.
  • userData a string of additional userdata information.
Returns:
a javascript object containing information about the instance(s) that will be launched.
object start ( object  request)

Start EC2 instances that have been stopped.

Parameters:
requestis a javascript object which must contains instanceIds which is an array of strings, where each string is an id of a stopped instance.
Returns:
a javascript object which returns the instances that will be started
object status ( )

Get the status of all EC2 instances associated with your credentials.

Returns:
a javascript object containing an attribute reservations. The attribute is an array of reservations.
object status ( object  request)

Get the status of a subset of the EC2 instances associated with your credentials

Parameters:
request
Returns:
a javascript object containing an attribute reservations. The attribute is an array of reservations.
object stop ( object  request)

Stop running EC2 instances.

Parameters:
requestis a javascript object which must contains instanceIds which is an array of strings, where each string is an id of a running instance.
Returns:
a javascript object which returns the instances that will be stopped
 All Classes Functions