aboutsummaryrefslogtreecommitdiff
path: root/plugin/route53/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugin/route53/README.md')
-rw-r--r--plugin/route53/README.md56
1 files changed, 32 insertions, 24 deletions
diff --git a/plugin/route53/README.md b/plugin/route53/README.md
index 94fe45c81..5373e61e8 100644
--- a/plugin/route53/README.md
+++ b/plugin/route53/README.md
@@ -6,8 +6,9 @@
## 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 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](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
@@ -15,33 +16,40 @@ The route53 plugin can be used when coredns is deployed on AWS or elsewhere.
~~~ txt
route53 [ZONE:HOSTED_ZONE_ID...] {
[aws_access_key AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY]
- upstream [ADDRESS...]
+ 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.
-* **HOSTED_ZONE_ID** the ID of the hosted zone that contains the resource record sets to be accessed.
-* **AWS_ACCESS_KEY_ID** and **AWS_SECRET_ACCESS_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.
-* `upstream` [**ADDRESS**...] specifies upstream resolver(s) used for resolving services that point
- to external hosts (eg. used to resolve CNAMEs). If no **ADDRESS** is given, CoreDNS will resolve
- against itself. **ADDRESS** can be an IP, an IP:port or a path to a file structured like
- resolv.conf.
-* `credentials` 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
+* **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.
+
+* **HOSTED*ZONE*ID** the ID of the hosted zone that contains the resource record sets to be
+ accessed.
+
+* **AWS*ACCESS*KEY_ID** and **AWS*SECRET*ACCESS_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.
+
+* `upstream`is used for resolving services that point to external hosts (eg. used to resolve
+ CNAMEs). CoreDNS will resolve against itself.
+
+* `credentials` 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