Skip to content

ResolverRule

Source code in docs_src/capo_route53resolver/types/resolver_rule.py
class ResolverRule(TypedDict, closed=True):
    id: NotRequired["capo_route53resolver.types.resource_id.ResourceId"]
    """<p>The ID that Resolver assigned to the Resolver rule when you created it.</p>"""
    creator_request_id: NotRequired[
        "capo_route53resolver.types.creator_request_id.CreatorRequestId"
    ]
    """<p>A unique string that you specified when you created the Resolver rule. <code>CreatorRequestId</code> identifies the request and allows failed requests to be retried without the risk of running the operation twice. </p>"""
    arn: NotRequired["capo_route53resolver.types.arn.Arn"]
    """<p>The ARN (Amazon Resource Name) for the Resolver rule specified by <code>Id</code>.</p>"""
    domain_name: NotRequired["capo_route53resolver.types.domain_name.DomainName"]
    """<p>DNS queries for this domain name are forwarded to the IP addresses that are specified in <code>TargetIps</code>. 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).</p>"""
    status: NotRequired[
        "capo_route53resolver.types.resolver_rule_status.ResolverRuleStatus"
    ]
    """<p>A code that specifies the current status of the Resolver rule.</p>"""
    status_message: NotRequired[
        "capo_route53resolver.types.status_message.StatusMessage"
    ]
    """<p>A detailed description of the status of a Resolver rule.</p>"""
    rule_type: NotRequired["capo_route53resolver.types.rule_type_option.RuleTypeOption"]
    """<p>When you want to forward DNS queries for specified domain name to resolvers on your network, specify <code>FORWARD</code> or <code>DELEGATE</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).</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>"""
    name: NotRequired["capo_route53resolver.types.name.Name"]
    """<p>The name for the Resolver rule, which you specified when you created the Resolver rule.</p> <p>The name can be up to 64 characters long and can contain letters (a-z, A-Z), numbers (0-9), hyphens (-), underscores (_), and spaces. The name cannot consist of only numbers.</p>"""
    target_ips: NotRequired["capo_route53resolver.types.target_list.TargetList"]
    """<p>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. </p>"""
    resolver_endpoint_id: NotRequired[
        "capo_route53resolver.types.resource_id.ResourceId"
    ]
    """<p>The ID of the endpoint that the rule is associated with.</p>"""
    owner_id: NotRequired["capo_route53resolver.types.account_id.AccountId"]
    """<p>When a rule is shared with another Amazon Web Services account, the account ID of the account that the rule is shared with.</p>"""
    share_status: NotRequired["capo_route53resolver.types.share_status.ShareStatus"]
    """<p>Whether the rule 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.</p>"""
    creation_time: NotRequired[
        "capo_route53resolver.types.rfc3339_time_string.Rfc3339TimeString"
    ]
    """<p>The date and time that the Resolver rule was created, in Unix time format and Coordinated Universal Time (UTC).</p>"""
    modification_time: NotRequired[
        "capo_route53resolver.types.rfc3339_time_string.Rfc3339TimeString"
    ]
    """<p>The date and time that the Resolver rule was last updated, in Unix time format and Coordinated Universal Time (UTC).</p>"""
    delegation_record: NotRequired[
        "capo_route53resolver.types.delegation_record.DelegationRecord"
    ]
    """<p> DNS queries with delegation records that point to this domain name are forwarded to resolvers on your network. </p>"""

arn instance-attribute

arn: NotRequired[Arn]

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

creation_time instance-attribute

creation_time: NotRequired[Rfc3339TimeString]

The date and time that the Resolver rule was created, in Unix time format and Coordinated Universal Time (UTC).

creator_request_id instance-attribute

creator_request_id: NotRequired[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 running the operation twice.

delegation_record instance-attribute

delegation_record: NotRequired[DelegationRecord]

DNS queries with delegation records that point to this domain name are forwarded to resolvers on your network.

domain_name instance-attribute

domain_name: NotRequired[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).

id instance-attribute

id: NotRequired[ResourceId]

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

modification_time instance-attribute

modification_time: NotRequired[Rfc3339TimeString]

The date and time that the Resolver rule was last updated, in Unix time format and Coordinated Universal Time (UTC).

name instance-attribute

name: NotRequired[Name]

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

The name can be up to 64 characters long and can contain letters (a-z, A-Z), numbers (0-9), hyphens (-), underscores (_), and spaces. The name cannot consist of only numbers.

owner_id instance-attribute

owner_id: NotRequired[AccountId]

When a rule is shared with another Amazon Web Services account, the account ID of the account that the rule is shared with.

resolver_endpoint_id instance-attribute

resolver_endpoint_id: NotRequired[ResourceId]

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

rule_type instance-attribute

rule_type: NotRequired[RuleTypeOption]

When you want to forward DNS queries for specified domain name to resolvers on your network, specify FORWARD or DELEGATE. 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).

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.

share_status instance-attribute

share_status: NotRequired[ShareStatus]

Whether the rule 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.

status instance-attribute

status: NotRequired[ResolverRuleStatus]

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

status_message instance-attribute

status_message: NotRequired[StatusMessage]

A detailed description of the status of a Resolver rule.

target_ips instance-attribute

target_ips: NotRequired[TargetList]

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.