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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-route53resolver/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 request.

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

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

Returns:

  • (String)


1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 1322

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)
  include Aws::Structure
end

#creator_request_idString

A unique string that you specified when you created the resolver rule. CreatorRequestIdidentifies the request and allows failed requests to be retried without the risk of executing the operation twice.

Returns:

  • (String)


1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 1322

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)
  include Aws::Structure
end

#domain_nameString

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)


1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 1322

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)
  include Aws::Structure
end

#idString

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

Returns:

  • (String)


1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 1322

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)
  include Aws::Structure
end

#nameString

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

Returns:

  • (String)


1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 1322

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)
  include Aws::Structure
end

#owner_idString

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

Returns:

  • (String)


1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 1322

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)
  include Aws::Structure
end

#resolver_endpoint_idString

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

Returns:

  • (String)


1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 1322

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)
  include Aws::Structure
end

#rule_typeString

This value is always FORWARD. Other resolver rule types aren't supported.

Returns:

  • (String)


1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 1322

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)
  include Aws::Structure
end

#share_statusString

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.

Returns:

  • (String)


1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 1322

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)
  include Aws::Structure
end

#statusString

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

Returns:

  • (String)


1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 1322

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)
  include Aws::Structure
end

#status_messageString

A detailed description of the status of a resolver rule.

Returns:

  • (String)


1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 1322

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)
  include Aws::Structure
end

#target_ipsArray<Types::TargetAddress>

An array that contains the IP addresses and ports that you want to forward

Returns:



1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 1322

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)
  include Aws::Structure
end