This PHP class is extremely easy to use. A few examples are sufficient explanation.
First, you'll need to create a Route53 class object:
<?php
require_once('r53.php');
$r53 = new Route53('Access Key Here', 'Secret Key Here');
?>
Next, create the DNS zone you want hosted:
<?php
$result = $r53->createHostedZone('example.com', 'unique identifier', 'An optional comment');
?>
There are three parameters to createHostedZone:
1 - The hosted zone to create. This cannot be a top-level domain name (e.g. "com.").
Amazon Route53 requires that the zone name end with a period, but this class will
add it for you if you forget.
2 - A unique identifier that you choose to identify this request. This will prevent
accidentally creating two hosted zones for the same domain. (It is both possible
and valid to do so, but if you do that you'll need to provide different unique
identifiers for each createHostedZone request.)
3 - An optional comment that you want attached to the hosted zone. This can be any
text you choose, and is included with the zone information if you query for it later.
You may omit this third parameter if you do not want to add a comment.
After this call, $result will contain a bunch of information about the new zone.
Let's examine the result:
<?php
print_r($result);
?>
-------
Array
(
[HostedZone] => Array
(
[Id] => /hostedzone/Z1PA6795UKMFR9
[Name] => example.com.
[CallerReference] => unique identifier
[Config] => Array
(
[Comment] => An optional comment
)
)
[ChangeInfo] => Array
(
[Id] => /change/C1PA6795UKMFR9
[Status] => PENDING
[SubmittedAt] => 2011-01-20T23:45:25.320Z
)
[NameServers] => Array
(
[0] => ns-415.awsdns-51.com
[1] => ns-726.awsdns-26.net
[2] => ns-1358.awsdns-41.org
[3] => ns-1555.awsdns-02.co.uk
)
)
-------
If you did not provide a comment, you would not see the Config array under HostedZone.
When you create a zone, it is prepopulated with an SOA record and four NS records.
More on that later.
Under ChangeInfo, you can see that the status is 'PENDING'. Let's wait a few seconds,
then check if it's done yet:
<?php
print_r($r53->getChange('/change/C1PA6795UKMFR9'));
?>
-------
Array
(
[Id] => /change/C1PA6795UKMFR9
[Status] => INSYNC
[SubmittedAt] => 2011-01-20T23:45:25.320Z
)
-------
When the change has been propogated to the servers hosting your zone, the status will
change to 'INSYNC'.
Now let's add an A record:
<?php
$change = $r53->prepareChange('CREATE', 'example.com.', 'A', 86400, '192.0.2.1');
print_r($r53->changeResourceRecordSets('/hostedzone/Z1PA6795UKMFR9', $change);
?>
-------
Array
(
[Id] => /change/C1PA6795UKMXZ9
[Status] => PENDING
[SubmittedAt] => 2011-01-20T23:59:59.572Z
)
-------
Note the period following the domain name -- it is not optional! If you leave it off,
then AWS will treat the value as relative to the zone root -- that means you would be setting
an A record for example.com.example.com instead of just for example.com, so be specific!
The object returned by Route53::prepareChange() is not meant to be user-visible. Its contents
may change at any time in future versions, so if you poke around in it, your code may not work
when you upgrade to a newer version of this library!
If you have more than one change to make, you should do them together in one call:
<?php
$changes = array();
$changes[] = $r53->prepareChange('CREATE', 'www.example.com.', 'A', 86400, '192.0.2.1');
$changes[] = $r53->prepareChange('CREATE', 'fake.example.com.', 'A', 86400, '192.0.2.1');
$result = $r53->changeResourceRecordSets('/hostedzone/Z1PA6795UKMFR9', $changes);
?>
All of these changes are done in a single transaction -- either all of them will fail, or
all of them will succeed.
You can also delete records with this call. Suppose you didn't mean to create fake.example.com:
<?php
$change = $r53->prepareChange('DELETE', 'fake.example.com.', 'A', 86400, '192.0.2.1');
$result = $r53->changeResourceRecordSets('/hostedzone/Z1PA6795UKMFR9', $change);
?>
Note that if you're going to delete a record, all of the parameters to the delete change request
must be identical to the record's current values. The call will fail if any of them are wrong.
You can, of course, create other types of records. The trickiest one is MX records.
For MX records, you need to set all of the MX records and their priorities in a single call, like this:
<?php
$mailservers = array('10 mx.example.com.', '20 mx2.example.com.', '30 mx3.example.com.');
$change = $r53->prepareChange('CREATE', 'example.com.', 'MX', 86400, $mailservers);
$result = $r53->changeResourceRecordSets('/hostedzone/Z1PA6795UKMFR9', $change);
?>
You can find more information on creating records in the Amazon Route 53 API reference:
http://docs.amazonwebservices.com/Route53/latest/APIReference/
You can also list all the hosted zones on your account:
<?php
print_r($r53->listHostedZones());
?>
-------
Array
(
[HostedZone] => Array
(
[0] => Array
(
[Id] => /hostedzone/Z1PA6795UKMFR9
[Name] => example.com.
[CallerReference] => unique identifier
[Config] => Array
(
[Comment] => An optional comment
)
)
[1] => Array
(
[Id] => /hostedzone/Y1PA6795UKMFR1
[Name] => example.net.
[CallerReference] => some unique id
)
)
[MaxItems] => 100
[IsTruncated] => false
)
-------
You can delete hosted zones:
<?php
print_r($r53->deleteHostedZone('/hostedzone/Y1PA6795UKMFR1'));
?>
-------
Array
(
[Id] => /change/C1PA6795UKMXY9
[Status] => PENDING
[SubmittedAt] => 2011-01-21T02:17:22.640Z
)
-------
You can call getHostedZone to get more information on the zone, including its nameservers:
<?php
print_r($r53->getHostedZone('/hostedzone/Z1PA6795UKMFR9'));
?>
-------
Array
(
[HostedZone] => Array
(
[Id] => /hostedzone/Z1PA6795UKMFR9
[Name] => example.com.
[CallerReference] => unique identifier
[Config] => Array
(
[Comment] => An optional comment
)
)
[NameServers] => Array
(
[0] => ns-415.awsdns-51.com
[1] => ns-726.awsdns-26.net
[2] => ns-1358.awsdns-41.org
[3] => ns-1555.awsdns-02.co.uk
)
)
-------
If that looks familiar, it should: createHostedZone returned the information as well.
Finally, you can list all the records in a zone:
<?php
print_r($r53->listResourceRecordSets('/hostedzone/Z1PA6795UKMFR9'));
?>
-------
Array
(
[ResourceRecordSets] => Array
(
[0] => Array
(
[Name] => example.com.
[Type] => A
[TTL] => 86400
[ResourceRecords] => Array
(
[0] => 192.168.0.2
)
)
[1] => Array
(
[Name] => example.com.
[Type] => MX
[TTL] => 86400
[ResourceRecords] => Array
(
[0] => 10 mx1.example.com.
[1] => 20 mx2.example.com.
[2] => 30 mx3.example.com.
)
)
[2] => Array
(
[Name] => example.com.
[Type] => NS
[TTL] => 172800
[ResourceRecords] => Array
(
[0] => ns-1358.awsdns-41.org.
[1] => ns-1555.awsdns-02.co.uk.
[2] => ns-726.awsdns-26.net.
[3] => ns-415.awsdns-51.com.
)
)
[3] => Array
(
[Name] => example.com.
[Type] => SOA
[TTL] => 900
[ResourceRecords] => Array
(
[0] => ns-1358.awsdns-41.org. awsdns-hostmaster.amazon.com. 1 7200 900 1209600 86400
)
)
[4] => Array
(
[Name] => www.example.com.
[Type] => A
[TTL] => 86400
[ResourceRecords] => Array
(
[0] => 192.168.0.2
)
)
)
[MaxItems] => 100
[IsTruncated] => false
)
-------
And that's all there is to it!
Download Latest Version
php-r53-0.9.0 (24.5 kB)
