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

Class: Aws::Route53Resolver::Types::ResolverRule

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

Overview

For queries that originate in your VPC, detailed information about a Resolver rule, which specifies how to route DNS queries out of the VPC. The ResolverRule parameter appears in the response to a CreateResolverRule, DeleteResolverRule, GetResolverRule, ListResolverRules, or UpdateResolverRule request.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

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

Returns:

  • (String) —

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

#creation_time ⇒ String

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

Returns:

  • (String) —

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

#creator_request_id ⇒ String

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 executing the operation twice.

Returns:

  • (String) —

    A unique string that you specified when you created the Resolver rule.

#domain_name ⇒ String

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

Returns:

  • (String) —

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

#id ⇒ String

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

Returns:

  • (String) —

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

#modification_time ⇒ String

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

Returns:

  • (String) —

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

#name ⇒ String

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

Returns:

  • (String) —

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

#owner_id ⇒ String

When a rule is shared with another AWS account, the account ID of the account that the rule is shared with.

Returns:

  • (String) —

    When a rule is shared with another AWS account, the account ID of the account that the rule is shared with.

#resolver_endpoint_id ⇒ String

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

Returns:

  • (String) —

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

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

#share_status ⇒ String

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

Possible values:

  • NOT_SHARED
  • SHARED_WITH_ME
  • SHARED_BY_ME

Returns:

  • (String) —

    Whether the rules 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 ⇒ String

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

Possible values:

  • COMPLETE
  • DELETING
  • UPDATING
  • FAILED

Returns:

  • (String) —

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

#status_message ⇒ String

A detailed description of the status of a Resolver rule.

Returns:

  • (String) —

    A detailed description of the status of a Resolver rule.

#target_ips ⇒ Array<Types::TargetAddress>

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. Specify IPv4 addresses. IPv6 is not supported.

Returns:

  • (Array<Types::TargetAddress>) —

    An array that contains the IP addresses and ports that an outbound endpoint forwards DNS queries to.