dnscontrol/docs/_providers/route53.md
Patrick G fad98f73f4 Improve Route53 documentation (#221) (#234)
* Improve Route53 documentation

- Grammar fixes
- Formatting improvements
- Don't encourage using environment vars instead of the credentials file

* Add back sdk config link
2017-10-24 09:44:23 -04:00

2.1 KiB

name layout jsId
Route 53 default ROUTE53

Amazon Route 53 Provider

Configuration

You can specify the API credentials in the credentials json file:

{% highlight json %} { "r53":{ "KeyId": "your-aws-key", "SecretKey": "your-aws-secret-key" } } {% endhighlight %}

You can also use environment variables, but this is discouraged, unless your environment provides them already.

$ export AWS_ACCESS_KEY_ID=XXXXXXXXX
$ export AWS_SECRET_ACCESS_KEY=YYYYYYYYY

You can find some other ways to authenticate to Route53 in the go sdk configuration.

Metadata

This provider does not recognize any special metadata fields unique to route 53.

Usage

Example Javascript:

{% highlight js %} var REG_NONE = NewRegistrar("none","NONE"); var R53 = NewDnsProvider("r53", "ROUTE53");

D("example.tld", REG_NONE, DnsProvider(R53), A("test","1.2.3.4") ); {%endhighlight%}

Activation

DNSControl depends on a standard AWS access key with permission to list, create and update hosted zones.

New domains

If a domain does not exist in your Route53 account, DNSControl will not automatically add it with the create-domains command. You can do that either manually via the control panel, or via the command dnscontrol create-domains command.

Caveats

This code may not function properly if a domain has R53 as a Registrar but not as a DnsProvider. The situation is described in PR#155.

In this situation you will see a message like:

----- Registrar: r53
Error getting corrections: AccessDeniedException: User: arn:aws:iam::868399730840:user/dnscontrol is not authorized to perform: route53domains:GetDomainDetail
  status code: 400, request id: 48b534a1-7902-11e7-afa6-a3fffd2ce139
Done. 1 corrections.

If this happens to you, we'd appreciate it if you could help us fix the code. In the meanwhile, you can give the account additional IAM permissions so that it can do DNS-related actions, or simply use NewRegistrar(..., 'NONE') for now.