route53

README

route53

Name

route53 - enables serving zone data from AWS route53.

Description

The route53 plugin is useful for serving zones from resource record sets in AWS route53. This plugin supports all Amazon Route 53 records (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html). The route53 plugin can be used when coredns is deployed on AWS or elsewhere.

Syntax

route53 [ZONE:HOSTED_ZONE_ID...] {
    [aws_access_key AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY]
    upstream
    credentials PROFILE [FILENAME]
    fallthrough [ZONES...]
}

• ZONE the name of the domain to be accessed. When there are multiple zones with overlapping domains (private vs. public hosted zone), CoreDNS does the lookup in the given order here. Therefore, for a non-existing resource record, SOA response will be from the rightmost zone.

• HOSTEDZONEID the ID of the hosted zone that contains the resource record sets to be accessed.

• AWSACCESSKEY_ID and AWSSECRETACCESS_KEY the AWS access key ID and secret access key to be used when query AWS (optional). If they are not provided, then coredns tries to access AWS credentials the same way as AWS CLI, e.g., environmental variables, AWS credentials file, instance profile credentials, etc.

• upstreamis used for resolving services that point to external hosts (eg. used to resolve CNAMEs). CoreDNS will resolve against itself.

• credentials is used for reading the credential file and setting the profile name for a given zone.

• PROFILE AWS account profile name. Defaults to default.

• FILENAME AWS credentials filename. Defaults to ~/.aws/credentials are used.

• fallthrough If zone matches and no record can be generated, pass request to the next plugin. If [ZONES...] is omitted, then fallthrough happens for all zones for which the plugin is authoritative. If specific zones are listed (for example in-addr.arpa and ip6.arpa), then only queries for those zones will be subject to fallthrough.

• ZONES zones it should be authoritative for. If empty, the zones from the configuration block

Examples

Enable route53 with implicit AWS credentials and an upstream:

. {
	route53 example.org.:Z1Z2Z3Z4DZ5Z6Z7 {
	  upstream 10.0.0.1
	}
}

Enable route53 with explicit AWS credentials:

. {
    route53 example.org.:Z1Z2Z3Z4DZ5Z6Z7 {
      aws_access_key AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY
    }
}

Enable route53 with fallthrough:

. {
    route53 example.org.:Z1Z2Z3Z4DZ5Z6Z7 example.gov.:Z654321543245 {
      fallthrough example.gov.
    }
}

Enable route53 with multiple hosted zones with the same domain:

. {
    route53 example.org.:Z1Z2Z3Z4DZ5Z6Z7 example.org.:Z93A52145678156
}

Documentation

Overview

Package route53 implements a plugin that returns resource records from AWS route53.

Index

• type Route53
  • func New(ctx context.Context, c route53iface.Route53API, keys map[string][]string, ...) (*Route53, error)
  • func (h *Route53) Name() string
  • func (h *Route53) Run(ctx context.Context) error
  • func (h *Route53) ServeDNS(ctx context.Context, w dns.ResponseWriter, r *dns.Msg) (int, error)

Types

type Route53

type Route53 struct {
	Next plugin.Handler
	Fall fall.F
	// contains filtered or unexported fields
}

Route53 is a plugin that returns RR from AWS route53.

func New

func New(ctx context.Context, c route53iface.Route53API, keys map[string][]string, up *upstream.Upstream) (*Route53, error)

New reads from the keys map which uses domain names as its key and hosted zone id lists as its values, validates that each domain name/zone id pair does exist, and returns a new *Route53. In addition to this, upstream is passed for doing recursive queries against CNAMEs. Returns error if it cannot verify any given domain name/zone id pair.

func (*Route53) Name

func (h *Route53) Name() string

Name implements plugin.Handler.Name.

func (*Route53) Run

func (h *Route53) Run(ctx context.Context) error

Run executes first update, spins up an update forever-loop. Returns error if first update fails.

func (*Route53) ServeDNS

func (h *Route53) ServeDNS(ctx context.Context, w dns.ResponseWriter, r *dns.Msg) (int, error)

ServeDNS implements the plugin.Handler.ServeDNS.