l.c.d.e.EC2NodeDriver(NodeDriver) : class documentation

Converts a key and an array of values into AWS query param format.

Checks for the instances's state

List all nodes

Ex_node_ids parameter is used to filter the list of
nodes that should be returned. Only the nodes
with the corresponding node ids will be returned.

@param      ex_node_ids: List of C{node.id}
@type       ex_node_ids: C{list} of C{str}

@rtype: C{list} of L{Node}

List sizes on a provider

@keyword location: The location at which to list sizes
@type location: L{NodeLocation}

@return: list of node size objects
@rtype: C{list} of L{NodeSize}

List images on a provider

@keyword location: The location at which to list images
@type location: L{NodeLocation}

@return: list of node image objects
@rtype: C{list} of L{NodeImage}

List data centers for a provider

@return: list of node location objects
@rtype: C{list} of L{NodeLocation}

Create a new volume.

@param      size: Size of volume in gigabytes (required)
@type       size: C{int}

@keyword    name: Name of the volume to be created
@type       name: C{str}

@keyword    location: Which data center to create a volume in. If
                       empty, undefined behavoir will be selected.
                       (optional)
@type       location: L{NodeLocation}

@keyword    snapshot:  Name of snapshot from which to create the new
                       volume.  (optional)
@type       snapshot:  C{str}

@return: The newly created volume.
@rtype: L{StorageVolume}

Destroys a storage volume.

@param      volume: Volume to be destroyed
@type       volume: L{StorageVolume}

@rtype: C{bool}

Attaches volume to node.

@param      node: Node to attach volume to
@type       node: L{Node}

@param      volume: Volume to attach
@type       volume: L{StorageVolume}

@param      device: Where the device is exposed,
                    e.g. '/dev/sdb (optional)
@type       device: C{str}

@rtype: C{bool}

Detaches a volume from a node.

@param      volume: Volume to be detached
@type       volume: L{StorageVolume}

@rtype: C{bool}

Creates a new keypair

@note: This is a non-standard extension API, and only works for EC2.

@param      name: The name of the keypair to Create. This must be
    unique, otherwise an InvalidKeyPair.Duplicate exception is raised.
@type       name: C{str}

@rtype: C{dict}

imports a new public key

@note: This is a non-standard extension API, and only works for EC2.

@param      name: The name of the public key to import. This must be
 unique, otherwise an InvalidKeyPair.Duplicate exception is raised.
@type       name: C{str}

@param     keyfile: The filename with path of the public key to import.
@type      keyfile: C{str}

@rtype: C{dict}

Describes all keypairs.

@note: This is a non-standard extension API, and only works for EC2.

@rtype: C{list}

Describes a keypair by name

@note: This is a non-standard extension API, and only works for EC2.

@param      name: The name of the keypair to describe.
@type       name: C{str}

@rtype: C{dict}

List existing Security Groups.

@note: This is a non-standard extension API, and only works for EC2.

@rtype: C{list} of C{str}

Creates a new Security Group

@note: This is a non-standard extension API, and only works for EC2.

@param      name: The name of the security group to Create.
                  This must be unique.
@type       name: C{str}

@param      description: Human readable description of a Security
Group.
@type       description: C{str}

@rtype: C{str}

Edit a Security Group to allow specific traffic.

@note: This is a non-standard extension API, and only works for EC2.

@param      name: The name of the security group to edit
@type       name: C{str}

@param      from_port: The beginning of the port range to open
@type       from_port: C{str}

@param      end_port: The end of the port range to open
@type       end_port: C{str}

@param      cidr_ip: The ip to allow traffic for.
@type       cidr_ip: C{str}

@param      protocol: tcp/udp/icmp
@type       protocol: C{str}

@rtype: C{boolean}

Edit a Security Group to allow all traffic.

@note: This is a non-standard extension API, and only works for EC2.

@param      name: The name of the security group to edit
@type       name: C{str}

@rtype: C{list} of C{str}

Return a list of L{ExEC2AvailabilityZone} objects for the
current region.

Note: This is an extension method and is only available for EC2
driver.

@keyword  only_available: If true, return only availability zones
                          with state 'available'
@type     only_available: C{str}

@rtype: C{list} of L{ExEC2AvailabilityZone}

Return a dictionary of tags for a resource (Node or StorageVolume).

@param  resource: resource which should be used
@type   resource: L{Node} or L{StorageVolume}

@return: dict Node tags
@rtype: C{dict}

Create tags for a resource (Node or StorageVolume).

@param resource: Resource to be tagged
@type resource: L{Node} or L{StorageVolume}

@param tags: A dictionary or other mapping of strings to strings,
             associating tag names with tag values.
@type tags: C{dict}

@rtype: C{bool}

Delete tags from a resource.

@param resource: Resource to be tagged
@type resource: L{Node} or L{StorageVolume}

@param tags: A dictionary or other mapping of strings to strings,
             specifying the tag names and tag values to be deleted.
@type tags: C{dict}

@rtype: C{bool}

Add instance filter to the provided params dictionary.

Return all the Elastic IP addresses for this account
optionally, return only the allocated addresses

@param    only_allocated: If true, return only those addresses
                          that are associated with an instance
@type     only_allocated: C{str}

@return:   list list of elastic ips for this particular account.
@rtype: C{list} of C{str}

Associate an IP address with a particular node.

@param      node: Node instance
@type       node: L{Node}

@param      elastic_ip_address: IP address which should be used
@type       elastic_ip_address: C{str}

@rtype: C{bool}

Return Elastic IP addresses for all the nodes in the provided list.

@param      nodes: List of C{Node} instances
@type       nodes: C{list} of L{Node}

@return: Dictionary where a key is a node ID and the value is a
    list with the Elastic IP addresses associated with this node.
@rtype: C{dict}

Return a list of Elastic IP addresses associated with this node.

@param      node: Node instance
@type       node: L{Node}

@return: list Elastic IP addresses attached to this node.
@rtype: C{list} of C{str}

Modify node attributes.
A list of valid attributes can be found at http://goo.gl/gxcj8

@param      node: Node instance
@type       node: L{Node}

@param      attributes: Dictionary with node attributes
@type       attributes: C{dict}

@return: True on success, False otherwise.
@rtype: C{bool}

Change the node size.
Note: Node must be turned of before changing the size.

@param      node: Node instance
@type       node: L{Node}

@param      new_size: NodeSize intance
@type       new_size: L{NodeSize}

@return: True on success, False otherwise.
@rtype: C{bool}

Create a new EC2 node

Reference: http://bit.ly/8ZyPSy [docs.amazonwebservices.com]

@inherits: L{NodeDriver.create_node}

@keyword    ex_mincount: Minimum number of instances to launch
@type       ex_mincount: C{int}

@keyword    ex_maxcount: Maximum number of instances to launch
@type       ex_maxcount: C{int}

@keyword    ex_securitygroup: Name of security group
@type       ex_securitygroup: C{str}

@keyword    ex_keyname: The name of the key pair
@type       ex_keyname: C{str}

@keyword    ex_userdata: User data
@type       ex_userdata: C{str}

@keyword    ex_clienttoken: Unique identifier to ensure idempotency
@type       ex_clienttoken: C{str}

Reboot a node.

@param node: The node to be rebooted
@type node: L{Node}

@return: True if the reboot was successful, otherwise False
@rtype: C{bool}

Start the node by passing in the node object, does not work with
instance store backed instances

@param      node: Node which should be used
@type       node: L{Node}

@rtype: C{bool}

Stop the node by passing in the node object, does not work with
instance store backed instances

@param      node: Node which should be used
@type       node: L{Node}

@rtype: C{bool}

Destroy a node.

Depending upon the provider, this may destroy all data associated with
the node, including backups.

@param node: The node to be destroyed
@type node: L{Node}

@return: True if the destroy was successful, otherwise False
@rtype: C{bool}