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

Inherits:

Struct

• Object
• Struct
• Aws::Route53Resolver::Types::ResolverRule

Includes:

Structure

Defined in:

lib/aws-sdk-route53resolver/types.rb

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][5

request.

[1]: docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_CreateResolverRule.html [2]: docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_DeleteResolverRule.html [3]: docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverRule.html [4]: docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRules.html [5]: docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_UpdateResolverRule.html

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ 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).

• #creator_request_id ⇒ String

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

• #delegation_record ⇒ String

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

• #domain_name ⇒ 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.

• #modification_time ⇒ 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.

• #owner_id ⇒ String

  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 ⇒ 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` or `DELEGATE`.

• #share_status ⇒ String

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

• #target_ips ⇒ Array<Types::TargetAddress>

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

Instance Attribute Details

#arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-route53resolver/types.rb', line 5339

class ResolverRule < Struct.new(
  :id,
  :creator_request_id,
  :arn,
  :domain_name,
  :status,
  :status_message,
  :rule_type,
  :name,
  :target_ips,
  :resolver_endpoint_id,
  :owner_id,
  :share_status,
  :creation_time,
  :modification_time,
  :delegation_record)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-route53resolver/types.rb', line 5339

class ResolverRule < Struct.new(
  :id,
  :creator_request_id,
  :arn,
  :domain_name,
  :status,
  :status_message,
  :rule_type,
  :name,
  :target_ips,
  :resolver_endpoint_id,
  :owner_id,
  :share_status,
  :creation_time,
  :modification_time,
  :delegation_record)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

• (String)

# File 'lib/aws-sdk-route53resolver/types.rb', line 5339

class ResolverRule < Struct.new(
  :id,
  :creator_request_id,
  :arn,
  :domain_name,
  :status,
  :status_message,
  :rule_type,
  :name,
  :target_ips,
  :resolver_endpoint_id,
  :owner_id,
  :share_status,
  :creation_time,
  :modification_time,
  :delegation_record)
  SENSITIVE = []
  include Aws::Structure
end

#delegation_record ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-route53resolver/types.rb', line 5339

class ResolverRule < Struct.new(
  :id,
  :creator_request_id,
  :arn,
  :domain_name,
  :status,
  :status_message,
  :rule_type,
  :name,
  :target_ips,
  :resolver_endpoint_id,
  :owner_id,
  :share_status,
  :creation_time,
  :modification_time,
  :delegation_record)
  SENSITIVE = []
  include Aws::Structure
end

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

# File 'lib/aws-sdk-route53resolver/types.rb', line 5339

class ResolverRule < Struct.new(
  :id,
  :creator_request_id,
  :arn,
  :domain_name,
  :status,
  :status_message,
  :rule_type,
  :name,
  :target_ips,
  :resolver_endpoint_id,
  :owner_id,
  :share_status,
  :creation_time,
  :modification_time,
  :delegation_record)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-route53resolver/types.rb', line 5339

class ResolverRule < Struct.new(
  :id,
  :creator_request_id,
  :arn,
  :domain_name,
  :status,
  :status_message,
  :rule_type,
  :name,
  :target_ips,
  :resolver_endpoint_id,
  :owner_id,
  :share_status,
  :creation_time,
  :modification_time,
  :delegation_record)
  SENSITIVE = []
  include Aws::Structure
end

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

# File 'lib/aws-sdk-route53resolver/types.rb', line 5339

class ResolverRule < Struct.new(
  :id,
  :creator_request_id,
  :arn,
  :domain_name,
  :status,
  :status_message,
  :rule_type,
  :name,
  :target_ips,
  :resolver_endpoint_id,
  :owner_id,
  :share_status,
  :creation_time,
  :modification_time,
  :delegation_record)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-route53resolver/types.rb', line 5339

class ResolverRule < Struct.new(
  :id,
  :creator_request_id,
  :arn,
  :domain_name,
  :status,
  :status_message,
  :rule_type,
  :name,
  :target_ips,
  :resolver_endpoint_id,
  :owner_id,
  :share_status,
  :creation_time,
  :modification_time,
  :delegation_record)
  SENSITIVE = []
  include Aws::Structure
end

#owner_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-route53resolver/types.rb', line 5339

class ResolverRule < Struct.new(
  :id,
  :creator_request_id,
  :arn,
  :domain_name,
  :status,
  :status_message,
  :rule_type,
  :name,
  :target_ips,
  :resolver_endpoint_id,
  :owner_id,
  :share_status,
  :creation_time,
  :modification_time,
  :delegation_record)
  SENSITIVE = []
  include Aws::Structure
end

#resolver_endpoint_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-route53resolver/types.rb', line 5339

class ResolverRule < Struct.new(
  :id,
  :creator_request_id,
  :arn,
  :domain_name,
  :status,
  :status_message,
  :rule_type,
  :name,
  :target_ips,
  :resolver_endpoint_id,
  :owner_id,
  :share_status,
  :creation_time,
  :modification_time,
  :delegation_record)
  SENSITIVE = []
  include Aws::Structure
end

#rule_type ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-route53resolver/types.rb', line 5339

class ResolverRule < Struct.new(
  :id,
  :creator_request_id,
  :arn,
  :domain_name,
  :status,
  :status_message,
  :rule_type,
  :name,
  :target_ips,
  :resolver_endpoint_id,
  :owner_id,
  :share_status,
  :creation_time,
  :modification_time,
  :delegation_record)
  SENSITIVE = []
  include Aws::Structure
end

#share_status ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-route53resolver/types.rb', line 5339

class ResolverRule < Struct.new(
  :id,
  :creator_request_id,
  :arn,
  :domain_name,
  :status,
  :status_message,
  :rule_type,
  :name,
  :target_ips,
  :resolver_endpoint_id,
  :owner_id,
  :share_status,
  :creation_time,
  :modification_time,
  :delegation_record)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-route53resolver/types.rb', line 5339

class ResolverRule < Struct.new(
  :id,
  :creator_request_id,
  :arn,
  :domain_name,
  :status,
  :status_message,
  :rule_type,
  :name,
  :target_ips,
  :resolver_endpoint_id,
  :owner_id,
  :share_status,
  :creation_time,
  :modification_time,
  :delegation_record)
  SENSITIVE = []
  include Aws::Structure
end

#status_message ⇒ String

A detailed description of the status of a Resolver rule.

Returns:

• (String)

# File 'lib/aws-sdk-route53resolver/types.rb', line 5339

class ResolverRule < Struct.new(
  :id,
  :creator_request_id,
  :arn,
  :domain_name,
  :status,
  :status_message,
  :rule_type,
  :name,
  :target_ips,
  :resolver_endpoint_id,
  :owner_id,
  :share_status,
  :creation_time,
  :modification_time,
  :delegation_record)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

• (Array<Types::TargetAddress>)

# File 'lib/aws-sdk-route53resolver/types.rb', line 5339

class ResolverRule < Struct.new(
  :id,
  :creator_request_id,
  :arn,
  :domain_name,
  :status,
  :status_message,
  :rule_type,
  :name,
  :target_ips,
  :resolver_endpoint_id,
  :owner_id,
  :share_status,
  :creation_time,
  :modification_time,
  :delegation_record)
  SENSITIVE = []
  include Aws::Structure
end