Amazon Route 53 Resolver · Schema
CreateResolverRuleRequest
CreateResolverRuleRequest schema from openapi
DNSHybrid CloudNetworking
Properties
| Name | Type | Description |
|---|---|---|
| CreatorRequestId | object | |
| Name | object | |
| RuleType | object | |
| DomainName | object | |
| TargetIps | object | |
| ResolverEndpointId | object | |
| Tags | object |
JSON Schema
{
"$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. <code>CreatorRequestId</code> 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": "<p>When you want to forward DNS queries for specified domain name to resolvers on your network, specify <code>FORWARD</code>.</p> <p>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 <code>SYSTEM</code>.</p> <p>For example, to forward DNS queries for example.com to resolvers on your network, you create a rule and specify <code>FORWARD</code> for <code>RuleType</code>. To then have Resolver process queries for apex.example.com, you create a rule and specify <code>SYSTEM</code> for <code>RuleType</code>.</p> <p>Currently, only Resolver can create rules that have a value of <code>RECURSIVE</code> for <code>RuleType</code>.</p>"
}
]
},
"DomainName": {
"allOf": [
{
"$ref": "#/components/schemas/DomainName"
},
{
"description": "DNS queries for this domain name are forwarded to the IP addresses that you specify in <code>TargetIps</code>. 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": "<p>The IPs that you want Resolver to forward DNS queries to. You can specify only IPv4 addresses. Separate IP addresses with a space.</p> <p> <code>TargetIps</code> is available only when the value of <code>Rule type</code> is <code>FORWARD</code>.</p>"
}
]
},
"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 <code>TargetIps</code>."
}
]
},
"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"
]
}