CreateFirewallRuleInput
¶
Source code in docs_src/capo_route53globalresolver/types/create_firewall_rule_input.py
action
instance-attribute
¶
action: FirewallRuleAction
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 CloudWatch. -
BLOCK- Disallow the request. This option requires additional details in the rule'sBlockResponse.
block_override_dns_type
instance-attribute
¶
block_override_dns_type: NotRequired[BlockOverrideDnsQueryType]
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.
block_override_domain
instance-attribute
¶
block_override_domain: NotRequired[Domain]
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.
block_override_ttl
instance-attribute
¶
block_override_ttl: NotRequired[BlockOverrideTtl]
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.
block_response
instance-attribute
¶
block_response: NotRequired[FirewallBlockResponse]
The response to return when the action is BLOCK. Valid values are NXDOMAIN (domain does not exist), NODATA (domain exists but no records), or OVERRIDE (return custom response).
client_token
instance-attribute
¶
client_token: NotRequired[ClientToken]
A unique, case-sensitive identifier to ensure idempotency. This means that making the same request multiple times with the same clientToken has the same result every time.
confidence_threshold
instance-attribute
¶
confidence_threshold: NotRequired[ConfidenceThreshold]
The confidence threshold for advanced threat detection. Valid values are HIGH, MEDIUM, or LOW, indicating the accuracy level required for threat detection.
description
instance-attribute
¶
description: NotRequired[ResourceDescription]
An optional description for the firewall rule.
dns_advanced_protection
instance-attribute
¶
dns_advanced_protection: NotRequired[DnsAdvancedProtection]
Whether to enable advanced DNS threat protection for this rule. Advanced protection can detect and block DNS tunneling and Domain Generation Algorithm (DGA) threats.
dns_view_id
instance-attribute
¶
dns_view_id: ResourceId
The ID of the DNS view to associate with this firewall rule.
firewall_domain_list_id
instance-attribute
¶
firewall_domain_list_id: NotRequired[ResourceId]
The ID of the firewall domain list to use in this rule.
priority
instance-attribute
¶
priority: NotRequired[FirewallRulePriority]
The priority of this rule. Rules are evaluated in priority order, with lower numbers having higher priority. When a DNS query matches multiple rules, the rule with the highest priority (lowest number) is applied.
q_type
instance-attribute
¶
q_type: NotRequired[DnsQueryType]
The DNS query type to match for this rule. Examples include A (IPv4 address), AAAA (IPv6 address), MX (mail exchange), or TXT (text record).