Route53
Service object for interacting with AWS Route53 service.
public struct Route53: AWSService
Amazon Route 53 is a highly available and scalable Domain Name System (DNS) web service.
Inheritance
AWSService
Initializers
init(client:partition:endpoint:timeout:byteBufferAllocator:options:)
Initialize the Route53 client
public init(
client: AWSClient,
partition: AWSPartition = .aws,
endpoint: String? = nil,
timeout: TimeAmount? = nil,
byteBufferAllocator: ByteBufferAllocator = ByteBufferAllocator(),
options: AWSServiceConfig.Options = []
)
Parameters
- client: AWSClient used to process requests
- partition: AWS partition where service resides, standard (.aws), china (.awscn), government (.awsusgov).
- endpoint: Custom endpoint URL to use instead of standard AWS servers
- timeout: Timeout value for HTTP requests
init(from:patch:)
Initializer required by AWSService.with(middlewares:timeout:byteBufferAllocator:options)
. You are not able to use this initializer directly as there are no public initializers for AWSServiceConfig.Patch
. Please use AWSService.with(middlewares:timeout:byteBufferAllocator:options)
instead.
public init(from: Route53, patch: AWSServiceConfig.Patch)
Properties
client
Client used for communication with AWS
public let client: AWSClient
config
Service configuration
public let config: AWSServiceConfig
Methods
activateKeySigningKey(_:logger:on:)
public func activateKeySigningKey(_ input: ActivateKeySigningKeyRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ActivateKeySigningKeyResponse>
Activates a key-signing key (KSK) so that it can be used for signing by DNSSEC. This operation changes the
KSK status to ACTIVE
.
associateVPCWithHostedZone(_:logger:on:)
public func associateVPCWithHostedZone(_ input: AssociateVPCWithHostedZoneRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<AssociateVPCWithHostedZoneResponse>
Associates an Amazon VPC with a private hosted zone.
To perform the association, the VPC and the private hosted zone must already exist. You can't convert a public hosted zone into a private hosted zone.
If you want to associate a VPC that was created by using one Amazon Web Services account with a private hosted zone that was created
by using a different account, the Amazon Web Services 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.
When granting access, the hosted zone and the Amazon VPC must belong to the same partition. A partition is a group of Amazon Web Services Regions. Each Amazon Web Services account is scoped to one partition.
The following are the supported partitions:
-
aws
- Amazon Web Services Regions -
aws-cn
- China Regions -
aws-us-gov
- Amazon Web Services GovCloud (US) Region
For more information, see Access Management in the Amazon Web Services General Reference.
changeResourceRecordSets(_:logger:on:)
public func changeResourceRecordSets(_ input: ChangeResourceRecordSetsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ChangeResourceRecordSetsResponse>
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.
<p>
<b>Deleting Resource Record Sets</b>
</p>
<p>To delete a resource record set, you must specify all the same values that you specified when you created it.</p>
<p>
<b>Change Batches and Transactional Changes</b>
</p>
<p>The request body must include a document with a <code>ChangeResourceRecordSetsRequest</code> element.
The request body contains a list of change items, known as a change batch. Change batches are considered transactional changes.
Route 53 validates the changes in the request and then either makes all or none of the changes in the change batch request.
This ensures that DNS routing isn't adversely affected by partial changes to the resource record sets in a hosted zone. </p>
<p>For example, suppose a change batch request contains two changes: it deletes the <code>CNAME</code> resource record set for www.example.com and
creates an alias resource record set for www.example.com. If validation for both records succeeds, Route 53 deletes the first resource record set and
creates the second resource record set in a single operation. If validation for either the <code>DELETE</code> or the <code>CREATE</code> action fails,
then the request is canceled, and the original <code>CNAME</code> record continues to exist.</p>
<note>
<p>If you try to delete the same resource record set more than once in a single change batch, Route 53 returns an <code>InvalidChangeBatch</code> error.</p>
</note>
<p>
<b>Traffic Flow</b>
</p>
<p>To create resource record sets for complex routing configurations, use either the traffic flow visual editor in the
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 <a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/traffic-flow.html">Using Traffic Flow to Route DNS Traffic</a>
in the <i>Amazon Route 53 Developer Guide</i>.</p>
<p>
<b>Create, Delete, and Upsert</b>
</p>
<p>Use <code>ChangeResourceRecordsSetsRequest</code> to perform the following actions:</p>
<ul>
<li>
<p>
<code>CREATE</code>: Creates a resource record set that has the specified values.</p>
</li>
<li>
<p>
<code>DELETE</code>: Deletes an existing resource record set that has the specified values.</p>
</li>
<li>
<p>
<code>UPSERT</code>: If a resource set exists Route 53 updates it with the values in the
request. </p>
</li>
</ul>
<p>
<b>Syntaxes for Creating, Updating, and Deleting Resource Record Sets</b>
</p>
<p>The syntax for a request depends on the type of resource record set that you want to create, delete, or update, such as
weighted, alias, or failover. The XML elements in your request must appear in the order listed in the syntax. </p>
<p>For an example for each type of resource record set, see "Examples."</p>
<p>Don't refer to the syntax in the "Parameter Syntax" section, which includes all of the elements for every kind of
resource record set that you can create, delete, or update by using <code>ChangeResourceRecordSets</code>. </p>
<p>
<b>Change Propagation to Route 53 DNS Servers</b>
</p>
<p>When you submit a <code>ChangeResourceRecordSets</code> request, Route 53 propagates your changes to all of the
Route 53 authoritative DNS servers. While your changes are propagating, <code>GetChange</code> returns a status of
<code>PENDING</code>. When propagation is complete, <code>GetChange</code> returns a status of <code>INSYNC</code>.
Changes generally propagate to all Route 53 name servers within 60 seconds. For more information, see
<a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetChange.html">GetChange</a>.</p>
<p>
<b>Limits on ChangeResourceRecordSets Requests</b>
</p>
<p>For information about the limits on a <code>ChangeResourceRecordSets</code> request, see
<a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html">Limits</a> in the
<i>Amazon Route 53 Developer Guide</i>.</p>
changeTagsForResource(_:logger:on:)
public func changeTagsForResource(_ input: ChangeTagsForResourceRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ChangeTagsForResourceResponse>
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 Billing and Cost Management User Guide.
createHealthCheck(_:logger:on:)
public func createHealthCheck(_ input: CreateHealthCheckRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateHealthCheckResponse>
Creates a new health check.
For information about adding health checks to resource record sets, see HealthCheckId in ChangeResourceRecordSets.
<p>
<b>ELB Load Balancers</b>
</p>
<p>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 a Route 53 health check.</p>
<p>
<b>Private Hosted Zones</b>
</p>
<p>You can associate health checks with failover resource record sets in a private hosted zone. Note the following:</p>
<ul>
<li>
<p>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.</p>
</li>
<li>
<p>You can configure a health checker to check the health of an external resource that the instance relies on, such as a
database server.</p>
</li>
<li>
<p>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 <code>StatusCheckFailed</code> 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
<a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/WhatIsCloudWatch.html">Amazon CloudWatch User Guide</a>.</p>
</li>
</ul>
createHostedZone(_:logger:on:)
public func createHostedZone(_ input: CreateHostedZoneRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateHostedZoneResponse>
Creates a new public or private hosted zone. You create records in a public hosted zone to define how you want to route traffic on the internet for a domain, such as example.com, and its subdomains (apex.example.com, acme.example.com). You create records in a private hosted zone to define how you want to route traffic for a domain and its subdomains within one or more Amazon Virtual Private Clouds (Amazon VPCs).
You can't convert a public hosted zone to a private hosted zone or vice versa. Instead, you must create a new hosted zone with the same name and create new resource record sets.
For more information about charges for hosted zones, see Amazon Route 53 Pricing.
Note the following:
-
You can't create a hosted zone for a top-level domain (TLD) such as .com.
-
For public hosted zones, 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 Route 53 Creates for a Hosted Zone in the Amazon Route 53 Developer Guide.
If you want to use the same name servers for multiple public 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 Route 53, you must update the name servers with your registrar to make Route 53 the DNS service for the domain. For more information, see Migrating DNS Service for an Existing Domain to Amazon Route 53 in the Amazon Route 53 Developer Guide.
When you submit a CreateHostedZone
request, the initial status of the hosted zone is PENDING
.
For public hosted zones, this means that the NS and SOA records are not yet available on all Route 53 DNS servers. When the
NS and SOA records are available, the status of the zone changes to INSYNC
.
The CreateHostedZone
request requires the caller to have an ec2:DescribeVpcs
permission.
When creating private hosted zones, the Amazon VPC must belong to the same partition where the hosted zone is created. A partition is a group of Amazon Web Services Regions. Each Amazon Web Services account is scoped to one partition.
The following are the supported partitions:
-
aws
- Amazon Web Services Regions -
aws-cn
- China Regions -
aws-us-gov
- Amazon Web Services GovCloud (US) Region
For more information, see Access Management in the Amazon Web Services General Reference.
createKeySigningKey(_:logger:on:)
public func createKeySigningKey(_ input: CreateKeySigningKeyRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateKeySigningKeyResponse>
Creates a new key-signing key (KSK) associated with a hosted zone. You can only have two KSKs per hosted zone.
createQueryLoggingConfig(_:logger:on:)
public func createQueryLoggingConfig(_ input: CreateQueryLoggingConfigRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateQueryLoggingConfigResponse>
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 Route 53 receives for a specified public hosted zone, such as the following:
-
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
orServFail
<dl>
<dt>Log Group and Resource Policy</dt>
<dd>
<p>Before you create a query logging configuration, perform the following operations.</p>
<note>
<p>If you create a query logging configuration using the Route 53 console, Route 53 performs these operations automatically.</p>
</note>
<ol>
<li>
<p>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:</p>
<ul>
<li>
<p>You must create the log group in the us-east-1 region.</p>
</li>
<li>
<p>You must use the same Amazon Web Services account to create the log group and the hosted zone that you want to
configure query logging for.</p>
</li>
<li>
<p>When you create log groups for query logging, we recommend that you use a consistent prefix, for example:</p>
<p>
<code>/aws/route53/<i>hosted zone name</i>
</code>
</p>
<p>In the next step, you'll create a resource policy, which controls access to one or more log groups and the associated
Amazon Web Services resources, such as 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.</p>
</li>
</ul>
</li>
<li>
<p>Create a CloudWatch Logs resource policy, and give it the permissions that Route 53 needs to create log streams and to
send query logs to log streams. For the value of <code>Resource</code>, 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 <code>*</code>, for example:</p>
<p>
<code>arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/*</code>
</p>
<p>To avoid the confused deputy problem, a security issue where an entity without a
permission for an action can coerce a more-privileged entity to
perform it, you can optionally limit the permissions that a service
has to a resource in a resource-based policy by supplying the
following values:</p>
<ul>
<li>
<p>For <code>aws:SourceArn</code>, supply the hosted zone ARN used in creating the query logging
configuration. For example, <code>aws:SourceArn:
arn:aws:route53:::hostedzone/hosted zone
ID</code>.</p>
</li>
<li>
<p>For <code>aws:SourceAccount</code>, supply the account ID for the account that creates the
query logging configuration. For example,
<code>aws:SourceAccount:111111111111</code>.</p>
</li>
</ul>
<p>For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/confused-deputy.html">The confused
deputy problem</a> in the <i>Amazon Web Services
IAM User Guide</i>.</p>
<note>
<p>You can't use the CloudWatch console to create or edit a resource policy. You must use the CloudWatch API, one of the Amazon Web Services SDKs,
or the CLI.</p>
</note>
</li>
</ol>
</dd>
<dt>Log Streams and Edge Locations</dt>
<dd>
<p>When Route 53 finishes creating the configuration for DNS query logging, it does the following:</p>
<ul>
<li>
<p>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 Route 53 responds to for that edge location.</p>
</li>
<li>
<p>Begins to send query logs to the applicable log stream.</p>
</li>
</ul>
<p>The name of each log stream is in the following format:</p>
<p>
<code>
<i>hosted zone ID</i>/<i>edge location code</i>
</code>
</p>
<p>The edge location code is a three-letter code and an arbitrarily assigned number, for example, DFW3. The three-letter code
typically corresponds with the International Air Transport Association airport code for an airport near the edge location.
(These abbreviations might change in the future.) For a list of edge locations, see "The Route 53 Global Network" on the
<a href="http://aws.amazon.com/route53/details/">Route 53 Product Details</a> page.</p>
</dd>
<dt>Queries That Are Logged</dt>
<dd>
<p>Query logs contain only the queries that DNS resolvers forward to 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 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
<a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/welcome-dns-service.html">Routing Internet Traffic to Your Website or Web Application</a>
in the <i>Amazon Route 53 Developer Guide</i>.</p>
</dd>
<dt>Log File Format</dt>
<dd>
<p>For a list of the values in each query log and the format of each value, see
<a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/query-logs.html">Logging DNS Queries</a> in the
<i>Amazon Route 53 Developer Guide</i>.</p>
</dd>
<dt>Pricing</dt>
<dd>
<p>For information about charges for query logs, see
<a href="http://aws.amazon.com/cloudwatch/pricing/">Amazon CloudWatch Pricing</a>.</p>
</dd>
<dt>How to Stop Logging</dt>
<dd>
<p>If you want Route 53 to stop sending query logs to CloudWatch Logs, delete the query logging configuration. For more information, see
<a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_DeleteQueryLoggingConfig.html">DeleteQueryLoggingConfig</a>.</p>
</dd>
</dl>
createReusableDelegationSet(_:logger:on:)
public func createReusableDelegationSet(_ input: CreateReusableDelegationSetRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateReusableDelegationSetResponse>
Creates a delegation set (a group of four name servers) that can be reused by multiple hosted zones that were created by the same Amazon Web Services account.
You can also create a reusable delegation set that uses the four name servers that are associated
with an existing hosted zone. Specify the hosted zone ID in the CreateReusableDelegationSet
request.
You can't associate a reusable delegation set with a private hosted zone.
For information about using a reusable delegation set to configure white label name servers, see Configuring White Label Name Servers.
<p>The process for migrating existing hosted zones to use a reusable delegation set is comparable to the process for
configuring white label name servers. You need to perform the following steps:</p>
<ol>
<li>
<p>Create a reusable delegation set.</p>
</li>
<li>
<p>Recreate hosted zones, and reduce the TTL to 60 seconds or less.</p>
</li>
<li>
<p>Recreate resource record sets in the new hosted zones.</p>
</li>
<li>
<p>Change the registrar's name servers to use the name servers for the new hosted zones.</p>
</li>
<li>
<p>Monitor traffic for the website or application.</p>
</li>
<li>
<p>Change TTLs back to their original values.</p>
</li>
</ol>
<p>If you want to migrate existing hosted zones to use a reusable delegation set, the existing hosted zones can't use
any of the name servers that are assigned to the reusable delegation set. If one or more hosted zones do use one or more
name servers that are assigned to the reusable delegation set, you can do one of the following:</p>
<ul>
<li>
<p>For small numbers of hosted zones—up to a few hundred—it's relatively easy to create
reusable delegation sets until you get one that has four name servers that don't overlap with any of the name servers
in your hosted zones.</p>
</li>
<li>
<p>For larger numbers of hosted zones, the easiest solution is to use more than one reusable delegation set.</p>
</li>
<li>
<p>For larger numbers of hosted zones, you can also migrate hosted zones that have overlapping name servers
to hosted zones that don't have overlapping name servers, then migrate the hosted zones again to use the
reusable delegation set.</p>
</li>
</ul>
createTrafficPolicy(_:logger:on:)
public func createTrafficPolicy(_ input: CreateTrafficPolicyRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateTrafficPolicyResponse>
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).
createTrafficPolicyInstance(_:logger:on:)
public func createTrafficPolicyInstance(_ input: CreateTrafficPolicyInstanceRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateTrafficPolicyInstanceResponse>
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.
createTrafficPolicyVersion(_:logger:on:)
public func createTrafficPolicyVersion(_ input: CreateTrafficPolicyVersionRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateTrafficPolicyVersionResponse>
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.
createVPCAssociationAuthorization(_:logger:on:)
public func createVPCAssociationAuthorization(_ input: CreateVPCAssociationAuthorizationRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateVPCAssociationAuthorizationResponse>
Authorizes the Amazon Web Services 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.
If you want to associate multiple VPCs that you created by using one account with a hosted zone that you created by using a different account, you must submit one authorization request for each VPC.
deactivateKeySigningKey(_:logger:on:)
public func deactivateKeySigningKey(_ input: DeactivateKeySigningKeyRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeactivateKeySigningKeyResponse>
Deactivates a key-signing key (KSK) so that it will not be used for signing by DNSSEC. This operation changes the
KSK status to INACTIVE
.
deleteHealthCheck(_:logger:on:)
public func deleteHealthCheck(_ input: DeleteHealthCheckRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteHealthCheckResponse>
Deletes a health check.
Amazon Route 53 does not prevent you from deleting a health check even if the health check is associated with one or more resource record sets. If you delete a health check and you don't update the associated resource record sets, the future status of the health check can't be predicted and may change. This will affect the routing of DNS queries for your DNS failover configuration. For more information, see Replacing and Deleting Health Checks in the Amazon Route 53 Developer Guide.
<p>If you're using Cloud Map and you configured Cloud Map to create a Route 53 health check when you register an instance,
you can't use the Route 53 <code>DeleteHealthCheck</code> command to delete the health check. The health check is deleted
automatically when you deregister the instance; there can be a delay of several hours before the health check is deleted
from Route 53. </p>
deleteHostedZone(_:logger:on:)
public func deleteHostedZone(_ input: DeleteHostedZoneRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteHostedZoneResponse>
Deletes a hosted zone.
<p>If the hosted zone was created by another service, such as Cloud Map, see
<a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DeleteHostedZone.html#delete-public-hosted-zone-created-by-another-service">Deleting
Public Hosted Zones That Were Created by Another Service</a> in the <i>Amazon Route 53 Developer Guide</i> for information about how to delete it.
(The process is the same for public and private hosted zones that were created by another service.)</p>
<p>If you want to keep your domain registration but you want to stop routing internet traffic to your website or web application,
we recommend that you delete resource record sets in the hosted zone instead of deleting the hosted zone.</p>
<important>
<p>If you delete a hosted zone, you can't undelete it. You must create a new hosted zone and update the name servers for your
domain registration, which can require up to 48 hours to take effect. (If you delegated responsibility for a subdomain to a hosted zone
and you delete the child hosted zone, you must update the name servers in the parent hosted zone.) In addition, if you delete a hosted zone,
someone could hijack the domain and route traffic to their own resources using your domain name.</p>
</important>
<p>If you want to avoid the monthly charge for the hosted zone, you can transfer DNS service for the domain to a free DNS service.
When you transfer DNS service, you have to update the name servers for the domain registration. If the domain is registered with Route 53,
see <a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_UpdateDomainNameservers.html">UpdateDomainNameservers</a>
for information about how to replace Route 53 name servers with name servers for the new DNS service. If the domain is registered with
another registrar, use the method provided by the registrar to update name servers for the domain registration. For more information,
perform an internet search on "free DNS service."</p>
<p>You can delete a hosted zone only if it contains only the 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 Route 53 returns a
<code>HostedZoneNotEmpty</code> error. For information about deleting records from your hosted zone, see
<a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_ChangeResourceRecordSets.html">ChangeResourceRecordSets</a>.</p>
<p>To verify that the hosted zone has been deleted, do one of the following:</p>
<ul>
<li>
<p>Use the <code>GetHostedZone</code> action to request information about the hosted zone.</p>
</li>
<li>
<p>Use the <code>ListHostedZones</code> action to get a list of the hosted zones associated with the current
Amazon Web Services account.</p>
</li>
</ul>
deleteKeySigningKey(_:logger:on:)
public func deleteKeySigningKey(_ input: DeleteKeySigningKeyRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteKeySigningKeyResponse>
Deletes a key-signing key (KSK). Before you can delete a KSK, you must deactivate it. The KSK must be deactivated before you can delete it regardless of whether the hosted zone is enabled for DNSSEC signing.
You can use DeactivateKeySigningKey to deactivate the key before you delete it.
Use GetDNSSEC to verify that the KSK is in an INACTIVE
status.
deleteQueryLoggingConfig(_:logger:on:)
public func deleteQueryLoggingConfig(_ input: DeleteQueryLoggingConfigRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteQueryLoggingConfigResponse>
Deletes a configuration for DNS query logging. If you delete a configuration, Amazon Route 53 stops sending query logs to CloudWatch Logs. Route 53 doesn't delete any logs that are already in CloudWatch Logs.
<p>For more information about DNS query logs, see
<a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_CreateQueryLoggingConfig.html">CreateQueryLoggingConfig</a>.</p>
deleteReusableDelegationSet(_:logger:on:)
public func deleteReusableDelegationSet(_ input: DeleteReusableDelegationSetRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteReusableDelegationSetResponse>
Deletes a reusable delegation set.
You can delete a reusable delegation set only if it isn't associated with any hosted zones.
To verify that the reusable delegation set is not associated with any hosted zones, submit a GetReusableDelegationSet request and specify the ID of the reusable delegation set that you want to delete.
deleteTrafficPolicy(_:logger:on:)
public func deleteTrafficPolicy(_ input: DeleteTrafficPolicyRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteTrafficPolicyResponse>
Deletes a traffic policy.
When you delete a traffic policy, Route 53 sets a flag on the policy to indicate that it has been deleted. However, Route 53 never fully deletes the traffic policy. Note the following:
-
Deleted traffic policies aren't listed if you run ListTrafficPolicies.
-
There's no way to get a list of deleted policies.
-
If you retain the ID of the policy, you can get information about the policy, including the traffic policy document, by running GetTrafficPolicy.
deleteTrafficPolicyInstance(_:logger:on:)
public func deleteTrafficPolicyInstance(_ input: DeleteTrafficPolicyInstanceRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteTrafficPolicyInstanceResponse>
Deletes a traffic policy instance and all of the resource record sets that Amazon Route 53 created when you created the instance.
In the Route 53 console, traffic policy instances are known as policy records.
deleteVPCAssociationAuthorization(_:logger:on:)
public func deleteVPCAssociationAuthorization(_ input: DeleteVPCAssociationAuthorizationRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteVPCAssociationAuthorizationResponse>
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.
Sending this request only prevents the Amazon Web Services account that created the VPC from associating the VPC
with the Amazon Route 53 hosted zone in the future. If the VPC is already associated with the hosted zone,
DeleteVPCAssociationAuthorization
won't disassociate the VPC from the hosted zone.
If you want to delete an existing association, use DisassociateVPCFromHostedZone
.
disableHostedZoneDNSSEC(_:logger:on:)
public func disableHostedZoneDNSSEC(_ input: DisableHostedZoneDNSSECRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DisableHostedZoneDNSSECResponse>
Disables DNSSEC signing in a specific hosted zone. This action does not deactivate any key-signing keys (KSKs) that are active in the hosted zone.
disassociateVPCFromHostedZone(_:logger:on:)
public func disassociateVPCFromHostedZone(_ input: DisassociateVPCFromHostedZoneRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DisassociateVPCFromHostedZoneResponse>
Disassociates an Amazon Virtual Private Cloud (Amazon VPC) from an Amazon Route 53 private hosted zone. Note the following:
-
You can't disassociate the last Amazon VPC from a private hosted zone.
-
You can't convert a private hosted zone into a public hosted zone.
-
You can submit a
DisassociateVPCFromHostedZone
request using either the account that created the hosted zone or the account that created the Amazon VPC. -
Some services, such as Cloud Map and Amazon Elastic File System (Amazon EFS) automatically create hosted zones and associate VPCs with the hosted zones. A service can create a hosted zone using your account or using its own account. You can disassociate a VPC from a hosted zone only if the service created the hosted zone using your account.
When you run DisassociateVPCFromHostedZone, if the hosted zone has a value for
OwningAccount
, you can useDisassociateVPCFromHostedZone
. If the hosted zone has a value forOwningService
, you can't useDisassociateVPCFromHostedZone
.
When revoking access, the hosted zone and the Amazon VPC must belong to the same partition. A partition is a group of Amazon Web Services Regions. Each Amazon Web Services account is scoped to one partition.
The following are the supported partitions:
-
aws
- Amazon Web Services Regions -
aws-cn
- China Regions -
aws-us-gov
- Amazon Web Services GovCloud (US) Region
For more information, see Access Management in the Amazon Web Services General Reference.
enableHostedZoneDNSSEC(_:logger:on:)
public func enableHostedZoneDNSSEC(_ input: EnableHostedZoneDNSSECRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<EnableHostedZoneDNSSECResponse>
Enables DNSSEC signing in a specific hosted zone.
getAccountLimit(_:logger:on:)
public func getAccountLimit(_ input: GetAccountLimitRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetAccountLimitResponse>
Gets the specified limit for the current account, for example, the maximum number of health checks that you can create using the account.
For the default limit, see Limits in the Amazon Route 53 Developer Guide. To request a higher limit, open a case.
You can also view account limits in Amazon Web Services Trusted Advisor. Sign in to the Amazon Web Services Management Console and open the Trusted Advisor console at https://console.aws.amazon.com/trustedadvisor/. Then choose Service limits in the navigation pane.
getChange(_:logger:on:)
public func getChange(_ input: GetChangeRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetChangeResponse>
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 Route 53 DNS servers.
getCheckerIpRanges(_:logger:on:)
public func getCheckerIpRanges(_ input: GetCheckerIpRangesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetCheckerIpRangesResponse>
Route 53 does not perform authorization for this API because it retrieves information that is already available to the public.
GetCheckerIpRanges
still works, but we recommend that you download
ip-ranges.json, which includes IP address ranges for all Amazon Web Services services. For more information, see
IP Address Ranges of Amazon Route 53 Servers
in the Amazon Route 53 Developer Guide.
getDNSSEC(_:logger:on:)
public func getDNSSEC(_ input: GetDNSSECRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetDNSSECResponse>
Returns information about DNSSEC for a specific hosted zone, including the key-signing keys (KSKs) in the hosted zone.
getGeoLocation(_:logger:on:)
public func getGeoLocation(_ input: GetGeoLocationRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetGeoLocationResponse>
Gets information about whether a specified geographic location is supported for Amazon Route 53 geolocation resource record sets.
Route 53 does not perform authorization for this API because it retrieves information that is already available to the public.
<p>Use the following syntax to determine whether a continent is supported for geolocation:</p>
<p>
<code>GET /2013-04-01/geolocation?continentcode=<i>two-letter abbreviation for a continent</i>
</code>
</p>
<p>Use the following syntax to determine whether a country is supported for geolocation:</p>
<p>
<code>GET /2013-04-01/geolocation?countrycode=<i>two-character country code</i>
</code>
</p>
<p>Use the following syntax to determine whether a subdivision of a country is supported for geolocation:</p>
<p>
<code>GET /2013-04-01/geolocation?countrycode=<i>two-character country code</i>&subdivisioncode=<i>subdivision code</i>
</code>
</p>
getHealthCheck(_:logger:on:)
public func getHealthCheck(_ input: GetHealthCheckRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetHealthCheckResponse>
Gets information about a specified health check.
getHealthCheckCount(_:logger:on:)
public func getHealthCheckCount(_ input: GetHealthCheckCountRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetHealthCheckCountResponse>
Retrieves the number of health checks that are associated with the current Amazon Web Services account.
getHealthCheckLastFailureReason(_:logger:on:)
public func getHealthCheckLastFailureReason(_ input: GetHealthCheckLastFailureReasonRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetHealthCheckLastFailureReasonResponse>
Gets the reason that a specified health check failed most recently.
getHealthCheckStatus(_:logger:on:)
public func getHealthCheckStatus(_ input: GetHealthCheckStatusRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetHealthCheckStatusResponse>
Gets status of a specified health check.
This API is intended for use during development to diagnose behavior. It doesn’t support production use-cases with high query rates that require immediate and actionable responses.
getHostedZone(_:logger:on:)
public func getHostedZone(_ input: GetHostedZoneRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetHostedZoneResponse>
Gets information about a specified hosted zone including the four name servers assigned to the hosted zone.
getHostedZoneCount(_:logger:on:)
public func getHostedZoneCount(_ input: GetHostedZoneCountRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetHostedZoneCountResponse>
Retrieves the number of hosted zones that are associated with the current Amazon Web Services account.
getHostedZoneLimit(_:logger:on:)
public func getHostedZoneLimit(_ input: GetHostedZoneLimitRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetHostedZoneLimitResponse>
Gets the specified limit for a specified hosted zone, for example, the maximum number of records that you can create in the hosted zone.
For the default limit, see Limits in the Amazon Route 53 Developer Guide. To request a higher limit, open a case.
getQueryLoggingConfig(_:logger:on:)
public func getQueryLoggingConfig(_ input: GetQueryLoggingConfigRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetQueryLoggingConfigResponse>
Gets information about a specified configuration for DNS query logging.
<p>For more information about DNS query logs, see
<a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_CreateQueryLoggingConfig.html">CreateQueryLoggingConfig</a>
and
<a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/query-logs.html">Logging DNS Queries</a>.</p>
getReusableDelegationSet(_:logger:on:)
public func getReusableDelegationSet(_ input: GetReusableDelegationSetRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetReusableDelegationSetResponse>
Retrieves information about a specified reusable delegation set, including the four name servers that are assigned to the delegation set.
getReusableDelegationSetLimit(_:logger:on:)
public func getReusableDelegationSetLimit(_ input: GetReusableDelegationSetLimitRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetReusableDelegationSetLimitResponse>
Gets the maximum number of hosted zones that you can associate with the specified reusable delegation set.
For the default limit, see Limits in the Amazon Route 53 Developer Guide. To request a higher limit, open a case.
getTrafficPolicy(_:logger:on:)
public func getTrafficPolicy(_ input: GetTrafficPolicyRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetTrafficPolicyResponse>
Gets information about a specific traffic policy version.
For information about how of deleting a traffic policy affects the response from GetTrafficPolicy
, see
DeleteTrafficPolicy.
getTrafficPolicyInstance(_:logger:on:)
public func getTrafficPolicyInstance(_ input: GetTrafficPolicyInstanceRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetTrafficPolicyInstanceResponse>
Gets information about a specified traffic policy instance.
After you submit a CreateTrafficPolicyInstance
or an UpdateTrafficPolicyInstance
request,
there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For
more information, see the State
response element.
In the Route 53 console, traffic policy instances are known as policy records.
getTrafficPolicyInstanceCount(_:logger:on:)
public func getTrafficPolicyInstanceCount(_ input: GetTrafficPolicyInstanceCountRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetTrafficPolicyInstanceCountResponse>
Gets the number of traffic policy instances that are associated with the current Amazon Web Services account.
listGeoLocations(_:logger:on:)
public func listGeoLocations(_ input: ListGeoLocationsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListGeoLocationsResponse>
Retrieves a list of supported geographic 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.
Route 53 does not perform authorization for this API because it retrieves information that is already available to the public.
For a list of supported geolocation codes, see the GeoLocation data type.
listHealthChecks(_:logger:on:)
public func listHealthChecks(_ input: ListHealthChecksRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListHealthChecksResponse>
Retrieve a list of the health checks that are associated with the current Amazon Web Services account.
listHostedZones(_:logger:on:)
public func listHostedZones(_ input: ListHostedZonesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListHostedZonesResponse>
Retrieves a list of the public and private hosted zones that are associated with the current Amazon Web Services 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.
listHostedZonesByName(_:logger:on:)
public func listHostedZonesByName(_ input: ListHostedZonesByNameRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListHostedZonesByNameResponse>
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 Amazon Web Services 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 ex\344mple.com for the domain name. ListHostedZonesByName
alphabetizes it as:
com.ex\344mple.
<p>The labels are reversed and alphabetized using the escaped value. For more information about valid domain name formats,
including internationalized domain names, see <a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DomainNameFormat.html">DNS Domain Name Format</a> in the
<i>Amazon Route 53 Developer Guide</i>.</p>
<p>Route 53 returns up to 100 items in each response. If you have a lot of hosted zones, use the <code>MaxItems</code> parameter to list
them in groups of up to 100. The response includes values that help navigate from one group of <code>MaxItems</code> hosted zones to the next:</p>
<ul>
<li>
<p>The <code>DNSName</code> and <code>HostedZoneId</code> elements in the response contain the values, if any, specified for the
<code>dnsname</code> and <code>hostedzoneid</code> parameters in the request that produced the current response.</p>
</li>
<li>
<p>The <code>MaxItems</code> element in the response contains the value, if any, that you specified for the <code>maxitems</code>
parameter in the request that produced the current response.</p>
</li>
<li>
<p>If the value of <code>IsTruncated</code> in the response is true, there are more hosted zones associated with the
current Amazon Web Services account. </p>
<p>If <code>IsTruncated</code> is false, this response includes the last hosted zone that is associated with the current account.
The <code>NextDNSName</code> element and <code>NextHostedZoneId</code> elements are omitted from the response.</p>
</li>
<li>
<p>The <code>NextDNSName</code> and <code>NextHostedZoneId</code> elements in the response contain the domain name and the
hosted zone ID of the next hosted zone that is associated with the current Amazon Web Services account. If you want to list more hosted zones,
make another call to <code>ListHostedZonesByName</code>, and specify the value of <code>NextDNSName</code> and
<code>NextHostedZoneId</code> in the <code>dnsname</code> and <code>hostedzoneid</code> parameters, respectively.</p>
</li>
</ul>
listHostedZonesByVPC(_:logger:on:)
public func listHostedZonesByVPC(_ input: ListHostedZonesByVPCRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListHostedZonesByVPCResponse>
Lists all the private hosted zones that a specified VPC is associated with, regardless of which Amazon Web Services account or Amazon Web Services service owns the
hosted zones. The HostedZoneOwner
structure in the response contains one of the following values:
-
An
OwningAccount
element, which contains the account number of either the current Amazon Web Services account or another Amazon Web Services account. Some services, such as Cloud Map, create hosted zones using the current account. -
An
OwningService
element, which identifies the Amazon Web Services service that created and owns the hosted zone. For example, if a hosted zone was created by Amazon Elastic File System (Amazon EFS), the value ofOwner
isefs.amazonaws.com
.
When listing private hosted zones, the hosted zone and the Amazon VPC must belong to the same partition where the hosted zones were created. A partition is a group of Amazon Web Services Regions. Each Amazon Web Services account is scoped to one partition.
The following are the supported partitions:
-
aws
- Amazon Web Services Regions -
aws-cn
- China Regions -
aws-us-gov
- Amazon Web Services GovCloud (US) Region
For more information, see Access Management in the Amazon Web Services General Reference.
listQueryLoggingConfigs(_:logger:on:)
public func listQueryLoggingConfigs(_ input: ListQueryLoggingConfigsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListQueryLoggingConfigsResponse>
Lists the configurations for DNS query logging that are associated with the current Amazon Web Services 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.
listResourceRecordSets(_:logger:on:)
public func listResourceRecordSets(_ input: ListResourceRecordSetsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListResourceRecordSetsResponse>
Lists the resource record sets in a specified hosted zone.
ListResourceRecordSets
returns up to 300 resource record sets at a time in ASCII order,
beginning at a position specified by the name
and type
elements.
<p>
<b>Sort order</b>
</p>
<p>
<code>ListResourceRecordSets</code> sorts results first by DNS name with the labels reversed, for example:</p>
<p>
<code>com.example.www.</code>
</p>
<p>Note the trailing dot, which can change the sort order when the record name contains characters that appear before
<code>.</code> (decimal 46) in the ASCII table. These characters include the following: <code>! " # $ % & ' ( ) * + , -</code>
</p>
<p>When multiple records have the same DNS name, <code>ListResourceRecordSets</code> sorts results by the record type.</p>
<p>
<b>Specifying where to start listing records</b>
</p>
<p>You can use the name and type elements to specify the resource record set that the list begins with:</p>
<dl>
<dt>If you do not specify Name or Type</dt>
<dd>
<p>The results begin with the first resource record set that the hosted zone contains.</p>
</dd>
<dt>If you specify Name but not Type</dt>
<dd>
<p>The results begin with the first resource record set in the list whose name is greater than or equal to
<code>Name</code>.</p>
</dd>
<dt>If you specify Type but not Name</dt>
<dd>
<p>Amazon Route 53 returns the <code>InvalidInput</code> error.</p>
</dd>
<dt>If you specify both Name and Type</dt>
<dd>
<p>The results begin with the first resource record set in the list whose name is greater than or equal to
<code>Name</code>, and whose type is greater than or equal to <code>Type</code>.</p>
</dd>
</dl>
<p>
<b>Resource record sets that are PENDING</b>
</p>
<p>This action returns the most current version of the records. This includes records that are <code>PENDING</code>,
and that are not yet available on all Route 53 DNS servers.</p>
<p>
<b>Changing resource record sets</b>
</p>
<p>To ensure that you get an accurate listing of the resource record sets for a hosted zone at a point in time,
do not submit a <code>ChangeResourceRecordSets</code> request while you're paging through the results of a
<code>ListResourceRecordSets</code> request. If you do, some pages may display results without the latest changes
while other pages display results with the latest changes.</p>
<p>
<b>Displaying the next page of results</b>
</p>
<p>If a <code>ListResourceRecordSets</code> command returns more than one page of results, the value of <code>IsTruncated</code>
is <code>true</code>. To display the next page of results, get the values of <code>NextRecordName</code>, <code>NextRecordType</code>,
and <code>NextRecordIdentifier</code> (if any) from the response. Then submit another <code>ListResourceRecordSets</code> request, and
specify those values for <code>StartRecordName</code>, <code>StartRecordType</code>, and <code>StartRecordIdentifier</code>.</p>
listReusableDelegationSets(_:logger:on:)
public func listReusableDelegationSets(_ input: ListReusableDelegationSetsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListReusableDelegationSetsResponse>
Retrieves a list of the reusable delegation sets that are associated with the current Amazon Web Services account.
listTagsForResource(_:logger:on:)
public func listTagsForResource(_ input: ListTagsForResourceRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListTagsForResourceResponse>
Lists tags for one health check or hosted zone.
For information about using tags for cost allocation, see Using Cost Allocation Tags in the Billing and Cost Management User Guide.
listTagsForResources(_:logger:on:)
public func listTagsForResources(_ input: ListTagsForResourcesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListTagsForResourcesResponse>
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 Billing and Cost Management User Guide.
listTrafficPolicies(_:logger:on:)
public func listTrafficPolicies(_ input: ListTrafficPoliciesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListTrafficPoliciesResponse>
Gets information about the latest version for every traffic policy that is associated with the current Amazon Web Services account. Policies are listed in the order that they were created in.
<p>For information about how of deleting a traffic policy affects the response from <code>ListTrafficPolicies</code>, see
<a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_DeleteTrafficPolicy.html">DeleteTrafficPolicy</a>.
</p>
listTrafficPolicyInstances(_:logger:on:)
public func listTrafficPolicyInstances(_ input: ListTrafficPolicyInstancesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListTrafficPolicyInstancesResponse>
Gets information about the traffic policy instances that you created by using the current Amazon Web Services account.
After you submit an UpdateTrafficPolicyInstance
request, there's a brief delay while Amazon Route 53 creates the
resource record sets that are specified in the traffic policy definition. For more information, see the State
response element.
Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the
MaxItems
parameter to list them in groups of up to 100.
listTrafficPolicyInstancesByHostedZone(_:logger:on:)
public func listTrafficPolicyInstancesByHostedZone(_ input: ListTrafficPolicyInstancesByHostedZoneRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListTrafficPolicyInstancesByHostedZoneResponse>
Gets information about the traffic policy instances that you created in a specified hosted zone.
After you submit a CreateTrafficPolicyInstance
or an UpdateTrafficPolicyInstance
request, there's a
brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information,
see the State
response element.
Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the
MaxItems
parameter to list them in groups of up to 100.
listTrafficPolicyInstancesByPolicy(_:logger:on:)
public func listTrafficPolicyInstancesByPolicy(_ input: ListTrafficPolicyInstancesByPolicyRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListTrafficPolicyInstancesByPolicyResponse>
Gets information about the traffic policy instances that you created by using a specify traffic policy version.
After you submit a CreateTrafficPolicyInstance
or an UpdateTrafficPolicyInstance
request,
there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For
more information, see the State
response element.
Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the
MaxItems
parameter to list them in groups of up to 100.
listTrafficPolicyVersions(_:logger:on:)
public func listTrafficPolicyVersions(_ input: ListTrafficPolicyVersionsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListTrafficPolicyVersionsResponse>
Gets information about all of the versions for a specified traffic policy.
Traffic policy versions are listed in numerical order by VersionNumber
.
listVPCAssociationAuthorizations(_:logger:on:)
public func listVPCAssociationAuthorizations(_ input: ListVPCAssociationAuthorizationsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListVPCAssociationAuthorizationsResponse>
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.
testDNSAnswer(_:logger:on:)
public func testDNSAnswer(_ input: TestDNSAnswerRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<TestDNSAnswerResponse>
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.
This call only supports querying public hosted zones.
updateHealthCheck(_:logger:on:)
public func updateHealthCheck(_ input: UpdateHealthCheckRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateHealthCheckResponse>
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.
updateHostedZoneComment(_:logger:on:)
public func updateHostedZoneComment(_ input: UpdateHostedZoneCommentRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateHostedZoneCommentResponse>
Updates the comment for a specified hosted zone.
updateTrafficPolicyComment(_:logger:on:)
public func updateTrafficPolicyComment(_ input: UpdateTrafficPolicyCommentRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateTrafficPolicyCommentResponse>
Updates the comment for a specified traffic policy version.
updateTrafficPolicyInstance(_:logger:on:)
public func updateTrafficPolicyInstance(_ input: UpdateTrafficPolicyInstanceRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateTrafficPolicyInstanceResponse>
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. Route 53 performs the following operations:
-
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, 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.
-
Route 53 deletes the old group of resource record sets that are associated with the root resource record set name.
listHealthChecksPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func listHealthChecksPaginator( _ input: ListHealthChecksRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<ListHealthChecksRequest, ListHealthChecksResponse>
Retrieve a list of the health checks that are associated with the current Amazon Web Services account.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
listHostedZonesPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func listHostedZonesPaginator( _ input: ListHostedZonesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<ListHostedZonesRequest, ListHostedZonesResponse>
Retrieves a list of the public and private hosted zones that are associated with the current Amazon Web Services 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
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process onmaxitems
parameter to list them in groups of up to 100.
listQueryLoggingConfigsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func listQueryLoggingConfigsPaginator( _ input: ListQueryLoggingConfigsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<ListQueryLoggingConfigsRequest, ListQueryLoggingConfigsResponse>
Lists the configurations for DNS query logging that are associated with the current Amazon Web Services 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.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
listHealthChecksPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure onPage
for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result
.
public func listHealthChecksPaginator<Result>(
_ input: ListHealthChecksRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, ListHealthChecksResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Retrieve a list of the health checks that are associated with the current Amazon Web Services account.
Parameters:
- input: Input for request
- initialValue: The value to use as the initial accumulating value.
initialValue
is passed toonPage
the first time it is called.
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.
listHealthChecksPaginator(_:logger:on:onPage:)
Provide paginated results to closure onPage
.
public func listHealthChecksPaginator(
_ input: ListHealthChecksRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (ListHealthChecksResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.
listHostedZonesPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure onPage
for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result
.
public func listHostedZonesPaginator<Result>(
_ input: ListHostedZonesRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, ListHostedZonesResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Retrieves a list of the public and private hosted zones that are associated with the current Amazon Web Services 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.
Parameters:
- input: Input for request
- initialValue: The value to use as the initial accumulating value.
initialValue
is passed toonPage
the first time it is called.
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.
listHostedZonesPaginator(_:logger:on:onPage:)
Provide paginated results to closure onPage
.
public func listHostedZonesPaginator(
_ input: ListHostedZonesRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (ListHostedZonesResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.
listQueryLoggingConfigsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure onPage
for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result
.
public func listQueryLoggingConfigsPaginator<Result>(
_ input: ListQueryLoggingConfigsRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, ListQueryLoggingConfigsResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Lists the configurations for DNS query logging that are associated with the current Amazon Web Services 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.
Parameters:
- input: Input for request
- initialValue: The value to use as the initial accumulating value.
initialValue
is passed toonPage
the first time it is called.
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.
listQueryLoggingConfigsPaginator(_:logger:on:onPage:)
Provide paginated results to closure onPage
.
public func listQueryLoggingConfigsPaginator(
_ input: ListQueryLoggingConfigsRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (ListQueryLoggingConfigsResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.
waitUntilResourceRecordSetsChanged(_:maxWaitTime:logger:on:)
public func waitUntilResourceRecordSetsChanged(
_ input: GetChangeRequest,
maxWaitTime: TimeAmount? = nil,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil
) -> EventLoopFuture<Void>