Amazon Route 53
API Reference

ResolverRule

For queries that originate in your VPC, detailed information about a resolver rule, which specifies how to route DNS queries out of the VPC. The ResolverRule parameter appears in the response to a CreateResolverRule, DeleteResolverRule, GetResolverRule, ListResolverRules, or UpdateResolverRule request.

Contents

Arn

The ARN (Amazon Resource Name) for the resolver rule specified by Id.

Type: String

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

Required: No

CreatorRequestId

A unique string that you specified when you created the resolver rule. CreatorRequestId identifies the request and allows failed requests to be retried without the risk of executing the operation twice.

Type: String

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

Required: No

DomainName

DNS queries for this domain name are forwarded to the IP addresses that are specified in TargetIps. If a query matches multiple resolver rules (example.com and www.example.com), the query is 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: No

Id

The ID that Resolver assigned to the resolver rule when you created it.

Type: String

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

Required: No

Name

The name for the resolver rule, which you specified when you created the resolver rule.

Type: String

Length Constraints: Maximum length of 64.

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

Required: No

OwnerId

When a rule is shared with another AWS account, the account ID of the account that the rule is shared with.

Type: String

Length Constraints: Minimum length of 12. Maximum length of 32.

Required: No

ResolverEndpointId

The ID of the endpoint that the rule is associated with.

Type: String

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

Required: No

RuleType

This value is always FORWARD. Other resolver rule types aren't supported.

Type: String

Valid Values: FORWARD | SYSTEM | RECURSIVE

Required: No

ShareStatus

Whether the rules is shared and, if so, whether the current account is sharing the rule with another account, or another account is sharing the rule with the current account.

Type: String

Valid Values: NOT_SHARED | SHARED_WITH_ME | SHARED_BY_ME

Required: No

Status

A code that specifies the current status of the resolver rule.

Type: String

Valid Values: COMPLETE | DELETING | UPDATING | FAILED

Required: No

StatusMessage

A detailed description of the status of a resolver rule.

Type: String

Length Constraints: Maximum length of 255.

Required: No

TargetIps

An array that contains the IP addresses and ports that an outbound endpoint forwards DNS queries to. Typically, these are the IP addresses of DNS resolvers on your network. Specify IPv4 addresses. IPv6 is not supported.

Type: Array of TargetAddress objects

Array Members: Minimum number of 1 item.

Required: No

See Also

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

On this page: