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:

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


1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 1624

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


1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 1624

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


1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 1624

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


1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 1624

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


1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 1624

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


1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 1624

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


1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 1624

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)
  SENSITIVE = []
  include Aws::Structure
end

#firewall_domain_list_idString

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

Returns:

  • (String)


1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 1624

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)
  SENSITIVE = []
  include Aws::Structure
end

#firewall_rule_group_idString

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

Returns:

  • (String)


1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 1624

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


1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 1624

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)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the rule.

Returns:

  • (String)


1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 1624

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


1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 1624

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)
  SENSITIVE = []
  include Aws::Structure
end