baiji v0.6.5 Baiji.Route53
Link to this section Summary
Functions
Returns a map containing the input/output shapes for this endpoint
Outputs values common to all actions
Associates an Amazon VPC with a private hosted zone
Creates, changes, or deletes a resource record set, which contains
authoritative DNS information for a specified domain name or subdomain
name. For example, you can use ChangeResourceRecordSets
to create a
resource record set that routes traffic for test.example.com to a web
server that has an IP address of 192.0.2.44
Adds, edits, or deletes tags for a health check or a hosted zone
Creates a new health check
Creates a new public hosted zone, which you use to specify how the Domain Name System (DNS) routes traffic on the Internet for a domain, such as example.com, and its subdomains
Creates a configuration for DNS query logging. After you create a query logging configuration, Amazon Route 53 begins to publish log data to an Amazon CloudWatch Logs log group
Creates a delegation set (a group of four name servers) that can be reused
by multiple hosted zones. If a hosted zoned ID is specified,
CreateReusableDelegationSet
marks the delegation set associated with that
zone as reusable
Creates a traffic policy, which you use to create multiple DNS resource record sets for one domain name (such as example.com) or one subdomain name (such as www.example.com)
Creates resource record sets in a specified hosted zone based on the
settings in a specified traffic policy version. In addition,
CreateTrafficPolicyInstance
associates the resource record sets with a
specified domain name (such as example.com) or subdomain name (such as
www.example.com). Amazon Route 53 responds to DNS queries for the domain or
subdomain name by using the resource record sets that
CreateTrafficPolicyInstance
created
Creates a new version of an existing traffic policy. When you create a new version of a traffic policy, you specify the ID of the traffic policy that you want to update and a JSON-formatted document that describes the new version. You use traffic policies to create multiple DNS resource record sets for one domain name (such as example.com) or one subdomain name (such as www.example.com). You can create a maximum of 1000 versions of a traffic policy. If you reach the limit and need to create another version, you’ll need to start a new traffic policy
Authorizes the AWS account that created a specified VPC to submit an
AssociateVPCWithHostedZone
request to associate the VPC with a specified
hosted zone that was created by a different account. To submit a
CreateVPCAssociationAuthorization
request, you must use the account that
created the hosted zone. After you authorize the association, use the
account that created the VPC to submit an AssociateVPCWithHostedZone
request
Deletes a health check
Deletes a hosted zone
Deletes a configuration for DNS query logging. If you delete a configuration, Amazon Route 53 stops sending query logs to CloudWatch Logs. Amazon Route 53 doesn’t delete any logs that are already in CloudWatch Logs
Deletes a reusable delegation set
Deletes a traffic policy
Deletes a traffic policy instance and all of the resource record sets that Amazon Route 53 created when you created the instance
Removes authorization to submit an AssociateVPCWithHostedZone
request to
associate a specified VPC with a hosted zone that was created by a
different account. You must use the account that created the hosted zone to
submit a DeleteVPCAssociationAuthorization
request
Disassociates a VPC from a Amazon Route 53 private hosted zone
Returns the current status of a change batch request. The status is one of the following values
GetCheckerIpRanges
still works, but we recommend that you download
ip-ranges.json, which includes IP address ranges for all AWS services. For
more information, see IP Address Ranges of Amazon Route 53
Servers
in the Amazon Route 53 Developer Guide
Gets information about whether a specified geographic location is supported for Amazon Route 53 geolocation resource record sets
Gets information about a specified health check
Retrieves the number of health checks that are associated with the current AWS account
Gets the reason that a specified health check failed most recently
Gets status of a specified health check
Gets information about a specified hosted zone including the four name servers assigned to the hosted zone
Retrieves the number of hosted zones that are associated with the current AWS account
Gets information about a specified configuration for DNS query logging
Retrieves information about a specified reusable delegation set, including the four name servers that are assigned to the delegation set
Gets information about a specific traffic policy version
Gets information about a specified traffic policy instance
Gets the number of traffic policy instances that are associated with the current AWS account
Retrieves a list of supported geo locations
Retrieve a list of the health checks that are associated with the current AWS account
Retrieves a list of the public and private hosted zones that are associated
with the current AWS account. The response includes a HostedZones
child
element for each hosted zone
Retrieves a list of your hosted zones in lexicographic order. The response
includes a HostedZones
child element for each hosted zone created by the
current AWS account
Lists the configurations for DNS query logging that are associated with the current AWS account or the configuration that is associated with a specified hosted zone
Lists the resource record sets in a specified hosted zone
Retrieves a list of the reusable delegation sets that are associated with the current AWS account
Lists tags for one health check or hosted zone
Lists tags for up to 10 health checks or hosted zones
Gets information about the latest version for every traffic policy that is associated with the current AWS account. Policies are listed in the order in which they were created
Gets information about the traffic policy instances that you created by using the current AWS account
Gets information about the traffic policy instances that you created in a specified hosted zone
Gets information about the traffic policy instances that you created by using a specify traffic policy version
Gets information about all of the versions for a specified traffic policy
Gets a list of the VPCs that were created by other accounts and that can be
associated with a specified hosted zone because you’ve submitted one or
more CreateVPCAssociationAuthorization
requests
Gets the value that Amazon Route 53 returns in response to a DNS request for a specified record name and type. You can optionally specify the IP address of a DNS resolver, an EDNS0 client subnet IP address, and a subnet mask
Updates an existing health check. Note that some values can’t be updated
Updates the comment for a specified hosted zone
Updates the comment for a specified traffic policy version
Updates the resource record sets in a specified hosted zone that were created based on the settings in a specified traffic policy version
Link to this section Functions
Returns a map containing the input/output shapes for this endpoint
Outputs values common to all actions
Associates an Amazon VPC with a private hosted zone.
using one AWS account with a private hosted zone that was created by using
a different account, the AWS account that created the private hosted zone
must first submit a CreateVPCAssociationAuthorization
request. Then the
account that created the VPC must submit an AssociateVPCWithHostedZone
request.
Creates, changes, or deletes a resource record set, which contains
authoritative DNS information for a specified domain name or subdomain
name. For example, you can use ChangeResourceRecordSets
to create a
resource record set that routes traffic for test.example.com to a web
server that has an IP address of 192.0.2.44.
Change Batches and Transactional Changes
The request body must include a document with a
ChangeResourceRecordSetsRequest
element. The request body contains a list
of change items, known as a change batch. Change batches are considered
transactional changes. When using the Amazon Route 53 API to change
resource record sets, Amazon Route 53 either makes all or none of the
changes in a change batch request. This ensures that Amazon Route 53 never
partially implements the intended changes to the resource record sets in a
hosted zone.
For example, a change batch request that deletes the CNAME
record for
www.example.com and creates an alias resource record set for
www.example.com. Amazon Route 53 deletes the first resource record set and
creates the second resource record set in a single operation. If either the
DELETE
or the CREATE
action fails, then both changes (plus any other
changes in the batch) fail, and the original CNAME
record continues to
exist.
To create resource record sets for complex routing configurations, use either the traffic flow visual editor in the Amazon Route 53 console or the API actions for traffic policies and traffic policy instances. Save the configuration as a traffic policy, then associate the traffic policy with one or more domain names (such as example.com) or subdomain names (such as www.example.com), in the same hosted zone or in multiple hosted zones. You can roll back the updates if the new configuration isn’t performing as expected. For more information, see Using Traffic Flow to Route DNS Traffic in the Amazon Route 53 Developer Guide.
Create, Delete, and Upsert
Use ChangeResourceRecordsSetsRequest
to perform the following actions:
- `CREATE`: Creates a resource record set that has the specified values.
- `DELETE`: Deletes an existing resource record set that has the specified values.
- `UPSERT`: If a resource record set does not already exist, AWS creates it. If a resource set does exist, Amazon Route 53 updates it with the values in the request.
Adds, edits, or deletes tags for a health check or a hosted zone.
For information about using tags for cost allocation, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
Creates a new health check.
For information about adding health checks to resource record sets, see
ResourceRecordSet$HealthCheckId
in ChangeResourceRecordSets
.
ELB Load Balancers
If you’re registering EC2 instances with an Elastic Load Balancing (ELB) load balancer, do not create Amazon Route 53 health checks for the EC2 instances. When you register an EC2 instance with a load balancer, you configure settings for an ELB health check, which performs a similar function to an Amazon Route 53 health check.
Private Hosted Zones
You can associate health checks with failover resource record sets in a private hosted zone. Note the following:
- Amazon Route 53 health checkers are outside the VPC. To check the health of an endpoint within a VPC by IP address, you must assign a public IP address to the instance in the VPC.
- You can configure a health checker to check the health of an external resource that the instance relies on, such as a database server.
- You can create a CloudWatch metric, associate an alarm with the metric, and then create a health check that is based on the state of the alarm. For example, you might create a CloudWatch metric that checks the status of the Amazon EC2 `StatusCheckFailed` metric, add an alarm to the metric, and then create a health check that is based on the state of the alarm. For information about creating CloudWatch metrics and alarms by using the CloudWatch console, see the [Amazon CloudWatch User Guide](http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/WhatIsCloudWatch.html).
Creates a new public hosted zone, which you use to specify how the Domain Name System (DNS) routes traffic on the Internet for a domain, such as example.com, and its subdomains.
Note the following:
- You can't create a hosted zone for a top-level domain (TLD).
- Amazon Route 53 automatically creates a default SOA record and four NS records for the zone. For more information about SOA and NS records, see [NS and SOA Records that Amazon Route 53 Creates for a Hosted Zone](http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/SOA-NSrecords.html) in the *Amazon Route 53 Developer Guide*. If you want to use the same name servers for multiple hosted zones, you can optionally associate a reusable delegation set with the hosted zone. See the `DelegationSetId` element.
- If your domain is registered with a registrar other than Amazon Route 53, you must update the name servers with your registrar to make Amazon Route 53 your DNS service. For more information, see [Configuring Amazon Route 53 as your DNS Service](http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/creating-migrating.html) in the *Amazon Route 53 Developer Guide*.
Creates a configuration for DNS query logging. After you create a query logging configuration, Amazon Route 53 begins to publish log data to an Amazon CloudWatch Logs log group.
DNS query logs contain information about the queries that Amazon Route 53 receives for a specified public hosted zone, such as the following:
- Amazon Route 53 edge location that responded to the DNS query
- Domain or subdomain that was requested
- DNS record type, such as A or AAAA
- DNS response code, such as `NoError` or `ServFail`
- Log Group and Resource Policy
- Before you
create a query logging configuration, perform the following operations.
If you create a query logging configuration using the Amazon Route 53 console, Amazon Route 53 performs these operations automatically. - Create a CloudWatch Logs log group, and make note of the
ARN, which you specify when you create a query logging configuration. Note
the following:
- You must create the log group in the us-east-1 region.
- You must use the same AWS account to create the log group and the hosted zone that you want to configure query logging for.
- When you create log groups for query logging, we recommend that you use a consistent prefix, for example: `/aws/route53/*hosted zone name* ` In the next step, you'll create a resource policy, which controls access to one or more log groups and the associated AWS resources, such as Amazon Route 53 hosted zones. There's a limit on the number of resource policies that you can create, so we recommend that you use a consistent prefix so you can use the same resource policy for all the log groups that you create for query logging.
- Create a CloudWatch Logs resource policy, and give
it the permissions that Amazon Route 53 needs to create log streams and to
to send query logs to log streams. For the value of `Resource`, specify the
ARN for the log group that you created in the previous step. To use the
same resource policy for all the CloudWatch Logs log groups that you
created for query logging configurations, replace the hosted zone name with
`*`, for example:
`arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/*`
You can't use the CloudWatch console to create or edit a resource policy. You must use the CloudWatch API, one of the AWS SDKs, or the AWS CLI.
- Create a CloudWatch Logs log group, and make note of the
ARN, which you specify when you create a query logging configuration. Note
the following:
- Log Streams and Edge Locations
- When
Amazon Route 53 finishes creating the configuration for DNS query logging,
it does the following:
- Creates a log stream for an edge location the first time that the edge location responds to DNS queries for the specified hosted zone. That log stream is used to log all queries that Amazon Route 53 responds to for that edge location.
- Begins to send query logs to the applicable log stream.
- Queries That Are Logged
- Query logs contain only the queries that DNS resolvers forward to Amazon Route 53. If a DNS resolver has already cached the response to a query (such as the IP address for a load balancer for example.com), the resolver will continue to return the cached response. It doesn't forward another query to Amazon Route 53 until the TTL for the corresponding resource record set expires. Depending on how many DNS queries are submitted for a resource record set, and depending on the TTL for that resource record set, query logs might contain information about only one query out of every several thousand queries that are submitted to DNS. For more information about how DNS works, see [Routing Internet Traffic to Your Website or Web Application](http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/welcome-dns-service.html) in the *Amazon Route 53 Developer Guide*.
- Log File Format
- For a list of the values in each query log and the format of each value, see [Logging DNS Queries](http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/query-logs.html) in the *Amazon Route 53 Developer Guide*.
- Pricing
- For information about charges for query logs, see [Amazon CloudWatch Pricing](http://aws.amazon.com/cloudwatch/pricing/).
- How to Stop Logging
- If you want Amazon Route 53 to stop sending query logs to CloudWatch Logs, delete the query logging configuration. For more information, see `DeleteQueryLoggingConfig`.
Creates a delegation set (a group of four name servers) that can be reused
by multiple hosted zones. If a hosted zoned ID is specified,
CreateReusableDelegationSet
marks the delegation set associated with that
zone as reusable
configure white label name servers, see Configuring White Label Name Servers.
Creates a traffic policy, which you use to create multiple DNS resource record sets for one domain name (such as example.com) or one subdomain name (such as www.example.com).
Creates resource record sets in a specified hosted zone based on the
settings in a specified traffic policy version. In addition,
CreateTrafficPolicyInstance
associates the resource record sets with a
specified domain name (such as example.com) or subdomain name (such as
www.example.com). Amazon Route 53 responds to DNS queries for the domain or
subdomain name by using the resource record sets that
CreateTrafficPolicyInstance
created.
Creates a new version of an existing traffic policy. When you create a new version of a traffic policy, you specify the ID of the traffic policy that you want to update and a JSON-formatted document that describes the new version. You use traffic policies to create multiple DNS resource record sets for one domain name (such as example.com) or one subdomain name (such as www.example.com). You can create a maximum of 1000 versions of a traffic policy. If you reach the limit and need to create another version, you’ll need to start a new traffic policy.
Authorizes the AWS account that created a specified VPC to submit an
AssociateVPCWithHostedZone
request to associate the VPC with a specified
hosted zone that was created by a different account. To submit a
CreateVPCAssociationAuthorization
request, you must use the account that
created the hosted zone. After you authorize the association, use the
account that created the VPC to submit an AssociateVPCWithHostedZone
request.
Deletes a health check.
Deletes a hosted zone.
default SOA record and NS resource record sets. If the hosted zone contains
other resource record sets, you must delete them before you can delete the
hosted zone. If you try to delete a hosted zone that contains other
resource record sets, the request fails, and Amazon Route 53 returns a
HostedZoneNotEmpty
error. For information about deleting records from
your hosted zone, see ChangeResourceRecordSets
.
To verify that the hosted zone has been deleted, do one of the following:
- Use the `GetHostedZone` action to request information about the hosted zone.
- Use the `ListHostedZones` action to get a list of the hosted zones associated with the current AWS account.
Deletes a configuration for DNS query logging. If you delete a configuration, Amazon Route 53 stops sending query logs to CloudWatch Logs. Amazon Route 53 doesn’t delete any logs that are already in CloudWatch Logs.
For more information about DNS query logs, see CreateQueryLoggingConfig
.
Deletes a reusable delegation set.
with any hosted zones, submit a GetReusableDelegationSet
request and
specify the ID of the reusable delegation set that you want to delete.
Deletes a traffic policy.
Deletes a traffic policy instance and all of the resource record sets that Amazon Route 53 created when you created the instance.
Removes authorization to submit an AssociateVPCWithHostedZone
request to
associate a specified VPC with a hosted zone that was created by a
different account. You must use the account that created the hosted zone to
submit a DeleteVPCAssociationAuthorization
request.
Disassociates a VPC from a Amazon Route 53 private hosted zone.
when only one VPC is associated with the hosted zone. You also can’t convert a private hosted zone into a public hosted zone.
Returns the current status of a change batch request. The status is one of the following values:
- `PENDING` indicates that the changes in this request have not propagated to all Amazon Route 53 DNS servers. This is the initial status of all change batch requests.
- `INSYNC` indicates that the changes have propagated to all Amazon Route 53 DNS servers.
GetCheckerIpRanges
still works, but we recommend that you download
ip-ranges.json, which includes IP address ranges for all AWS services. For
more information, see IP Address Ranges of Amazon Route 53
Servers
in the Amazon Route 53 Developer Guide.
Gets information about whether a specified geographic location is supported for Amazon Route 53 geolocation resource record sets.
Use the following syntax to determine whether a continent is supported for geolocation:
GET /2013-04-01/geolocation?ContinentCode=*two-letter abbreviation for a
continent*
Use the following syntax to determine whether a country is supported for geolocation:
GET /2013-04-01/geolocation?CountryCode=*two-character country code*
Use the following syntax to determine whether a subdivision of a country is supported for geolocation:
GET /2013-04-01/geolocation?CountryCode=*two-character country
code*&SubdivisionCode=*subdivision code*
Gets information about a specified health check.
Retrieves the number of health checks that are associated with the current AWS account.
Gets the reason that a specified health check failed most recently.
Gets status of a specified health check.
Gets information about a specified hosted zone including the four name servers assigned to the hosted zone.
Retrieves the number of hosted zones that are associated with the current AWS account.
Gets information about a specified configuration for DNS query logging.
For more information about DNS query logs, see CreateQueryLoggingConfig
and Logging DNS
Queries.
Retrieves information about a specified reusable delegation set, including the four name servers that are assigned to the delegation set.
Gets information about a specific traffic policy version.
Gets information about a specified traffic policy instance.
known as policy records.
Gets the number of traffic policy instances that are associated with the current AWS account.
Retrieves a list of supported geo locations.
Countries are listed first, and continents are listed last. If Amazon Route 53 supports subdivisions for a country (for example, states or provinces), the subdivisions for that country are listed in alphabetical order immediately after the corresponding country.
Retrieve a list of the health checks that are associated with the current AWS account.
Retrieves a list of the public and private hosted zones that are associated
with the current AWS account. The response includes a HostedZones
child
element for each hosted zone.
Amazon Route 53 returns a maximum of 100 items in each response. If you
have a lot of hosted zones, you can use the maxitems
parameter to list
them in groups of up to 100.
Retrieves a list of your hosted zones in lexicographic order. The response
includes a HostedZones
child element for each hosted zone created by the
current AWS account.
ListHostedZonesByName
sorts hosted zones by name with the labels
reversed. For example:
com.example.www.
Note the trailing dot, which can change the sort order in some circumstances.
If the domain name includes escape characters or Punycode,
ListHostedZonesByName
alphabetizes the domain name using the escaped or
Punycoded value, which is the format that Amazon Route 53 saves in its
database. For example, to create a hosted zone for exämple.com, you specify
ex344mple.com for the domain name. ListHostedZonesByName
alphabetizes it
as:
com.ex344mple.
The labels are reversed and alphabetized using the escaped value. For more information about valid domain name formats, including internationalized domain names, see DNS Domain Name Format in the Amazon Route 53 Developer Guide.
Amazon Route 53 returns up to 100 items in each response. If you have a lot
of hosted zones, use the MaxItems
parameter to list them in groups of up
to 100. The response includes values that help navigate from one group of
MaxItems
hosted zones to the next:
- The `DNSName` and `HostedZoneId` elements in the response contain the values, if any, specified for the `dnsname` and `hostedzoneid` parameters in the request that produced the current response.
- The `MaxItems` element in the response contains the value, if any, that you specified for the `maxitems` parameter in the request that produced the current response.
- If the value of `IsTruncated` in the response is true, there are more hosted zones associated with the current AWS account. If `IsTruncated` is false, this response includes the last hosted zone that is associated with the current account. The `NextDNSName` element and `NextHostedZoneId` elements are omitted from the response.
- The `NextDNSName` and `NextHostedZoneId` elements in the response contain the domain name and the hosted zone ID of the next hosted zone that is associated with the current AWS account. If you want to list more hosted zones, make another call to `ListHostedZonesByName`, and specify the value of `NextDNSName` and `NextHostedZoneId` in the `dnsname` and `hostedzoneid` parameters, respectively.
Lists the configurations for DNS query logging that are associated with the current AWS account or the configuration that is associated with a specified hosted zone.
For more information about DNS query logs, see CreateQueryLoggingConfig
.
Additional information, including the format of DNS query logs, appears in
Logging DNS
Queries
in the Amazon Route 53 Developer Guide.
Lists the resource record sets in a specified hosted zone.
ListResourceRecordSets
returns up to 100 resource record sets at a time
in ASCII order, beginning at a position specified by the name
and type
elements. The action sorts results first by DNS name with the labels
reversed, for example:
com.example.www.
Note the trailing dot, which can change the sort order in some circumstances.
When multiple records have the same DNS name, the action sorts results by the record type.
You can use the name and type elements to adjust the beginning position of the list of resource record sets returned:
- If you do not specify Name or Type
- The results begin with the first resource record set that the hosted zone contains.
- If you specify Name but not Type
- The results begin with the first resource record set in the list whose name is greater than or equal to `Name`.
- If you specify Type but not Name
- Amazon Route 53 returns the `InvalidInput` error.
- If you specify both Name and Type
- The results begin with the first resource record set in the list whose name is greater than or equal to `Name`, and whose type is greater than or equal to `Type`.
Retrieves a list of the reusable delegation sets that are associated with the current AWS account.
Lists tags for one health check or hosted zone.
For information about using tags for cost allocation, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
Lists tags for up to 10 health checks or hosted zones.
For information about using tags for cost allocation, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
Gets information about the latest version for every traffic policy that is associated with the current AWS account. Policies are listed in the order in which they were created.
Gets information about the traffic policy instances that you created by using the current AWS account.
you have a lot of traffic policy instances, you can use the MaxItems
parameter to list them in groups of up to 100.
Gets information about the traffic policy instances that you created in a specified hosted zone.
you have a lot of traffic policy instances, you can use the MaxItems
parameter to list them in groups of up to 100.
Gets information about the traffic policy instances that you created by using a specify traffic policy version.
you have a lot of traffic policy instances, you can use the MaxItems
parameter to list them in groups of up to 100.
Gets information about all of the versions for a specified traffic policy.
Traffic policy versions are listed in numerical order by VersionNumber
.
Gets a list of the VPCs that were created by other accounts and that can be
associated with a specified hosted zone because you’ve submitted one or
more CreateVPCAssociationAuthorization
requests.
The response includes a VPCs
element with a VPC
child element for each
VPC that can be associated with the hosted zone.
Gets the value that Amazon Route 53 returns in response to a DNS request for a specified record name and type. You can optionally specify the IP address of a DNS resolver, an EDNS0 client subnet IP address, and a subnet mask.
Updates an existing health check. Note that some values can’t be updated.
For more information about updating health checks, see Creating, Updating, and Deleting Health Checks in the Amazon Route 53 Developer Guide.
Updates the comment for a specified hosted zone.
Updates the comment for a specified traffic policy version.
Updates the resource record sets in a specified hosted zone that were created based on the settings in a specified traffic policy version.
When you update a traffic policy instance, Amazon Route 53 continues to respond to DNS queries for the root resource record set name (such as example.com) while it replaces one group of resource record sets with another. Amazon Route 53 performs the following operations:
- Amazon Route 53 creates a new group of resource record sets based on the specified traffic policy. This is true regardless of how significant the differences are between the existing resource record sets and the new resource record sets.
- When all of the new resource record sets have been created, Amazon Route 53 starts to respond to DNS queries for the root resource record set name (such as example.com) by using the new resource record sets.
- Amazon Route 53 deletes the old group of resource record sets that are associated with the root resource record set name.