Amazon Route 53
API Reference

CreateResolverRule

For DNS queries that originate in your VPCs, specifies which resolver endpoint the queries pass through, one domain name that you want to forward to your network, and the IP addresses of the DNS resolvers in your network.

Request Syntax

{ "CreatorRequestId": "string", "DomainName": "string", "Name": "string", "ResolverEndpointId": "string", "RuleType": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "TargetIps": [ { "Ip": "string", "Port": number } ] }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

CreatorRequestId

A unique string that identifies the request and that allows failed requests to be retried without the risk of executing the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: Yes

DomainName

DNS queries for this domain name are forwarded to the IP addresses that you specify in TargetIps. If a query matches multiple resolver rules (example.com and www.example.com), outbound DNS queries are routed using the resolver rule that contains the most specific domain name (www.example.com).

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

Name

A friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console.

Type: String

Length Constraints: Maximum length of 64.

Pattern: (?!^[0-9]+$)([a-zA-Z0-9-_' ']+)

Required: No

ResolverEndpointId

The ID of the outbound resolver endpoint that you want to use to route DNS queries to the IP addresses that you specify in TargetIps.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: No

RuleType

When you want to forward DNS queries for specified domain name to resolvers on your network, specify FORWARD.

When you have a forwarding rule to forward DNS queries for a domain to your network and you want Resolver to process queries for a subdomain of that domain, specify SYSTEM.

For example, to forward DNS queries for example.com to resolvers on your network, you create a rule and specify FORWARD for RuleType. To then have Resolver process queries for apex.example.com, you create a rule and specify SYSTEM for RuleType.

Type: String

Valid Values: FORWARD | SYSTEM | RECURSIVE

Required: Yes

Tags

A list of the tag keys and values that you want to associate with the endpoint.

Type: Array of Tag objects

Required: No

TargetIps

The IPs that you want Resolver to forward DNS queries to. You can specify only IPv4 addresses. Separate IP addresses with a comma.

TargetIps is available only when the value of Rule type is FORWARD.

Type: Array of TargetAddress objects

Array Members: Minimum number of 1 item.

Required: No

Response Syntax

{ "ResolverRule": { "Arn": "string", "CreatorRequestId": "string", "DomainName": "string", "Id": "string", "Name": "string", "OwnerId": "string", "ResolverEndpointId": "string", "RuleType": "string", "ShareStatus": "string", "Status": "string", "StatusMessage": "string", "TargetIps": [ { "Ip": "string", "Port": number } ] } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ResolverRule

Information about the CreateResolverRule request, including the status of the request.

Type: ResolverRule object

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServiceErrorException

We encountered an unknown error. Try again in a few minutes.

HTTP Status Code: 400

InvalidParameterException

One or more parameters in this request are not valid.

HTTP Status Code: 400

InvalidRequestException

The request is invalid.

HTTP Status Code: 400

LimitExceededException

The request caused one or more limits to be exceeded.

HTTP Status Code: 400

ResourceExistsException

The resource that you tried to create already exists.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource doesn't exist.

HTTP Status Code: 400

ResourceUnavailableException

The specified resource isn't available.

HTTP Status Code: 400

ThrottlingException

The request was throttled. Try again in a few minutes.

HTTP Status Code: 400

Example

CreateResolverRule Example

Sample Request

POST / HTTP/1.1 Host: route53resolver.us-east-2.amazonaws.com Accept-Encoding: identity Content-Length: 170 X-Amz-Target: Route53Resolver.CreateResolverRule X-Amz-Date: 20181101T192331Z User-Agent: aws-cli/1.16.45 Python/2.7.10 Darwin/16.7.0 botocore/1.12.35 Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAJJ2SONIPEXAMPLE/20181101/us-east-2/route53resolver/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=[calculated-signature] { "CreatorRequestId": "999", "DomainName": "example.com", "Name": "MyRule", "ResolverEndpointId": "rslvr-out-fdc049932dexample", "RuleType": "FORWARD", "TargetIps": [ { "Ip": "192.0.2.6" } ] }

Sample Response

HTTP/1.1 200 OK Date: Thu, 01 Nov 2018 19:23:31 GMT Content-Type: application/x-amz-json-1.1 Content-Length: 464 x-amzn-RequestId: f51a7bc8-e9c6-4399-b408-086ecexample Connection: keep-alive { "ResolverRule": { "Arn": "arn:aws:route53resolver:us-east-2:123456789012:resolver-rule/rslvr-rr-5328a0899aexample", "CreatorRequestId": "999", "DomainName": "example.com", "Id": "rslvr-rr-5328a0899aexample", "Name": "MyRule", "OwnerId": "123456789012", "ResolverEndpointId": "rslvr-out-fdc049932dexample", "RuleType": "FORWARD", "ShareStatus": "NOT_SHARED", "Status": "COMPLETE", "StatusMessage": "[Trace id: 1-5bdb52b3-68082ffc336d18153example] Successfully created Resolver Rule.", "TargetIps": [ { "Ip": "192.0.2.6", "Port": 53 } ] } }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: