Skip to content

create_resolver_rule

create_resolver_rule(
    creator_request_id: CreatorRequestId,
    rule_type: RuleTypeOption,
    *,
    config_overrides: Optional[Route53ResolverClientConfig] = None,
    name: Optional[Name] = None,
    domain_name: Optional[DomainName] = None,
    target_ips: Optional[TargetList] = None,
    resolver_endpoint_id: Optional[ResourceId] = None,
    tags: Optional[TagList] = None,
    delegation_record: Optional[DelegationRecord] = None,
) -> CreateResolverRuleResponse

For DNS queries that originate in your VPCs, specifies which Resolver endpoint the queries pass through, one domain name that you want to forward to your network, and the IP addresses of the DNS resolvers in your network.

Parameters:

  • creator_request_id (CreatorRequestId) –

    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 (Optional[Name], default: None ) –

    A friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console.

    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.

  • rule_type (RuleTypeOption) –

    When you want to forward DNS queries for specified domain name to resolvers on your network, specify FORWARD or DELEGATE.

    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.

  • domain_name (Optional[DomainName], default: None ) –

    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).

  • target_ips (Optional[TargetList], default: None ) –

    The IPs that you want Resolver to forward DNS queries to. You can specify either Ipv4 or Ipv6 addresses but not both in the same rule. Separate IP addresses with a space.

    TargetIps is available only when the value of Rule type is FORWARD. You should not provide TargetIps when the Rule type is DELEGATE.

    when creating a DELEGATE rule, you must not provide the TargetIps parameter. If you provide the TargetIps, you may receive an ERROR message similar to "Delegate resolver rules need to specify a nameserver name". This error means you should not provide TargetIps.

  • resolver_endpoint_id (Optional[ResourceId], default: None ) –

    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 (Optional[TagList], default: None ) –

    A list of the tag keys and values that you want to associate with the endpoint.

  • delegation_record (Optional[DelegationRecord], default: None ) –

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

Raises:

Source code in docs_src/capo_route53resolver/_services/route53_resolver.py
def create_resolver_rule(
    self,
    creator_request_id: "capo_route53resolver.types.creator_request_id.CreatorRequestId",
    rule_type: "capo_route53resolver.types.rule_type_option.RuleTypeOption",
    *,
    config_overrides: Optional[Route53ResolverClientConfig] = None,
    name: Optional["capo_route53resolver.types.name.Name"] = None,
    domain_name: Optional[
        "capo_route53resolver.types.domain_name.DomainName"
    ] = None,
    target_ips: Optional[
        "capo_route53resolver.types.target_list.TargetList"
    ] = None,
    resolver_endpoint_id: Optional[
        "capo_route53resolver.types.resource_id.ResourceId"
    ] = None,
    tags: Optional["capo_route53resolver.types.tag_list.TagList"] = None,
    delegation_record: Optional[
        "capo_route53resolver.types.delegation_record.DelegationRecord"
    ] = None,
) -> "capo_route53resolver.types.create_resolver_rule_response.CreateResolverRuleResponse":
    """<p>For DNS queries that originate in your VPCs, specifies which Resolver endpoint the queries pass through, one domain name that you want to forward to your network, and the IP addresses of the DNS resolvers in your network.</p>

    Args:
        creator_request_id: <p>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. </p>
        name: <p>A friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console.</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>
        rule_type: <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>.</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>
        domain_name: <p>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).</p>
        target_ips: <p>The IPs that you want Resolver to forward DNS queries to. You can specify either Ipv4 or Ipv6 addresses but not both in the same rule. 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>. You should not provide TargetIps when the Rule type is <code>DELEGATE</code>.</p> <note> <p>when creating a DELEGATE rule, you must not provide the <code>TargetIps</code> parameter. If you provide the <code>TargetIps</code>, you may receive an ERROR message similar to "Delegate resolver rules need to specify a nameserver name". This error means you should not provide <code>TargetIps</code>.</p> </note>
        resolver_endpoint_id: <p>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>.</p>
        tags: <p>A list of the tag keys and values that you want to associate with the endpoint.</p>
        delegation_record: <p> DNS queries with the delegation records that match this domain name are forwarded to the resolvers on your network. </p>

    Raises:
        capo_route53resolver.errors.access_denied_exception.AccessDeniedException: <p>The current account doesn't have the IAM permissions required to perform the specified Resolver operation.</p> <p>This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs.</p>
        capo_route53resolver.errors.internal_service_error_exception.InternalServiceErrorException: <p>We encountered an unknown error. Try again in a few minutes.</p>
        capo_route53resolver.errors.invalid_parameter_exception.InvalidParameterException: <p>One or more parameters in this request are not valid.</p>
        capo_route53resolver.errors.invalid_request_exception.InvalidRequestException: <p>The request is invalid.</p>
        capo_route53resolver.errors.limit_exceeded_exception.LimitExceededException: <p>The request caused one or more limits to be exceeded.</p>
        capo_route53resolver.errors.resource_exists_exception.ResourceExistsException: <p>The resource that you tried to create already exists.</p>
        capo_route53resolver.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource doesn't exist.</p>
        capo_route53resolver.errors.resource_unavailable_exception.ResourceUnavailableException: <p>The specified resource isn't available.</p>
        capo_route53resolver.errors.throttling_exception.ThrottlingException: <p>The request was throttled. Try again in a few minutes.</p>
        capo_route53resolver.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_route53resolver.types.create_resolver_rule_request.CreateResolverRuleRequest]",
    ) -> OperationResponse[
        "capo_route53resolver.types.create_resolver_rule_response.CreateResolverRuleResponse"
    ]:
        import capo_route53resolver._operations.route53_resolver.create_resolver_rule

        output, http_response = (
            capo_route53resolver._operations.route53_resolver.create_resolver_rule.create_resolver_rule(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateResolverRule")
    )
    input_: capo_route53resolver.types.create_resolver_rule_request.CreateResolverRuleRequest = {
        "creator_request_id": creator_request_id,
        "rule_type": rule_type,
    }
    if name is not None:
        input_["name"] = name
    if domain_name is not None:
        input_["domain_name"] = domain_name
    if target_ips is not None:
        input_["target_ips"] = target_ips
    if resolver_endpoint_id is not None:
        input_["resolver_endpoint_id"] = resolver_endpoint_id
    if tags is not None:
        input_["tags"] = tags
    if delegation_record is not None:
        input_["delegation_record"] = delegation_record

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output