Skip to content

Create Resolver Rule

route53resolver_create_resolver_rule R Documentation

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

Description

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.

Usage

route53resolver_create_resolver_rule(CreatorRequestId, Name, RuleType,
  DomainName, TargetIps, ResolverEndpointId, Tags)

Arguments

CreatorRequestId

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

Name

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

RuleType

[required] 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.

Currently, only Resolver can create rules that have a value of RECURSIVE for RuleType.

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).

TargetIps

The IPs that you want Resolver to forward DNS queries to. You can specify either Ipv4 or Ipv6 addresses but not both in the same rule. Separate IP addresses with a space.

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

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.

Tags

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

Value

A list with the following syntax:

list(
  ResolverRule = list(
    Id = "string",
    CreatorRequestId = "string",
    Arn = "string",
    DomainName = "string",
    Status = "COMPLETE"|"DELETING"|"UPDATING"|"FAILED",
    StatusMessage = "string",
    RuleType = "FORWARD"|"SYSTEM"|"RECURSIVE",
    Name = "string",
    TargetIps = list(
      list(
        Ip = "string",
        Port = 123,
        Ipv6 = "string",
        Protocol = "DoH"|"Do53"|"DoH-FIPS"
      )
    ),
    ResolverEndpointId = "string",
    OwnerId = "string",
    ShareStatus = "NOT_SHARED"|"SHARED_WITH_ME"|"SHARED_BY_ME",
    CreationTime = "string",
    ModificationTime = "string"
  )
)

Request syntax

svc$create_resolver_rule(
  CreatorRequestId = "string",
  Name = "string",
  RuleType = "FORWARD"|"SYSTEM"|"RECURSIVE",
  DomainName = "string",
  TargetIps = list(
    list(
      Ip = "string",
      Port = 123,
      Ipv6 = "string",
      Protocol = "DoH"|"Do53"|"DoH-FIPS"
    )
  ),
  ResolverEndpointId = "string",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)