Class: Aws::Route53Resolver::Types::CreateFirewallRuleRequest

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 CreateFirewallRuleRequest data as a hash:

{
  creator_request_id: "CreatorRequestId", # required
  firewall_rule_group_id: "ResourceId", # required
  firewall_domain_list_id: "ResourceId", # required
  priority: 1, # required
  action: "ALLOW", # required, accepts ALLOW, BLOCK, ALERT
  block_response: "NODATA", # accepts NODATA, NXDOMAIN, OVERRIDE
  block_override_domain: "BlockOverrideDomain",
  block_override_dns_type: "CNAME", # accepts CNAME
  block_override_ttl: 1,
  name: "Name", # required
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#actionString

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 and send metrics and logs to Cloud Watch.

  • BLOCK - Disallow the request. This option requires additional details in the rule's BlockResponse.

Returns:

  • (String)


492
493
494
495
496
497
498
499
500
501
502
503
504
505
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 492

class CreateFirewallRuleRequest < Struct.new(
  :creator_request_id,
  :firewall_rule_group_id,
  :firewall_domain_list_id,
  :priority,
  :action,
  :block_response,
  :block_override_domain,
  :block_override_dns_type,
  :block_override_ttl,
  :name)
  SENSITIVE = []
  include Aws::Structure
end

#block_override_dns_typeString

The DNS record's type. This determines the format of the record value that you provided in BlockOverrideDomain. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

This setting is required if the BlockResponse setting is OVERRIDE.

Returns:

  • (String)


492
493
494
495
496
497
498
499
500
501
502
503
504
505
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 492

class CreateFirewallRuleRequest < Struct.new(
  :creator_request_id,
  :firewall_rule_group_id,
  :firewall_domain_list_id,
  :priority,
  :action,
  :block_response,
  :block_override_domain,
  :block_override_dns_type,
  :block_override_ttl,
  :name)
  SENSITIVE = []
  include Aws::Structure
end

#block_override_domainString

The custom DNS record to send back in response to the query. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

This setting is required if the BlockResponse setting is OVERRIDE.

Returns:

  • (String)


492
493
494
495
496
497
498
499
500
501
502
503
504
505
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 492

class CreateFirewallRuleRequest < Struct.new(
  :creator_request_id,
  :firewall_rule_group_id,
  :firewall_domain_list_id,
  :priority,
  :action,
  :block_response,
  :block_override_domain,
  :block_override_dns_type,
  :block_override_ttl,
  :name)
  SENSITIVE = []
  include Aws::Structure
end

#block_override_ttlInteger

The recommended amount of time, in seconds, for the DNS resolver or web browser to cache the provided override record. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

This setting is required if the BlockResponse setting is OVERRIDE.

Returns:

  • (Integer)


492
493
494
495
496
497
498
499
500
501
502
503
504
505
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 492

class CreateFirewallRuleRequest < Struct.new(
  :creator_request_id,
  :firewall_rule_group_id,
  :firewall_domain_list_id,
  :priority,
  :action,
  :block_response,
  :block_override_domain,
  :block_override_dns_type,
  :block_override_ttl,
  :name)
  SENSITIVE = []
  include Aws::Structure
end

#block_responseString

The way that you want DNS Firewall to block the request, used with the rule action setting BLOCK.

  • NODATA - Respond indicating that the query was successful, but no response is available for it.

  • NXDOMAIN - Respond indicating that the domain name that's in the query doesn't exist.

  • OVERRIDE - Provide a custom override in the response. This option requires custom handling details in the rule's BlockOverride* settings.

This setting is required if the rule action setting is BLOCK.

Returns:

  • (String)


492
493
494
495
496
497
498
499
500
501
502
503
504
505
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 492

class CreateFirewallRuleRequest < Struct.new(
  :creator_request_id,
  :firewall_rule_group_id,
  :firewall_domain_list_id,
  :priority,
  :action,
  :block_response,
  :block_override_domain,
  :block_override_dns_type,
  :block_override_ttl,
  :name)
  SENSITIVE = []
  include Aws::Structure
end

#creator_request_idString

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

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


492
493
494
495
496
497
498
499
500
501
502
503
504
505
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 492

class CreateFirewallRuleRequest < Struct.new(
  :creator_request_id,
  :firewall_rule_group_id,
  :firewall_domain_list_id,
  :priority,
  :action,
  :block_response,
  :block_override_domain,
  :block_override_dns_type,
  :block_override_ttl,
  :name)
  SENSITIVE = []
  include Aws::Structure
end

#firewall_domain_list_idString

The ID of the domain list that you want to use in the rule.

Returns:

  • (String)


492
493
494
495
496
497
498
499
500
501
502
503
504
505
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 492

class CreateFirewallRuleRequest < Struct.new(
  :creator_request_id,
  :firewall_rule_group_id,
  :firewall_domain_list_id,
  :priority,
  :action,
  :block_response,
  :block_override_domain,
  :block_override_dns_type,
  :block_override_ttl,
  :name)
  SENSITIVE = []
  include Aws::Structure
end

#firewall_rule_group_idString

The unique identifier of the firewall rule group where you want to create the rule.

Returns:

  • (String)


492
493
494
495
496
497
498
499
500
501
502
503
504
505
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 492

class CreateFirewallRuleRequest < Struct.new(
  :creator_request_id,
  :firewall_rule_group_id,
  :firewall_domain_list_id,
  :priority,
  :action,
  :block_response,
  :block_override_domain,
  :block_override_dns_type,
  :block_override_ttl,
  :name)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

A name that lets you identify the rule in the rule group.

Returns:

  • (String)


492
493
494
495
496
497
498
499
500
501
502
503
504
505
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 492

class CreateFirewallRuleRequest < Struct.new(
  :creator_request_id,
  :firewall_rule_group_id,
  :firewall_domain_list_id,
  :priority,
  :action,
  :block_response,
  :block_override_domain,
  :block_override_dns_type,
  :block_override_ttl,
  :name)
  SENSITIVE = []
  include Aws::Structure
end

#priorityInteger

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

You must specify a unique priority for each rule in a rule group. To make it easier to insert rules later, leave space between the numbers, for example, use 100, 200, and so on. You can change the priority setting for the rules in a rule group at any time.

Returns:

  • (Integer)


492
493
494
495
496
497
498
499
500
501
502
503
504
505
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 492

class CreateFirewallRuleRequest < Struct.new(
  :creator_request_id,
  :firewall_rule_group_id,
  :firewall_domain_list_id,
  :priority,
  :action,
  :block_response,
  :block_override_domain,
  :block_override_dns_type,
  :block_override_ttl,
  :name)
  SENSITIVE = []
  include Aws::Structure
end