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

Inherits:

Struct

• Object
• Struct
• Aws::Route53Resolver::Types::FirewallRule

Includes:

Structure

Defined in:

lib/aws-sdk-route53resolver/types.rb

Overview

A single firewall rule in a rule group.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #action ⇒ String

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

• #block_override_dns_type ⇒ String

  The DNS record’s type.

• #block_override_domain ⇒ String

  The custom DNS record to send back in response to the query.

• #block_override_ttl ⇒ Integer

  The recommended amount of time, in seconds, for the DNS resolver or web browser to cache the provided override record.

• #block_response ⇒ String

  The way that you want DNS Firewall to block the request.

• #creation_time ⇒ String

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

• #creator_request_id ⇒ String

  A unique string defined by you to identify the request.

• #firewall_domain_list_id ⇒ String

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

• #firewall_domain_redirection_action ⇒ String

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

• #firewall_rule_group_id ⇒ String

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

• #modification_time ⇒ String

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

• #name ⇒ String

  The name of the rule.

• #priority ⇒ Integer

  The priority of the rule in the rule group.

• #qtype ⇒ String

  The DNS query type you want the rule to evaluate.

Instance Attribute Details

#action ⇒ String

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)

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

class FirewallRule < Struct.new(
  :firewall_rule_group_id,
  :firewall_domain_list_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)
  SENSITIVE = []
  include Aws::Structure
end

#block_override_dns_type ⇒ String

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)

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

class FirewallRule < Struct.new(
  :firewall_rule_group_id,
  :firewall_domain_list_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)
  SENSITIVE = []
  include Aws::Structure
end

#block_override_domain ⇒ String

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)

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

class FirewallRule < Struct.new(
  :firewall_rule_group_id,
  :firewall_domain_list_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)
  SENSITIVE = []
  include Aws::Structure
end

#block_override_ttl ⇒ Integer

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)

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

class FirewallRule < Struct.new(
  :firewall_rule_group_id,
  :firewall_domain_list_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)
  SENSITIVE = []
  include Aws::Structure
end

#block_response ⇒ String

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)

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

class FirewallRule < Struct.new(
  :firewall_rule_group_id,
  :firewall_domain_list_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)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time ⇒ String

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

Returns:

• (String)

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

class FirewallRule < Struct.new(
  :firewall_rule_group_id,
  :firewall_domain_list_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)
  SENSITIVE = []
  include Aws::Structure
end

#creator_request_id ⇒ String

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)

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

class FirewallRule < Struct.new(
  :firewall_rule_group_id,
  :firewall_domain_list_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)
  SENSITIVE = []
  include Aws::Structure
end

#firewall_domain_list_id ⇒ String

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

Returns:

• (String)

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

class FirewallRule < Struct.new(
  :firewall_rule_group_id,
  :firewall_domain_list_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)
  SENSITIVE = []
  include Aws::Structure
end

#firewall_domain_redirection_action ⇒ String

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)

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

class FirewallRule < Struct.new(
  :firewall_rule_group_id,
  :firewall_domain_list_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)
  SENSITIVE = []
  include Aws::Structure
end

#firewall_rule_group_id ⇒ String

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

Returns:

• (String)

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

class FirewallRule < Struct.new(
  :firewall_rule_group_id,
  :firewall_domain_list_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)
  SENSITIVE = []
  include Aws::Structure
end

#modification_time ⇒ String

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

Returns:

• (String)

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

class FirewallRule < Struct.new(
  :firewall_rule_group_id,
  :firewall_domain_list_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)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the rule.

Returns:

• (String)

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

class FirewallRule < Struct.new(
  :firewall_rule_group_id,
  :firewall_domain_list_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)
  SENSITIVE = []
  include Aws::Structure
end

#priority ⇒ Integer

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)

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

class FirewallRule < Struct.new(
  :firewall_rule_group_id,
  :firewall_domain_list_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)
  SENSITIVE = []
  include Aws::Structure
end

#qtype ⇒ String

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

[1]: en.wikipedia.org/wiki/List_of_DNS_record_types

Returns:

• (String)

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

class FirewallRule < Struct.new(
  :firewall_rule_group_id,
  :firewall_domain_list_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)
  SENSITIVE = []
  include Aws::Structure
end