Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

CreateFirewallRule

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.

Request Syntax


{
   "Action": "string",
   "BlockOverrideDnsType": "string",
   "BlockOverrideDomain": "string",
   "BlockOverrideTtl": number,
   "BlockResponse": "string",
   "ConfidenceThreshold": "string",
   "CreatorRequestId": "string",
   "DnsThreatProtection": "string",
   "FirewallDomainListId": "string",
   "FirewallDomainRedirectionAction": "string",
   "FirewallRuleGroupId": "string",
   "FirewallRuleType": { 
      "DnsThreatProtection": { 
         "ConfidenceThreshold": "string",
         "Value": "string"
      },
      "FirewallAdvancedContentCategory": { 
         "Category": "string"
      },
      "FirewallAdvancedThreatCategory": { 
         "Category": "string"
      },
      "PartnerThreatProtection": { 
         "Partner": "string"
      }
   },
   "Name": "string",
   "Priority": number,
   "Qtype": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Action

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 and send metrics and logs to Cloud Watch.
BLOCK - Disallow the request. This option requires additional details in the rule's BlockResponse.

Type: String

Valid Values: ALLOW | BLOCK | ALERT

Required: Yes

BlockOverrideDnsType

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.

Type: String

Valid Values: CNAME

Required: No

BlockOverrideDomain

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: No

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.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 604800.

Required: No

BlockResponse

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

This setting is required if the rule action setting is BLOCK.

Type: String

Valid Values: NODATA | NXDOMAIN | OVERRIDE

Required: No

ConfidenceThreshold

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.

Type: String

Valid Values: LOW | MEDIUM | HIGH

Required: No

CreatorRequestId

A unique string that identifies the request and that allows you to retry failed requests without the risk of running the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: Yes

DnsThreatProtection

The type of the DNS Firewall Advanced rule. This setting is mutually exclusive with FirewallDomainListId and FirewallRuleType. 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.

Type: String

Valid Values: DGA | DNS_TUNNELING | DICTIONARY_DGA

Required: No

FirewallDomainListId

The ID of the domain list that you want to use in the rule. Can't be used together with DnsThreatProtecton.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: No

FirewallDomainRedirectionAction

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.

Type: String

Valid Values: INSPECT_REDIRECTION_DOMAIN | TRUST_REDIRECTION_DOMAIN

Required: No

FirewallRuleGroupId

The unique identifier of the firewall rule group where you want to create the rule.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: Yes

FirewallRuleType

The rule type configuration for the firewall rule. This is a tagged union — set exactly one of its members. This setting is mutually exclusive with the top-level FirewallDomainListId and DnsThreatProtection fields. Use one of:

FirewallAdvancedContentCategory — match an AWS-managed content category (for example, VIOLENCE_AND_HATE_SPEECH).
FirewallAdvancedThreatCategory — match an AWS-managed advanced threat category (for example, PHISHING).
DnsThreatProtection — match a built-in DNS Firewall Advanced threat detector (DGA, DNS_TUNNELING, or DICTIONARY_DGA).
PartnerThreatProtection — match a third-party threat feed delivered through AWS Marketplace. The selected partner must be an active subscription on the calling account.

To enumerate the values supported in your account, call ListFirewallRuleTypes.

Type: FirewallRuleType object

Required: No

Name

A name that lets you identify the rule in the rule group.

Type: String

Length Constraints: Maximum length of 64.

Pattern: (?!^[0-9]+$)([a-zA-Z0-9\-_' ']+)

Required: Yes

Priority

The setting that determines the processing order of the rule in the rule group. DNS Firewall processes the rules in a rule group by order of priority, starting from the lowest setting.

You must specify a unique priority for each rule in a rule group. To make it easier to insert rules later, leave space between the numbers, for example, use 100, 200, and so on. You can change the priority setting for the rules in a rule group at any time.

Type: Integer

Required: Yes

Qtype

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-65534, for example, TYPE28. For more information, see List of DNS record types.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 16.

Required: No

Response Syntax


{
   "FirewallRule": { 
      "Action": "string",
      "BlockOverrideDnsType": "string",
      "BlockOverrideDomain": "string",
      "BlockOverrideTtl": number,
      "BlockResponse": "string",
      "ConfidenceThreshold": "string",
      "CreationTime": "string",
      "CreatorRequestId": "string",
      "DnsThreatProtection": "string",
      "FirewallDomainListId": "string",
      "FirewallDomainRedirectionAction": "string",
      "FirewallRuleGroupId": "string",
      "FirewallRuleType": { 
         "DnsThreatProtection": { 
            "ConfidenceThreshold": "string",
            "Value": "string"
         },
         "FirewallAdvancedContentCategory": { 
            "Category": "string"
         },
         "FirewallAdvancedThreatCategory": { 
            "Category": "string"
         },
         "PartnerThreatProtection": { 
            "Partner": "string"
         }
      },
      "FirewallThreatProtectionId": "string",
      "ModificationTime": "string",
      "Name": "string",
      "Priority": number,
      "Qtype": "string",
      "Status": "string",
      "StatusMessage": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

FirewallRule

The firewall rule that you just created.

Type: FirewallRule object

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

The current account doesn't have the IAM permissions required to perform the specified Resolver operation.

This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs.

HTTP Status Code: 400

InternalServiceErrorException

We encountered an unknown error. Try again in a few minutes.

HTTP Status Code: 400

LimitExceededException

The request caused one or more limits to be exceeded.

ResourceType: For a LimitExceededException error, the type of resource that exceeded the current limit.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource doesn't exist.

ResourceType: For a ResourceNotFoundException error, the type of resource that doesn't exist.

HTTP Status Code: 400

ThrottlingException

The request was throttled. Try again in a few minutes.

HTTP Status Code: 400

ValidationException

You have provided an invalid command. If you ran the UpdateFirewallDomains request. supported values are ADD, REMOVE, or REPLACE a domain.

HTTP Status Code: 400

Examples

CreateFirewallRule Example - PartnerThreatProtection rule type

This example illustrates one usage of CreateFirewallRule.

Sample Request


POST / HTTP/1.1
Host: route53resolver.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 312
X-Amz-Target: Route53Resolver.CreateFirewallRule
X-Amz-Date: 20260420T120000Z
User-Agent: aws-cli/2.15.0 Python/3.11.6
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256
               Credential=AKIAJJ2SONIPEXAMPLE/20260420/us-east-1/route53resolver/aws4_request,
               SignedHeaders=content-type;host;x-amz-date;x-amz-target,
               Signature=[calculated-signature]

{
    "CreatorRequestId": "create-partner-rule-1",
    "FirewallRuleGroupId": "rslvr-frg-47f93271fexample",
    "Priority": 200,
    "Action": "BLOCK",
    "BlockResponse": "NODATA",
    "Name": "panw-advanced-threat",
    "FirewallRuleType": {
        "PartnerThreatProtection": {
            "Partner": "PANW_MALWARE_DOMAINS"
        }
    }
}

Sample Response


HTTP/1.1 200 OK
Date: Sun, 20 Apr 2026 12:00:01 GMT
Content-Type: application/x-amz-json-1.1
Content-Length: 612
x-amzn-RequestId: 8a9b0c1d-2e3f-4a5b-6c7d-8e9f0example
Connection: keep-alive

{
    "FirewallRule": {
        "FirewallRuleGroupId": "rslvr-frg-47f93271fexample",
        "FirewallThreatProtectionId": "rslvr-ftp-1a2b3c4d5example",
        "Name": "panw-advanced-threat",
        "Priority": 200,
        "Action": "BLOCK",
        "BlockResponse": "NODATA",
        "CreatorRequestId": "create-partner-rule-1",
        "CreationTime": "2026-04-20T12:00:01.000Z",
        "ModificationTime": "2026-04-20T12:00:01.000Z",
        "Status": "CREATING",
        "FirewallRuleType": {
            "PartnerThreatProtection": {
                "Partner": "PANW_MALWARE_DOMAINS"
            }
        }
    }
}