Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateFirewallRule

Creates a DNS firewall rule. Firewall rules define actions (ALLOW, BLOCK, or ALERT) to take on DNS queries that match specified domain lists, managed domain lists, or advanced threat protections.

Request Syntax


POST /firewall-rules HTTP/1.1
Content-type: application/json

{
   "action": "string",
   "blockOverrideDnsType": "string",
   "blockOverrideDomain": "string",
   "blockOverrideTtl": number,
   "blockResponse": "string",
   "clientToken": "string",
   "confidenceThreshold": "string",
   "description": "string",
   "dnsAdvancedProtection": "string",
   "dnsViewId": "string",
   "firewallDomainListId": "string",
   "name": "string",
   "priority": number,
   "qType": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

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:

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's BlockResponse.

Type: String

Valid Values: ALLOW | ALERT | BLOCK

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

Pattern: \*?[-a-zA-Z0-9.]+

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

Type: String

Valid Values: NODATA | NXDOMAIN | OVERRIDE

Required: No

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.

Type: String

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

Required: No

confidenceThreshold

The confidence threshold for advanced threat detection. Valid values are HIGH, MEDIUM, or LOW, indicating the accuracy level required for threat detection.

Type: String

Valid Values: LOW | MEDIUM | HIGH

Required: No

description

An optional description for the firewall rule.

Type: String

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

Required: No

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.

Type: String

Valid Values: DGA | DNS_TUNNELING

Required: No

dnsViewId

The ID of the DNS view to associate with this firewall rule.

Type: String

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

Pattern: [-.a-zA-Z0-9]+

Required: Yes

firewallDomainListId

The ID of the firewall domain list to use in this rule.

Type: String

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

Pattern: [-.a-zA-Z0-9]+

Required: No

name

A descriptive name for the firewall rule.

Type: String

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

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

Required: Yes

priority

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.

Type: Long

Valid Range: Minimum value of 1. Maximum value of 10000.

Required: No

qType

The DNS query type to match for this rule. Examples include A (IPv4 address), AAAA (IPv6 address), MX (mail exchange), or TXT (text record).

Type: String

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

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "action": "string",
   "blockOverrideDnsType": "string",
   "blockOverrideDomain": "string",
   "blockOverrideTtl": number,
   "blockResponse": "string",
   "confidenceThreshold": "string",
   "createdAt": "string",
   "description": "string",
   "dnsAdvancedProtection": "string",
   "dnsViewId": "string",
   "firewallDomainListId": "string",
   "id": "string",
   "name": "string",
   "priority": number,
   "queryType": "string",
   "status": "string",
   "updatedAt": "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.

action

The action that DNS Firewall takes on DNS queries that match this rule.

Type: String

Valid Values: ALLOW | ALERT | BLOCK

blockOverrideDnsType

The DNS record type for the custom response when blockResponse is OVERRIDE.

Type: String

Valid Values: CNAME

blockOverrideDomain

The custom domain to return when the action is BLOCK and blockResponse is OVERRIDE.

Type: String

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

Pattern: \*?[-a-zA-Z0-9.]+

blockOverrideTtl

The time-to-live (TTL) value for the custom response when blockResponse is OVERRIDE.

Type: Integer

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

blockResponse

The response to return when the action is BLOCK.

Type: String

Valid Values: NODATA | NXDOMAIN | OVERRIDE

confidenceThreshold

The confidence threshold for advanced threat detection.

Type: String

Valid Values: LOW | MEDIUM | HIGH

createdAt

The date and time when the firewall rule was created.

Type: Timestamp

description

The description of the firewall rule.

Type: String

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

dnsAdvancedProtection

Whether advanced DNS threat protection is enabled for this rule.

Type: String

Valid Values: DGA | DNS_TUNNELING

dnsViewId

The ID of the DNS view associated with this firewall rule.

Type: String

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

Pattern: [-.a-zA-Z0-9]+

firewallDomainListId

The ID of the firewall domain list used in this rule.

Type: String

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

Pattern: [-.a-zA-Z0-9]+

id

The unique identifier for the firewall rule.

Type: String

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

Pattern: [-.a-zA-Z0-9]+

name

The name of the firewall rule.

Type: String

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

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

priority

The priority of the firewall rule.

Type: Long

Valid Range: Minimum value of 1. Maximum value of 10000.

queryType

The DNS query type that this rule matches.

Type: String

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

status

The operational status of the firewall rule.

Type: String

Valid Values: CREATING | OPERATIONAL | UPDATING | DELETING

updatedAt

The date and time when the firewall rule was last updated.

Type: Timestamp

Errors

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

AccessDeniedException

You don't have permission to perform this operation. Check your IAM permissions and try again.

HTTP Status Code: 403

ConflictException

The request conflicts with the current state of the resource. This can occur when trying to modify a resource that is not in a valid state for the requested operation.

resourceId: The ID of the conflicting resource.
resourceType: The type of the conflicting resource.

HTTP Status Code: 409

InternalServerException

An internal server error occurred. Try again later.

retryAfterSeconds: Number of seconds in which the caller can retry the request.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource was not found. Verify the resource ID and try again.

resourceId: The unique ID of the resource referenced in the failed request.
resourceType: The resource type of the resource referenced in the failed request.

HTTP Status Code: 404

ServiceQuotaExceededException

The request would exceed one or more service quotas. Check your current usage and quotas, then try again.

quotaCode: The quota code recognized by the AWS Service Quotas service.
resourceId: The unique ID of the resource referenced in the failed request.
resourceType: The resource type of the resource referenced in the failed request.
serviceCode: The code for the AWS service that owns the quota.

HTTP Status Code: 402

ThrottlingException

The request was throttled due to too many requests. Wait a moment and try again.

quotaCode: The quota code recognized by the AWS Service Quotas service.
retryAfterSeconds: Number of seconds in which the caller can retry the request.
serviceCode: The code for the AWS service that owns the quota.

HTTP Status Code: 429

ValidationException

The input parameters are invalid. Check the parameter values and try again.

fieldList: The list of fields that aren't valid.
reason: Reason the request failed validation.

HTTP Status Code: 400