@aws-sdk/client-route53resolver
Description
AWS SDK for JavaScript Route53Resolver Client for Node.js, Browser and React Native.
When you create a VPC using Amazon VPC, you automatically get DNS resolution within the VPC
from Route 53 Resolver. By default, Resolver answers DNS queries for VPC domain names
such as domain names for EC2 instances or Elastic Load Balancing load balancers.
Resolver performs recursive lookups against public name servers for all other domain
names.
You can also configure DNS resolution between your VPC and your network over a Direct Connect or VPN connection:
Forward DNS queries from resolvers on your network to Route 53 Resolver
DNS resolvers on your network can forward DNS queries to Resolver in a specified VPC. This allows your DNS resolvers
to easily resolve domain names for Amazon Web Services resources such as EC2 instances or records in a Route 53 private hosted zone.
For more information, see
How DNS Resolvers
on Your Network Forward DNS Queries to Route 53 Resolver in the Amazon Route 53 Developer Guide.
Conditionally forward queries from a VPC to resolvers on your network
You can configure Resolver to forward queries that it receives from EC2 instances in your VPCs to DNS resolvers on your network.
To forward selected queries, you create Resolver rules that specify the domain names for the DNS queries that you want to forward
(such as example.com), and the IP addresses of the DNS resolvers on your network that you want to forward the queries to.
If a query matches multiple rules (example.com, acme.example.com), Resolver chooses the rule with the most specific match
(acme.example.com) and forwards the query to the IP addresses that you specified in that rule. For more information, see
How Route 53 Resolver
Forwards DNS Queries from Your VPCs to Your Network in the Amazon Route 53 Developer Guide.
Like Amazon VPC, Resolver is Regional. In each Region where you have VPCs, you can choose
whether to forward queries from your VPCs to your network (outbound queries), from your
network to your VPCs (inbound queries), or both.
Installing
To install this package, simply type add or install @aws-sdk/client-route53resolver
using your favorite package manager:
npm install @aws-sdk/client-route53resolver
yarn add @aws-sdk/client-route53resolver
pnpm add @aws-sdk/client-route53resolver
Getting Started
Import
The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the Route53ResolverClient
and
the commands you need, for example ListResolverRulesCommand
:
const { Route53ResolverClient, ListResolverRulesCommand } = require("@aws-sdk/client-route53resolver");
import { Route53ResolverClient, ListResolverRulesCommand } from "@aws-sdk/client-route53resolver";
Usage
To send a request, you:
- Initiate client with configuration (e.g. credentials, region).
- Initiate command with input parameters.
- Call
send
operation on client with command object as input. - If you are using a custom http handler, you may call
destroy()
to close open connections.
const client = new Route53ResolverClient({ region: "REGION" });
const params = {
};
const command = new ListResolverRulesCommand(params);
Async/await
We recommend using await
operator to wait for the promise returned by send operation as follows:
try {
const data = await client.send(command);
} catch (error) {
} finally {
}
Async-await is clean, concise, intuitive, easy to debug and has better error handling
as compared to using Promise chains or callbacks.
Promises
You can also use Promise chaining
to execute send operation.
client.send(command).then(
(data) => {
},
(error) => {
}
);
Promises can also be called using .catch()
and .finally()
as follows:
client
.send(command)
.then((data) => {
})
.catch((error) => {
})
.finally(() => {
});
Callbacks
We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.
client.send(command, (err, data) => {
});
v2 compatible style
The client can also send requests using v2 compatible style.
However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
on modular packages in AWS SDK for JavaScript
import * as AWS from "@aws-sdk/client-route53resolver";
const client = new AWS.Route53Resolver({ region: "REGION" });
try {
const data = await client.listResolverRules(params);
} catch (error) {
}
client
.listResolverRules(params)
.then((data) => {
})
.catch((error) => {
});
client.listResolverRules(params, (err, data) => {
});
Troubleshooting
When the service returns an exception, the error will include the exception information,
as well as response metadata (e.g. request id).
try {
const data = await client.send(command);
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
}
Getting Help
Please use these community resources for getting help.
We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
To test your universal JavaScript code in Node.js, browser and react-native environments,
visit our code samples repo.
Contributing
This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-route53resolver
package is updated.
To contribute to client you can check our generate clients scripts.
License
This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.
Client Commands (Operations List)
AssociateFirewallRuleGroup
Command API Reference / Input / Output
AssociateResolverEndpointIpAddress
Command API Reference / Input / Output
AssociateResolverQueryLogConfig
Command API Reference / Input / Output
AssociateResolverRule
Command API Reference / Input / Output
CreateFirewallDomainList
Command API Reference / Input / Output
CreateFirewallRule
Command API Reference / Input / Output
CreateFirewallRuleGroup
Command API Reference / Input / Output
CreateOutpostResolver
Command API Reference / Input / Output
CreateResolverEndpoint
Command API Reference / Input / Output
CreateResolverQueryLogConfig
Command API Reference / Input / Output
CreateResolverRule
Command API Reference / Input / Output
DeleteFirewallDomainList
Command API Reference / Input / Output
DeleteFirewallRule
Command API Reference / Input / Output
DeleteFirewallRuleGroup
Command API Reference / Input / Output
DeleteOutpostResolver
Command API Reference / Input / Output
DeleteResolverEndpoint
Command API Reference / Input / Output
DeleteResolverQueryLogConfig
Command API Reference / Input / Output
DeleteResolverRule
Command API Reference / Input / Output
DisassociateFirewallRuleGroup
Command API Reference / Input / Output
DisassociateResolverEndpointIpAddress
Command API Reference / Input / Output
DisassociateResolverQueryLogConfig
Command API Reference / Input / Output
DisassociateResolverRule
Command API Reference / Input / Output
GetFirewallConfig
Command API Reference / Input / Output
GetFirewallDomainList
Command API Reference / Input / Output
GetFirewallRuleGroup
Command API Reference / Input / Output
GetFirewallRuleGroupAssociation
Command API Reference / Input / Output
GetFirewallRuleGroupPolicy
Command API Reference / Input / Output
GetOutpostResolver
Command API Reference / Input / Output
GetResolverConfig
Command API Reference / Input / Output
GetResolverDnssecConfig
Command API Reference / Input / Output
GetResolverEndpoint
Command API Reference / Input / Output
GetResolverQueryLogConfig
Command API Reference / Input / Output
GetResolverQueryLogConfigAssociation
Command API Reference / Input / Output
GetResolverQueryLogConfigPolicy
Command API Reference / Input / Output
GetResolverRule
Command API Reference / Input / Output
GetResolverRuleAssociation
Command API Reference / Input / Output
GetResolverRulePolicy
Command API Reference / Input / Output
ImportFirewallDomains
Command API Reference / Input / Output
ListFirewallConfigs
Command API Reference / Input / Output
ListFirewallDomainLists
Command API Reference / Input / Output
ListFirewallDomains
Command API Reference / Input / Output
ListFirewallRuleGroupAssociations
Command API Reference / Input / Output
ListFirewallRuleGroups
Command API Reference / Input / Output
ListFirewallRules
Command API Reference / Input / Output
ListOutpostResolvers
Command API Reference / Input / Output
ListResolverConfigs
Command API Reference / Input / Output
ListResolverDnssecConfigs
Command API Reference / Input / Output
ListResolverEndpointIpAddresses
Command API Reference / Input / Output
ListResolverEndpoints
Command API Reference / Input / Output
ListResolverQueryLogConfigAssociations
Command API Reference / Input / Output
ListResolverQueryLogConfigs
Command API Reference / Input / Output
ListResolverRuleAssociations
Command API Reference / Input / Output
ListResolverRules
Command API Reference / Input / Output
ListTagsForResource
Command API Reference / Input / Output
PutFirewallRuleGroupPolicy
Command API Reference / Input / Output
PutResolverQueryLogConfigPolicy
Command API Reference / Input / Output
PutResolverRulePolicy
Command API Reference / Input / Output
TagResource
Command API Reference / Input / Output
UntagResource
Command API Reference / Input / Output
UpdateFirewallConfig
Command API Reference / Input / Output
UpdateFirewallDomains
Command API Reference / Input / Output
UpdateFirewallRule
Command API Reference / Input / Output
UpdateFirewallRuleGroupAssociation
Command API Reference / Input / Output
UpdateOutpostResolver
Command API Reference / Input / Output
UpdateResolverConfig
Command API Reference / Input / Output
UpdateResolverDnssecConfig
Command API Reference / Input / Output
UpdateResolverEndpoint
Command API Reference / Input / Output
UpdateResolverRule
Command API Reference / Input / Output