Class: Aws::Route53Resolver::Types::ListFirewallRulesRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb

Overview

Note:

When making an API call, you may pass ListFirewallRulesRequest data as a hash:

{
  firewall_rule_group_id: "ResourceId", # required
  priority: 1,
  action: "ALLOW", # accepts ALLOW, BLOCK, ALERT
  max_results: 1,
  next_token: "NextToken",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#actionString

Optional additional filter for the rules to retrieve.

The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain list:

  • ALLOW - Permit the request to go through.

  • ALERT - Permit the request to go through but send an alert to the logs.

  • BLOCK - Disallow the request. If this is specified, additional handling details are provided in the rule's BlockResponse setting.

Returns:

  • (String)


3016
3017
3018
3019
3020
3021
3022
3023
3024
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 3016

class ListFirewallRulesRequest < Struct.new(
  :firewall_rule_group_id,
  :priority,
  :action,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#firewall_rule_group_idString

The unique identifier of the firewall rule group that you want to retrieve the rules for.

Returns:

  • (String)


3016
3017
3018
3019
3020
3021
3022
3023
3024
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 3016

class ListFirewallRulesRequest < Struct.new(
  :firewall_rule_group_id,
  :priority,
  :action,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

The maximum number of objects that you want Resolver to return for this request. If more objects are available, in the response, Resolver provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

If you don't specify a value for MaxResults, Resolver returns up to 100 objects.

Returns:

  • (Integer)


3016
3017
3018
3019
3020
3021
3022
3023
3024
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 3016

class ListFirewallRulesRequest < Struct.new(
  :firewall_rule_group_id,
  :priority,
  :action,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

For the first call to this list request, omit this value.

When you request a list of objects, Resolver returns at most the number of objects specified in MaxResults. If more objects are available for retrieval, Resolver returns a NextToken value in the response. To retrieve the next batch of objects, use the token that was returned for the prior request in your next request.

Returns:

  • (String)


3016
3017
3018
3019
3020
3021
3022
3023
3024
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 3016

class ListFirewallRulesRequest < Struct.new(
  :firewall_rule_group_id,
  :priority,
  :action,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#priorityInteger

Optional additional filter for the rules to retrieve.

The setting that determines the processing order of the rules in a rule group. DNS Firewall processes the rules in a rule group by order of priority, starting from the lowest setting.

Returns:

  • (Integer)


3016
3017
3018
3019
3020
3021
3022
3023
3024
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 3016

class ListFirewallRulesRequest < Struct.new(
  :firewall_rule_group_id,
  :priority,
  :action,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end