FirewallRule

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-route53-resolver/refs/heads/main/json-schema/amazon-route53-resolver-openapi-firewall-rule-schema.json",
  "title": "FirewallRule",
  "description": "A single firewall rule in a rule group.",
  "type": "object",
  "properties": {
    "FirewallRuleGroupId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ResourceId"
        },
        {
          "description": "The unique identifier of the firewall rule group of the rule. "
        }
      ]
    },
    "FirewallDomainListId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ResourceId"
        },
        {
          "description": "The ID of the domain list that's used in the rule. "
        }
      ]
    },
    "Name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Name"
        },
        {
          "description": "The name of the rule. "
        }
      ]
    },
    "Priority": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Priority"
        },
        {
          "description": "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."
        }
      ]
    },
    "Action": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Action"
        },
        {
          "description": "<p>The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain list:</p> <ul> <li> <p> <code>ALLOW</code> - Permit the request to go through.</p> </li> <li> <p> <code>ALERT</code> - Permit the request to go through but send an alert to the logs.</p> </li> <li> <p> <code>BLOCK</code> - Disallow the request. If this is specified, additional handling details are provided in the rule's <code>BlockResponse</code> setting. </p> </li> </ul>"
        }
      ]
    },
    "BlockResponse": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BlockResponse"
        },
        {
          "description": "<p>The way that you want DNS Firewall to block the request. Used for the rule action setting <code>BLOCK</code>.</p> <ul> <li> <p> <code>NODATA</code> - Respond indicating that the query was successful, but no response is available for it.</p> </li> <li> <p> <code>NXDOMAIN</code> - Respond indicating that the domain name that's in the query doesn't exist.</p> </li> <li> <p> <code>OVERRIDE</code> - Provide a custom override in the response. This option requires custom handling details in the rule's <code>BlockOverride*</code> settings. </p> </li> </ul>"
        }
      ]
    },
    "BlockOverrideDomain": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BlockOverrideDomain"
        },
        {
          "description": "The custom DNS record to send back in response to the query. Used for the rule action <code>BLOCK</code> with a <code>BlockResponse</code> setting of <code>OVERRIDE</code>."
        }
      ]
    },
    "BlockOverrideDnsType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BlockOverrideDnsType"
        },
        {
          "description": "The DNS record's type. This determines the format of the record value that you provided in <code>BlockOverrideDomain</code>. Used for the rule action <code>BLOCK</code> with a <code>BlockResponse</code> setting of <code>OVERRIDE</code>."
        }
      ]
    },
    "BlockOverrideTtl": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Unsigned"
        },
        {
          "description": "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 <code>BLOCK</code> with a <code>BlockResponse</code> setting of <code>OVERRIDE</code>."
        }
      ]
    },
    "CreatorRequestId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CreatorRequestId"
        },
        {
          "description": "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. "
        }
      ]
    },
    "CreationTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Rfc3339TimeString"
        },
        {
          "description": "The date and time that the rule was created, in Unix time format and Coordinated Universal Time (UTC). "
        }
      ]
    },
    "ModificationTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Rfc3339TimeString"
        },
        {
          "description": "The date and time that the rule was last modified, in Unix time format and Coordinated Universal Time (UTC)."
        }
      ]
    }
  }
}