You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Route53Resolver::Types::CreateResolverRuleRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateResolverRuleRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  creator_request_id: "CreatorRequestId", # required
  name: "Name",
  rule_type: "FORWARD", # required, accepts FORWARD, SYSTEM, RECURSIVE
  domain_name: "DomainName", # required
  target_ips: [
    {
      ip: "Ip", # required
      port: 1,
    },
  ],
  resolver_endpoint_id: "ResourceId",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#creator_request_id ⇒ String

A unique string that identifies the request and that allows failed requests to be retried without the risk of executing the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.

Returns:

  • (String) —

    A unique string that identifies the request and that allows failed requests to be retried without the risk of executing the operation twice.

#domain_name ⇒ String

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

Returns:

  • (String) —

    DNS queries for this domain name are forwarded to the IP addresses that you specify in TargetIps.

#name ⇒ String

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

Returns:

  • (String) —

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

#resolver_endpoint_id ⇒ String

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.

Returns:

  • (String) —

    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.

#rule_type ⇒ String

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.

Possible values:

  • FORWARD
  • SYSTEM
  • RECURSIVE

Returns:

  • (String) —

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

#tags ⇒ Array<Types::Tag>

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

Returns:

  • (Array<Types::Tag>) —

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

#target_ips ⇒ Array<Types::TargetAddress>

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

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

Returns: