{ "$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-create-resolver-rule-request-schema.json", "title": "CreateResolverRuleRequest", "description": "CreateResolverRuleRequest schema from openapi", "type": "object", "properties": { "CreatorRequestId": { "allOf": [ { "$ref": "#/components/schemas/CreatorRequestId" }, { "description": "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": { "allOf": [ { "$ref": "#/components/schemas/Name" }, { "description": "A friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console." } ] }, "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.

" } ] }, "DomainName": { "allOf": [ { "$ref": "#/components/schemas/DomainName" }, { "description": "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": { "allOf": [ { "$ref": "#/components/schemas/TargetList" }, { "description": "

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

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

" } ] }, "ResolverEndpointId": { "allOf": [ { "$ref": "#/components/schemas/ResourceId" }, { "description": "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": { "allOf": [ { "$ref": "#/components/schemas/TagList" }, { "description": "A list of the tag keys and values that you want to associate with the endpoint." } ] } }, "required": [ "CreatorRequestId", "RuleType", "DomainName" ] }