documentation/manual/en/module_specs/Zend_Service_Amazon_Ec2-Elasticip.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!-- Reviewed: no -->
   3 <sect1 id="zend.service.amazon.ec2.elasticip">
   4     <title>Zend_Service_Amazon_Ec2: Elastic IP Addresses</title>
   5
   6     <para>
   7         By default, all Amazon EC2 instances are assigned two IP addresses at
   8         launch: a private (RFC 1918) address and a public address that is mapped
   9         to the private IP address through Network Address Translation (NAT).
  10     </para>
  11
  12     <para>
  13         If you use dynamic DNS to map an existing DNS name to a new instance's
  14         public IP address, it might take up to 24 hours for the IP address to propagate
  15         through the Internet. As a result, new instances might not receive traffic while
  16         terminated instances continue to receive requests.
  17     </para>
  18
  19     <para>
  20         To solve this problem, Amazon EC2 provides elastic IP addresses. Elastic IP addresses
  21         are static IP addresses designed for dynamic cloud computing. Elastic IP addresses
  22         are associated with your account, not specific instances. Any elastic IP addresses
  23         that you associate with your account remain associated with your account until you
  24         explicitly release them. Unlike traditional static IP addresses, however, elastic IP
  25         addresses allow you to mask instance or Availability Zone failures by rapidly remapping
  26         your public IP addresses to any instance in your account.
  27     </para>
  28
  29     <example id="zend.service.amazon.ec2.elasticip.allocate">
  30         <title>Allocating a new Elastic IP</title>
  31
  32         <para>
  33             <code>allocate</code> will assign your account a new Elastic IP Address.
  34         </para>
  35
  36         <para>
  37             <code>allocate</code> returns the newly allocated ip.
  38         </para>
  39
  40         <programlisting language="php"><![CDATA[
  41 $ec2_eip = new Zend_Service_Amazon_Ec2_Elasticip('aws_key','aws_secret_key');
  42 $ip = $ec2_eip->allocate();
  43
  44 // print out your newly allocated elastic ip address;
  45 print $ip;
  46 ]]></programlisting>
  47     </example>
  48
  49     <example id="zend.service.amazon.ec2.elasticip.describe">
  50         <title>Describing Allocated Elastic IP Addresses</title>
  51
  52         <para>
  53             <code>describe</code> has an optional paramater to describe all
  54             of your allocated Elastic IP addresses or just some of your
  55             allocated addresses.
  56         </para>
  57
  58         <para>
  59             <code>describe</code> returns an array that contains information on each Elastic IP
  60             Address which contains the publicIp and the instanceId if it is assocated.
  61         </para>
  62
  63         <programlisting language="php"><![CDATA[
  64 $ec2_eip = new Zend_Service_Amazon_Ec2_Elasticip('aws_key','aws_secret_key');
  65 // describe all
  66 $ips = $ec2_eip->describe();
  67
  68 // describe a subset
  69 $ips = $ec2_eip->describe(array('ip1', 'ip2', 'ip3'));
  70
  71 // describe a single ip address
  72 $ip = $ec2_eip->describe('ip1');
  73 ]]></programlisting>
  74     </example>
  75
  76     <example id="zend.service.amazon.ec2.elasticip.release">
  77         <title>Releasing Elastic IP</title>
  78
  79         <para>
  80             <code>release</code> will release an Elastic IP to Amazon.
  81         </para>
  82
  83         <para>
  84             Returns a boolean <constant>TRUE</constant> or <constant>FALSE</constant>.
  85         </para>
  86
  87         <programlisting language="php"><![CDATA[
  88 $ec2_eip = new Zend_Service_Amazon_Ec2_Elasticip('aws_key','aws_secret_key');
  89 $ec2_eip->release('ipaddress');
  90 ]]></programlisting>
  91     </example>
  92
  93     <example id="zend.service.amazon.ec2.elasticip.associate">
  94         <title>Associates an Elastic IP to an Instance</title>
  95
  96         <para>
  97             <code>associate</code> will assign an Elastic IP to an
  98             already running instance.
  99         </para>
 100
 101         <para>
 102             Returns a boolean <constant>TRUE</constant> or <constant>FALSE</constant>.
 103         </para>
 104
 105         <programlisting language="php"><![CDATA[
 106 $ec2_eip = new Zend_Service_Amazon_Ec2_Elasticip('aws_key','aws_secret_key');
 107 $ec2_eip->associate('instance_id', 'ipaddress');
 108 ]]></programlisting>
 109     </example>
 110
 111     <example id="zend.service.amazon.ec2.elasticip.disassociate">
 112         <title>Disassociate an Elastic IP from an instance</title>
 113
 114         <para>
 115             <code>disassociate</code> will disassociate an Elastic IP from an instance.
 116             If you terminate an Instance it will automaticly disassociate the Elastic
 117             IP address for you.
 118         </para>
 119
 120         <para>
 121             Returns a boolean <constant>TRUE</constant> or <constant>FALSE</constant>.
 122         </para>
 123
 124         <programlisting language="php"><![CDATA[
 125 $ec2_eip = new Zend_Service_Amazon_Ec2_Elasticip('aws_key','aws_secret_key');
 126 $ec2_eip->disassociate('ipaddress');
 127 ]]></programlisting>
 128     </example>
 129 </sect1>