{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-route53-resolver/refs/heads/main/json-schema/amazon-route53-resolver-openapi-resolver-rule-schema.json",
"title": "ResolverRule",
"description": "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.",
"type": "object",
"properties": {
"Id": {
"allOf": [
{
"$ref": "#/components/schemas/ResourceId"
},
{
"description": "The ID that Resolver assigned to the Resolver rule when you created it."
}
]
},
"CreatorRequestId": {
"allOf": [
{
"$ref": "#/components/schemas/CreatorRequestId"
},
{
"description": "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 running the operation twice. "
}
]
},
"Arn": {
"allOf": [
{
"$ref": "#/components/schemas/Arn"
},
{
"description": "The ARN (Amazon Resource Name) for the Resolver rule specified by Id."
}
]
},
"DomainName": {
"allOf": [
{
"$ref": "#/components/schemas/DomainName"
},
{
"description": "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)."
}
]
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/ResolverRuleStatus"
},
{
"description": "A code that specifies the current status of the Resolver rule."
}
]
},
"StatusMessage": {
"allOf": [
{
"$ref": "#/components/schemas/StatusMessage"
},
{
"description": "A detailed description of the status of a Resolver rule."
}
]
},
"RuleType": {
"allOf": [
{
"$ref": "#/components/schemas/RuleTypeOption"
},
{
"description": "
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.