This section goes over how to get up and running quickly. We’ll assume that you have already followed the Installation instructions, and are ready to go.
It’s best to combine our documentation with the Route 53 Documentation. While we’ll do our best to make this as simple as possible, it may be necessary to look at what they’ve got for more details on behavior and how things work.
Instantiate the API client¶
Next, you’ll want to import the module:
You can then instantiate a connection to Route53 via
conn = route53.connect( aws_access_key_id='YOURACCESSKEYHERE', aws_secret_access_key='YOURSECRETACCESSKEYHERE', )
You are now ready to roll. Continue reading to see how much fun there is to be had (hooray!).
Listing Hosted Zones¶
Let’s say you want to retrieve a representation of all of your currently existing hosted zones. These roughly correspond to domains, ala angry-squirrel.com, or python.org.
# This is a generator. for zone in conn.list_hosted_zones(): # You can then do various things to the zone. print(zone.name) # Perhaps you want to see the record sets under this zone for record_set in zone.record_sets: print(record_set) # Or maybe you don't like this zone, and want to blow it away. zone.delete()
Creating a Hosted Zone¶
new_zone, change_info = conn.create_hosted_zone( 'some-domain.com.', comment='An optional comment.' ) # You can then manipulate the HostedZone. print("Zone ID", new_zone.id) # This has some details about the change from the API. print(change_info)
Notice that we passed in a fully-qualified domain name,
some-domain.com., ending in a period.
In this case,
new_zone is a new
change_info is a dict with some details about the changes
pending (from the Route 53 API).
Retrieving a Hosted Zone¶
method retrieves a specific hosted zone, by Zone ID:
zone = conn.get_hosted_zone_by_id('ZONE-ID-HERE')
A Zone ID is not the same thing as the domain name. The Zone ID is a unique string identifier for the hosted zone, as per Route 53’s records.
Deleting a Hosted Zone¶
zone = conn.get_hosted_zone_by_id('ZONE-ID-HERE') zone.delete()
If you have record sets under the hosted zone, you’ll need to delete those
first, or an exception will be raised. Alternatively, you can
force=True to delete the record sets and the
Creating a record set¶
Depending on which kind of record set you’d like to create, choose the
create_*_record method on
HostedZone. The methods
return one of the
new_record, change_info = zone.create_a_record( # Notice that this is a full-qualified name. name='test.some-domain.com.', # A list of IP address entries, in the case fo an A record. values=['22.214.171.124'], ) # Or maybe we want a weighted round-robin set. wrr_record1, change_info = zone.create_a_record( name='wrrtest.some-domain.com.', values=['126.96.36.199'], weight=1 set_identifier='set123, ) wrr_record2, change_info = zone.create_a_record( name='wrrtest.some-domain.com.', values=['188.8.131.52'], weight=2 set_identifier='set123, )
Listing record sets¶
# Note that this is a fully-qualified domain name. name_to_match = 'fuzzy.bunny.com.' for record_set in zone.record_sets: if record_set.name == name_to_match: print(record_set) # Stopping early may save some additional HTTP requests, # since zone.record_sets is a generator. break
While it may seem like extra work to craft these filters yourself, it does prevent needless additional iteration, and keeps the API more concise.
Changing a record set¶
Simply change one of the attributes on the various
sub-classed instances and call its
record_set.values = ['184.108.40.206'] record_set.save()
Deleting a record set¶
Similarly, delete a record set via its