Skip to main content

firewall_rules

Creates, updates, deletes, gets or lists a firewall_rules resource.

Overview​

Namefirewall_rules
TypeResource
Idaws.route53resolver.firewall_rules

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
actionstringThe 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. (ALLOW, BLOCK, ALERT)
block_override_dns_typestringThe 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. (CNAME)
block_override_domainstringThe custom DNS record to send back in response to the query. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.
block_override_ttlintegerThe 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.
block_responsestringThe 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. (NODATA, NXDOMAIN, OVERRIDE)
confidence_thresholdstringThe 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. (LOW, MEDIUM, HIGH)
creation_timestringThe date and time that the rule was created, in Unix time format and Coordinated Universal Time (UTC).
creator_request_idstringA 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.
dns_threat_protectionstringThe 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 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. DICTIONARY_DGA: Dictionary-based domain generation algorithms detection. Dictionary DGAs use wordlists to generate domains that appear more legitimate, making them harder to detect than traditional DGAs. (DGA, DNS_TUNNELING, DICTIONARY_DGA)
firewall_domain_list_idstringThe ID of the domain list that's used in the rule.
firewall_domain_redirection_actionstringHow 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. (INSPECT_REDIRECTION_DOMAIN, TRUST_REDIRECTION_DOMAIN)
firewall_rule_group_idstringThe unique identifier of the Firewall rule group of the rule.
firewall_rule_typeobjectThe rule type configuration for the firewall rule. This is a tagged union — exactly one of its members will be populated. Possible members are: FirewallAdvancedContentCategory — an AWS-managed content category (for example, VIOLENCE_AND_HATE_SPEECH). FirewallAdvancedThreatCategory — an AWS-managed advanced threat category (for example, PHISHING). DnsThreatProtection — a built-in DNS Firewall Advanced threat detector (DGA, DNS_TUNNELING, or DICTIONARY_DGA). PartnerThreatProtection — a third-party threat feed delivered through AWS Marketplace. To enumerate the values supported in your account, call ListFirewallRuleTypes.
firewall_threat_protection_idstringID of the DNS Firewall Advanced rule.
modification_timestringThe date and time that the rule was last modified, in Unix time format and Coordinated Universal Time (UTC).
namestringThe name of the rule. (pattern: <code>(?!^[0-9]+$)([a-zA-Z0-9-_' ']+)</code>)
priorityintegerThe 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.
qtypestringThe 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-65534, for example, TYPE28. For more information, see List of DNS record types.
statusstringThe lifecycle state of the firewall rule. Possible values: CREATING — DNS Firewall is provisioning the rule. Rules created with the PartnerThreatProtection rule type begin in this state while DNS Firewall verifies the calling account's AWS Marketplace entitlement. COMPLETE — The rule is provisioned and enforcing matches. CREATION_FAILED — Provisioning failed. StatusMessage contains a human-readable reason. A rule in this state is immutable: UpdateFirewallRule rejects the request, and the rule must be removed with DeleteFirewallRule. For rules that do not require asynchronous provisioning, this field may be absent.
status_messagestringAn additional message about the rule's lifecycle state. Populated when Status is CREATION_FAILED to describe why provisioning failed.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_firewall_rulesselectregionRetrieves the firewall rules that you have defined for the specified firewall rule group. DNS Firewall uses the rules in a rule group to filter DNS network traffic for a VPC. A single call might return only a partial list of the rules. For information, see MaxResults. For rules that require asynchronous provisioning, the response includes Status (see FirewallRuleStatus) and, on failure, StatusMessage with the reason.
create_firewall_ruleinsertregion, CreatorRequestId, FirewallRuleGroupIdCreates a single DNS Firewall rule in the specified rule group. The rule can use any one of the following match sources, and the chosen source must be supplied through the matching request field — they are mutually exclusive: FirewallDomainListId — match a customer-managed or AWS-managed domain list. DnsThreatProtection — match a built-in DNS Firewall Advanced threat detector (DGA, DNS_TUNNELING, or DICTIONARY_DGA). FirewallRuleType — match one of the rule-type variants returned by ListFirewallRuleTypes: FirewallAdvancedContentCategory, FirewallAdvancedThreatCategory, DnsThreatProtection, or PartnerThreatProtection. The PartnerThreatProtection variant requires an active AWS Marketplace subscription to the named partner product. For rules that require asynchronous provisioning (today, the PartnerThreatProtection rule type), the rule's Status begins at CREATING and transitions to COMPLETE once the rule is provisioned and the marketplace entitlement is verified. If provisioning fails, Status becomes CREATION_FAILED and StatusMessage contains a human-readable reason; the rule is then immutable and must be removed with DeleteFirewallRule.
update_firewall_ruleupdateregion, FirewallRuleGroupIdUpdates the specified firewall rule. The rule's FirewallRuleType, FirewallDomainListId, and top-level DnsThreatProtection match source cannot be changed after creation. Rules whose Status is CREATING or CREATION_FAILED cannot be updated; remove a failed rule with DeleteFirewallRule.
delete_firewall_ruledeleteregionDeletes the specified firewall rule. Identify the rule using either FirewallDomainListId (for domain-list and DNS Firewall Advanced rules) or FirewallThreatProtectionId (for partner-managed and DNS Firewall Advanced rules) — together with FirewallRuleGroupId. DeleteFirewallRule is the only operation that succeeds against a rule whose Status is CREATION_FAILED.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)

SELECT examples​

Retrieves the firewall rules that you have defined for the specified firewall rule group. DNS Firewall uses the rules in a rule group to filter DNS network traffic for a VPC. A single call might return only a partial list of the rules. For information, see MaxResults. For rules that require asynchronous provisioning, the response includes Status (see FirewallRuleStatus) and, on failure, StatusMessage with the reason.

SELECT
action,
block_override_dns_type,
block_override_domain,
block_override_ttl,
block_response,
confidence_threshold,
creation_time,
creator_request_id,
dns_threat_protection,
firewall_domain_list_id,
firewall_domain_redirection_action,
firewall_rule_group_id,
firewall_rule_type,
firewall_threat_protection_id,
modification_time,
name,
priority,
qtype,
status,
status_message
FROM aws.route53resolver.firewall_rules
WHERE region = '{{ region }}' -- required
;

INSERT examples​

Creates a single DNS Firewall rule in the specified rule group. The rule can use any one of the following match sources, and the chosen source must be supplied through the matching request field — they are mutually exclusive: FirewallDomainListId — match a customer-managed or AWS-managed domain list. DnsThreatProtection — match a built-in DNS Firewall Advanced threat detector (DGA, DNS_TUNNELING, or DICTIONARY_DGA). FirewallRuleType — match one of the rule-type variants returned by ListFirewallRuleTypes: FirewallAdvancedContentCategory, FirewallAdvancedThreatCategory, DnsThreatProtection, or PartnerThreatProtection. The PartnerThreatProtection variant requires an active AWS Marketplace subscription to the named partner product. For rules that require asynchronous provisioning (today, the PartnerThreatProtection rule type), the rule's Status begins at CREATING and transitions to COMPLETE once the rule is provisioned and the marketplace entitlement is verified. If provisioning fails, Status becomes CREATION_FAILED and StatusMessage contains a human-readable reason; the rule is then immutable and must be removed with DeleteFirewallRule.

INSERT INTO aws.route53resolver.firewall_rules (
CreatorRequestId,
FirewallRuleGroupId,
FirewallDomainListId,
Priority,
Action,
BlockResponse,
BlockOverrideDomain,
BlockOverrideDnsType,
BlockOverrideTtl,
Name,
FirewallDomainRedirectionAction,
Qtype,
DnsThreatProtection,
ConfidenceThreshold,
FirewallRuleType,
region
)
SELECT 
'{{ CreatorRequestId }}' /* required */,
'{{ FirewallRuleGroupId }}' /* required */,
'{{ FirewallDomainListId }}',
{{ Priority }},
'{{ Action }}',
'{{ BlockResponse }}',
'{{ BlockOverrideDomain }}',
'{{ BlockOverrideDnsType }}',
{{ BlockOverrideTtl }},
'{{ Name }}',
'{{ FirewallDomainRedirectionAction }}',
'{{ Qtype }}',
'{{ DnsThreatProtection }}',
'{{ ConfidenceThreshold }}',
'{{ FirewallRuleType }}',
'{{ region }}'
RETURNING
firewall_rule
;

UPDATE examples​

Updates the specified firewall rule. The rule's FirewallRuleType, FirewallDomainListId, and top-level DnsThreatProtection match source cannot be changed after creation. Rules whose Status is CREATING or CREATION_FAILED cannot be updated; remove a failed rule with DeleteFirewallRule.

UPDATE aws.route53resolver.firewall_rules
SET 
FirewallRuleGroupId = '{{ FirewallRuleGroupId }}',
FirewallDomainListId = '{{ FirewallDomainListId }}',
FirewallThreatProtectionId = '{{ FirewallThreatProtectionId }}',
Priority = {{ Priority }},
Action = '{{ Action }}',
BlockResponse = '{{ BlockResponse }}',
BlockOverrideDomain = '{{ BlockOverrideDomain }}',
BlockOverrideDnsType = '{{ BlockOverrideDnsType }}',
BlockOverrideTtl = {{ BlockOverrideTtl }},
Name = '{{ Name }}',
FirewallDomainRedirectionAction = '{{ FirewallDomainRedirectionAction }}',
Qtype = '{{ Qtype }}',
DnsThreatProtection = '{{ DnsThreatProtection }}',
ConfidenceThreshold = '{{ ConfidenceThreshold }}',
FirewallRuleType = '{{ FirewallRuleType }}'
WHERE 
region = '{{ region }}' --required
AND FirewallRuleGroupId = '{{ FirewallRuleGroupId }}' --required
RETURNING
firewall_rule;

DELETE examples​

Deletes the specified firewall rule. Identify the rule using either FirewallDomainListId (for domain-list and DNS Firewall Advanced rules) or FirewallThreatProtectionId (for partner-managed and DNS Firewall Advanced rules) — together with FirewallRuleGroupId. DeleteFirewallRule is the only operation that succeeds against a rule whose Status is CREATION_FAILED.

DELETE FROM aws.route53resolver.firewall_rules
WHERE region = '{{ region }}' --required
;
Last updated on