Class: Aws::Route53Resolver::Types::FirewallRule

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

Overview

A single firewall rule in a rule group.

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, or a threat in a DNS Firewall Advanced rule:

  • ALLOW - Permit the request to go through. Not available for DNS Firewall Advanced rules.

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


1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 1763

class FirewallRule < Struct.new(
  :firewall_rule_group_id,
  :firewall_domain_list_id,
  :firewall_threat_protection_id,
  :name,
  :priority,
  :action,
  :block_response,
  :block_override_domain,
  :block_override_dns_type,
  :block_override_ttl,
  :creator_request_id,
  :creation_time,
  :modification_time,
  :firewall_domain_redirection_action,
  :qtype,
  :dns_threat_protection,
  :confidence_threshold)
  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.

Returns:

  • (String)


1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 1763

class FirewallRule < Struct.new(
  :firewall_rule_group_id,
  :firewall_domain_list_id,
  :firewall_threat_protection_id,
  :name,
  :priority,
  :action,
  :block_response,
  :block_override_domain,
  :block_override_dns_type,
  :block_override_ttl,
  :creator_request_id,
  :creation_time,
  :modification_time,
  :firewall_domain_redirection_action,
  :qtype,
  :dns_threat_protection,
  :confidence_threshold)
  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.

Returns:

  • (String)


1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 1763

class FirewallRule < Struct.new(
  :firewall_rule_group_id,
  :firewall_domain_list_id,
  :firewall_threat_protection_id,
  :name,
  :priority,
  :action,
  :block_response,
  :block_override_domain,
  :block_override_dns_type,
  :block_override_ttl,
  :creator_request_id,
  :creation_time,
  :modification_time,
  :firewall_domain_redirection_action,
  :qtype,
  :dns_threat_protection,
  :confidence_threshold)
  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.

Returns:

  • (Integer)


1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 1763

class FirewallRule < Struct.new(
  :firewall_rule_group_id,
  :firewall_domain_list_id,
  :firewall_threat_protection_id,
  :name,
  :priority,
  :action,
  :block_response,
  :block_override_domain,
  :block_override_dns_type,
  :block_override_ttl,
  :creator_request_id,
  :creation_time,
  :modification_time,
  :firewall_domain_redirection_action,
  :qtype,
  :dns_threat_protection,
  :confidence_threshold)
  SENSITIVE = []
  include Aws::Structure
end

#block_responseString

The way that you want DNS Firewall to block the request. Used for 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.

Returns:

  • (String)


1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 1763

class FirewallRule < Struct.new(
  :firewall_rule_group_id,
  :firewall_domain_list_id,
  :firewall_threat_protection_id,
  :name,
  :priority,
  :action,
  :block_response,
  :block_override_domain,
  :block_override_dns_type,
  :block_override_ttl,
  :creator_request_id,
  :creation_time,
  :modification_time,
  :firewall_domain_redirection_action,
  :qtype,
  :dns_threat_protection,
  :confidence_threshold)
  SENSITIVE = []
  include Aws::Structure
end

#confidence_thresholdString

The confidence threshold for DNS Firewall Advanced. You must provide this value when you create a DNS Firewall Advanced rule. The confidence level values mean:

  • LOW: Provides the highest detection rate for threats, but also increases false positives.

  • MEDIUM: Provides a balance between detecting threats and false positives.

  • HIGH: Detects only the most well corroborated threats with a low rate of false positives.

Returns:

  • (String)


1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 1763

class FirewallRule < Struct.new(
  :firewall_rule_group_id,
  :firewall_domain_list_id,
  :firewall_threat_protection_id,
  :name,
  :priority,
  :action,
  :block_response,
  :block_override_domain,
  :block_override_dns_type,
  :block_override_ttl,
  :creator_request_id,
  :creation_time,
  :modification_time,
  :firewall_domain_redirection_action,
  :qtype,
  :dns_threat_protection,
  :confidence_threshold)
  SENSITIVE = []
  include Aws::Structure
end

#creation_timeString

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

Returns:

  • (String)


1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 1763

class FirewallRule < Struct.new(
  :firewall_rule_group_id,
  :firewall_domain_list_id,
  :firewall_threat_protection_id,
  :name,
  :priority,
  :action,
  :block_response,
  :block_override_domain,
  :block_override_dns_type,
  :block_override_ttl,
  :creator_request_id,
  :creation_time,
  :modification_time,
  :firewall_domain_redirection_action,
  :qtype,
  :dns_threat_protection,
  :confidence_threshold)
  SENSITIVE = []
  include Aws::Structure
end

#creator_request_idString

A unique string defined by you to identify the request. This allows you to retry failed requests without the risk of executing the operation twice. This can be any unique string, for example, a timestamp.

Returns:

  • (String)


1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 1763

class FirewallRule < Struct.new(
  :firewall_rule_group_id,
  :firewall_domain_list_id,
  :firewall_threat_protection_id,
  :name,
  :priority,
  :action,
  :block_response,
  :block_override_domain,
  :block_override_dns_type,
  :block_override_ttl,
  :creator_request_id,
  :creation_time,
  :modification_time,
  :firewall_domain_redirection_action,
  :qtype,
  :dns_threat_protection,
  :confidence_threshold)
  SENSITIVE = []
  include Aws::Structure
end

#dns_threat_protectionString

The type of the DNS Firewall Advanced rule. Valid values are:

  • DGA: Domain generation algorithms detection. DGAs are used by attackers to generate a large number of domains to to launch malware attacks.

  • DNS_TUNNELING: DNS tunneling detection. DNS tunneling is used by attackers to exfiltrate data from the client by using the DNS tunnel without making a network connection to the client.

Returns:

  • (String)


1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 1763

class FirewallRule < Struct.new(
  :firewall_rule_group_id,
  :firewall_domain_list_id,
  :firewall_threat_protection_id,
  :name,
  :priority,
  :action,
  :block_response,
  :block_override_domain,
  :block_override_dns_type,
  :block_override_ttl,
  :creator_request_id,
  :creation_time,
  :modification_time,
  :firewall_domain_redirection_action,
  :qtype,
  :dns_threat_protection,
  :confidence_threshold)
  SENSITIVE = []
  include Aws::Structure
end

#firewall_domain_list_idString

The ID of the domain list that's used in the rule.

Returns:

  • (String)


1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 1763

class FirewallRule < Struct.new(
  :firewall_rule_group_id,
  :firewall_domain_list_id,
  :firewall_threat_protection_id,
  :name,
  :priority,
  :action,
  :block_response,
  :block_override_domain,
  :block_override_dns_type,
  :block_override_ttl,
  :creator_request_id,
  :creation_time,
  :modification_time,
  :firewall_domain_redirection_action,
  :qtype,
  :dns_threat_protection,
  :confidence_threshold)
  SENSITIVE = []
  include Aws::Structure
end

#firewall_domain_redirection_actionString

How you want the the rule to evaluate DNS redirection in the DNS redirection chain, such as CNAME or DNAME.

INSPECT_REDIRECTION_DOMAIN: (Default) inspects all domains in the redirection chain. The individual domains in the redirection chain must be added to the domain list.

TRUST_REDIRECTION_DOMAIN: Inspects only the first domain in the redirection chain. You don't need to add the subsequent domains in the domain in the redirection list to the domain list.

Returns:

  • (String)


1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 1763

class FirewallRule < Struct.new(
  :firewall_rule_group_id,
  :firewall_domain_list_id,
  :firewall_threat_protection_id,
  :name,
  :priority,
  :action,
  :block_response,
  :block_override_domain,
  :block_override_dns_type,
  :block_override_ttl,
  :creator_request_id,
  :creation_time,
  :modification_time,
  :firewall_domain_redirection_action,
  :qtype,
  :dns_threat_protection,
  :confidence_threshold)
  SENSITIVE = []
  include Aws::Structure
end

#firewall_rule_group_idString

The unique identifier of the Firewall rule group of the rule.

Returns:

  • (String)


1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 1763

class FirewallRule < Struct.new(
  :firewall_rule_group_id,
  :firewall_domain_list_id,
  :firewall_threat_protection_id,
  :name,
  :priority,
  :action,
  :block_response,
  :block_override_domain,
  :block_override_dns_type,
  :block_override_ttl,
  :creator_request_id,
  :creation_time,
  :modification_time,
  :firewall_domain_redirection_action,
  :qtype,
  :dns_threat_protection,
  :confidence_threshold)
  SENSITIVE = []
  include Aws::Structure
end

#firewall_threat_protection_idString

ID of the DNS Firewall Advanced rule.

Returns:

  • (String)


1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 1763

class FirewallRule < Struct.new(
  :firewall_rule_group_id,
  :firewall_domain_list_id,
  :firewall_threat_protection_id,
  :name,
  :priority,
  :action,
  :block_response,
  :block_override_domain,
  :block_override_dns_type,
  :block_override_ttl,
  :creator_request_id,
  :creation_time,
  :modification_time,
  :firewall_domain_redirection_action,
  :qtype,
  :dns_threat_protection,
  :confidence_threshold)
  SENSITIVE = []
  include Aws::Structure
end

#modification_timeString

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

Returns:

  • (String)


1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 1763

class FirewallRule < Struct.new(
  :firewall_rule_group_id,
  :firewall_domain_list_id,
  :firewall_threat_protection_id,
  :name,
  :priority,
  :action,
  :block_response,
  :block_override_domain,
  :block_override_dns_type,
  :block_override_ttl,
  :creator_request_id,
  :creation_time,
  :modification_time,
  :firewall_domain_redirection_action,
  :qtype,
  :dns_threat_protection,
  :confidence_threshold)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the rule.

Returns:

  • (String)


1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 1763

class FirewallRule < Struct.new(
  :firewall_rule_group_id,
  :firewall_domain_list_id,
  :firewall_threat_protection_id,
  :name,
  :priority,
  :action,
  :block_response,
  :block_override_domain,
  :block_override_dns_type,
  :block_override_ttl,
  :creator_request_id,
  :creation_time,
  :modification_time,
  :firewall_domain_redirection_action,
  :qtype,
  :dns_threat_protection,
  :confidence_threshold)
  SENSITIVE = []
  include Aws::Structure
end

#priorityInteger

The priority of the rule in the rule group. This value must be unique within the rule group. DNS Firewall processes the rules in a rule group by order of priority, starting from the lowest setting.

Returns:

  • (Integer)


1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 1763

class FirewallRule < Struct.new(
  :firewall_rule_group_id,
  :firewall_domain_list_id,
  :firewall_threat_protection_id,
  :name,
  :priority,
  :action,
  :block_response,
  :block_override_domain,
  :block_override_dns_type,
  :block_override_ttl,
  :creator_request_id,
  :creation_time,
  :modification_time,
  :firewall_domain_redirection_action,
  :qtype,
  :dns_threat_protection,
  :confidence_threshold)
  SENSITIVE = []
  include Aws::Structure
end

#qtypeString

The DNS query type you want the rule to evaluate. Allowed values are;

  • A: Returns an IPv4 address.

  • AAAA: Returns an Ipv6 address.

  • CAA: Restricts CAs that can create SSL/TLS certifications for the domain.

  • CNAME: Returns another domain name.

  • DS: Record that identifies the DNSSEC signing key of a delegated zone.

  • MX: Specifies mail servers.

  • NAPTR: Regular-expression-based rewriting of domain names.

  • NS: Authoritative name servers.

  • PTR: Maps an IP address to a domain name.

  • SOA: Start of authority record for the zone.

  • SPF: Lists the servers authorized to send emails from a domain.

  • SRV: Application specific values that identify servers.

  • TXT: Verifies email senders and application-specific values.

  • A query type you define by using the DNS type ID, for example 28 for AAAA. The values must be defined as TYPENUMBER, where the NUMBER can be 1-65334, for example, TYPE28. For more information, see List of DNS record types.

Returns:

  • (String)


1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 1763

class FirewallRule < Struct.new(
  :firewall_rule_group_id,
  :firewall_domain_list_id,
  :firewall_threat_protection_id,
  :name,
  :priority,
  :action,
  :block_response,
  :block_override_domain,
  :block_override_dns_type,
  :block_override_ttl,
  :creator_request_id,
  :creation_time,
  :modification_time,
  :firewall_domain_redirection_action,
  :qtype,
  :dns_threat_protection,
  :confidence_threshold)
  SENSITIVE = []
  include Aws::Structure
end