CreateFirewallRuleRequest

{
  "$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-create-firewall-rule-request-schema.json",
  "title": "CreateFirewallRuleRequest",
  "description": "CreateFirewallRuleRequest schema from openapi",
  "type": "object",
  "properties": {
    "CreatorRequestId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CreatorRequestId"
        },
        {
          "description": "A unique string that identifies the request and that allows you to retry failed requests without the risk of running the operation twice. <code>CreatorRequestId</code> can be any unique string, for example, a date/time stamp. "
        }
      ]
    },
    "FirewallRuleGroupId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ResourceId"
        },
        {
          "description": "The unique identifier of the firewall rule group where you want to create the rule. "
        }
      ]
    },
    "FirewallDomainListId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ResourceId"
        },
        {
          "description": "The ID of the domain list that you want to use in the rule. "
        }
      ]
    },
    "Priority": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Priority"
        },
        {
          "description": "<p>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.</p> <p>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.</p>"
        }
      ]
    },
    "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 and send metrics and logs to Cloud Watch.</p> </li> <li> <p> <code>BLOCK</code> - Disallow the request. This option requires additional details in the rule's <code>BlockResponse</code>. </p> </li> </ul>"
        }
      ]
    },
    "BlockResponse": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BlockResponse"
        },
        {
          "description": "<p>The way that you want DNS Firewall to block the request, used with 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> <p>This setting is required if the rule action setting is <code>BLOCK</code>.</p>"
        }
      ]
    },
    "BlockOverrideDomain": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BlockOverrideDomain"
        },
        {
          "description": "<p>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>.</p> <p>This setting is required if the <code>BlockResponse</code> setting is <code>OVERRIDE</code>.</p>"
        }
      ]
    },
    "BlockOverrideDnsType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BlockOverrideDnsType"
        },
        {
          "description": "<p>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>.</p> <p>This setting is required if the <code>BlockResponse</code> setting is <code>OVERRIDE</code>.</p>"
        }
      ]
    },
    "BlockOverrideTtl": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BlockOverrideTtl"
        },
        {
          "description": "<p>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>.</p> <p>This setting is required if the <code>BlockResponse</code> setting is <code>OVERRIDE</code>.</p>"
        }
      ]
    },
    "Name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Name"
        },
        {
          "description": "A name that lets you identify the rule in the rule group."
        }
      ]
    }
  },
  "required": [
    "CreatorRequestId",
    "FirewallRuleGroupId",
    "FirewallDomainListId",
    "Priority",
    "Action",
    "Name"
  ]
}