- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
Route53Client
Amazon Route 53 is a highly available and scalable Domain Name System (DNS) web service.
You can use Route 53 to:
-
Register domain names.
For more information, see How domain registration works .
-
Route internet traffic to the resources for your domain
For more information, see How internet traffic is routed to your website or web application .
-
Check the health of your resources.
For more information, see How Route 53 checks the health of your resources .
Installation
npm install @aws-sdk/client-route-53
yarn add @aws-sdk/client-route-53
pnpm add @aws-sdk/client-route-53
Route53Client Operations
Command | Summary |
---|
Command | Summary |
---|---|
ActivateKeySigningKeyCommand | Activates a key-signing key (KSK) so that it can be used for signing by DNSSEC. This operation changes the KSK status to |
AssociateVPCWithHostedZoneCommand | 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 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:
For more information, see Access Management in the Amazon Web Services General Reference. |
ChangeCidrCollectionCommand | Creates, changes, or deletes CIDR blocks within a collection. Contains authoritative IP information mapping blocks to one or multiple locations. A change request can update multiple locations in a collection at a time, which is helpful if you want to move one or more CIDR blocks from one location to another in one transaction, without downtime. Limits The max number of CIDR blocks included in the request is 1000. As a result, big updates require multiple API calls. PUT and DELETE_IF_EXISTS Use
|
ChangeResourceRecordSetsCommand | 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 Deleting Resource Record Sets To delete a resource record set, you must specify all the same values that you specified when you created it. Change Batches and Transactional Changes The request body must include a document with a For example, suppose a change batch request contains two changes: it deletes the If you try to delete the same resource record set more than once in a single change batch, Route 53 returns an Traffic Flow 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 Using Traffic Flow to Route DNS Traffic in the Amazon Route 53 Developer Guide. Create, Delete, and Upsert Use
Syntaxes for Creating, Updating, and Deleting Resource Record Sets 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. For an example for each type of resource record set, see "Examples." 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 Change Propagation to Route 53 DNS Servers When you submit a Limits on ChangeResourceRecordSets Requests For information about the limits on a |
ChangeTagsForResourceCommand | 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. |
CreateCidrCollectionCommand | Creates a CIDR collection in the current Amazon Web Services account. |
CreateHealthCheckCommand | Creates a new health check. For information about adding health checks to resource record sets, see 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 a 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:
|
CreateHostedZoneCommand | 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:
When you submit a The 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:
For more information, see Access Management in the Amazon Web Services General Reference. |
CreateKeySigningKeyCommand | Creates a new key-signing key (KSK) associated with a hosted zone. You can only have two KSKs per hosted zone. |
CreateQueryLoggingConfigCommand | 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:
|
CreateReusableDelegationSetCommand | 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 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 . 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:
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:
|
CreateTrafficPolicyCommand | 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). |
CreateTrafficPolicyInstanceCommand | Creates resource record sets in a specified hosted zone based on the settings in a specified traffic policy version. In addition, After you submit an |
CreateTrafficPolicyVersionCommand | 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. |
CreateVPCAssociationAuthorizationCommand | Authorizes the Amazon Web Services account that created a specified VPC to submit an 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. |
DeactivateKeySigningKeyCommand | Deactivates a key-signing key (KSK) so that it will not be used for signing by DNSSEC. This operation changes the KSK status to |
DeleteCidrCollectionCommand | Deletes a CIDR collection in the current Amazon Web Services account. The collection must be empty before it can be deleted. |
DeleteHealthCheckCommand | 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. 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 |
DeleteHostedZoneCommand | Deletes a hosted zone. If the hosted zone was created by another service, such as Cloud Map, see Deleting Public Hosted Zones That Were Created by Another Service in the Amazon Route 53 Developer Guide for information about how to delete it. (The process is the same for public and private hosted zones that were created by another service.) 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. 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. 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 UpdateDomainNameservers 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." 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 To verify that the hosted zone has been deleted, do one of the following:
|
DeleteKeySigningKeyCommand | 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 |
DeleteQueryLoggingConfigCommand | 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. For more information about DNS query logs, see CreateQueryLoggingConfig . |
DeleteReusableDelegationSetCommand | 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. |
DeleteTrafficPolicyCommand | 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:
|
DeleteTrafficPolicyInstanceCommand | 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. |
DeleteVPCAssociationAuthorizationCommand | Removes authorization to submit an 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, |
DisableHostedZoneDNSSECCommand | 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. |
DisassociateVPCFromHostedZoneCommand | Disassociates an Amazon Virtual Private Cloud (Amazon VPC) from an Amazon Route 53 private hosted zone. Note the following:
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:
For more information, see Access Management in the Amazon Web Services General Reference. |
EnableHostedZoneDNSSECCommand | Enables DNSSEC signing in a specific hosted zone. |
GetAccountLimitCommand | 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. |
GetChangeCommand | Returns the current status of a change batch request. The status is one of the following values:
|
GetCheckerIpRangesCommand | Route 53 does not perform authorization for this API because it retrieves information that is already available to the public. |
GetDNSSECCommand | Returns information about DNSSEC for a specific hosted zone, including the key-signing keys (KSKs) in the hosted zone. |
GetGeoLocationCommand | 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. Use the following syntax to determine whether a continent is supported for geolocation: Use the following syntax to determine whether a country is supported for geolocation: Use the following syntax to determine whether a subdivision of a country is supported for geolocation: |
GetHealthCheckCommand | Gets information about a specified health check. |
GetHealthCheckCountCommand | Retrieves the number of health checks that are associated with the current Amazon Web Services account. |
GetHealthCheckLastFailureReasonCommand | Gets the reason that a specified health check failed most recently. |
GetHealthCheckStatusCommand | 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. |
GetHostedZoneCommand | Gets information about a specified hosted zone including the four name servers assigned to the hosted zone. |
GetHostedZoneCountCommand | Retrieves the number of hosted zones that are associated with the current Amazon Web Services account. |
GetHostedZoneLimitCommand | 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 . |
GetQueryLoggingConfigCommand | Gets information about a specified configuration for DNS query logging. For more information about DNS query logs, see CreateQueryLoggingConfig and Logging DNS Queries . |
GetReusableDelegationSetCommand | Retrieves information about a specified reusable delegation set, including the four name servers that are assigned to the delegation set. |
GetReusableDelegationSetLimitCommand | 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 . |
GetTrafficPolicyCommand | Gets information about a specific traffic policy version. For information about how of deleting a traffic policy affects the response from |
GetTrafficPolicyInstanceCommand | Gets information about a specified traffic policy instance. Use In the Route 53 console, traffic policy instances are known as policy records. |
GetTrafficPolicyInstanceCountCommand | Gets the number of traffic policy instances that are associated with the current Amazon Web Services account. |
ListCidrBlocksCommand | Returns a paginated list of location objects and their CIDR blocks. |
ListCidrCollectionsCommand | Returns a paginated list of CIDR collections in the Amazon Web Services account (metadata only). |
ListCidrLocationsCommand | Returns a paginated list of CIDR locations for the given collection (metadata only, does not include CIDR blocks). |
ListGeoLocationsCommand | 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. |
ListHealthChecksCommand | Retrieve a list of the health checks that are associated with the current Amazon Web Services account. |
ListHostedZonesByNameCommand | Retrieves a list of your hosted zones in lexicographic order. The response includes a Note the trailing dot, which can change the sort order in some circumstances. If the domain name includes escape characters or Punycode, 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. Route 53 returns up to 100 items in each response. If you have a lot of hosted zones, use the
|
ListHostedZonesByVPCCommand | 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
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:
For more information, see Access Management in the Amazon Web Services General Reference. |
ListHostedZonesCommand | Retrieves a list of the public and private hosted zones that are associated with the current Amazon Web Services account. The response includes a Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of hosted zones, you can use the |
ListQueryLoggingConfigsCommand | 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. |
ListResourceRecordSetsCommand | Lists the resource record sets in a specified hosted zone. Sort order Note the trailing dot, which can change the sort order when the record name contains characters that appear before When multiple records have the same DNS name, Specifying where to start listing records You can use the name and type elements to specify the resource record set that the list begins with:
Resource record sets that are PENDING This action returns the most current version of the records. This includes records that are Changing resource record sets 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 Displaying the next page of results If a |
ListReusableDelegationSetsCommand | Retrieves a list of the reusable delegation sets that are associated with the current Amazon Web Services account. |
ListTagsForResourceCommand | 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. |
ListTagsForResourcesCommand | 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. |
ListTrafficPoliciesCommand | 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. For information about how of deleting a traffic policy affects the response from |
ListTrafficPolicyInstancesByHostedZoneCommand | Gets information about the traffic policy instances that you created in a specified hosted zone. After you submit a Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the |
ListTrafficPolicyInstancesByPolicyCommand | Gets information about the traffic policy instances that you created by using a specify traffic policy version. After you submit a Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the |
ListTrafficPolicyInstancesCommand | Gets information about the traffic policy instances that you created by using the current Amazon Web Services account. After you submit an Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the |
ListTrafficPolicyVersionsCommand | Gets information about all of the versions for a specified traffic policy. Traffic policy versions are listed in numerical order by |
ListVPCAssociationAuthorizationsCommand | 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 The response includes a |
TestDNSAnswerCommand | 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. The |
UpdateHealthCheckCommand | 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. |
UpdateHostedZoneCommentCommand | Updates the comment for a specified hosted zone. |
UpdateTrafficPolicyCommentCommand | Updates the comment for a specified traffic policy version. |
UpdateTrafficPolicyInstanceCommand | After you submit a 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:
|
Route53Client Configuration
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
defaultsMode Optional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefix Optional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensions Optional | RuntimeExtension[] | Optional extensions |
logger Optional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttempts Optional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profile Optional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
region Optional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandler Optional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryMode Optional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpoint Optional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpoint Optional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: Route53ClientConfig