AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . route53globalresolver ]

create-firewall-rule

Description

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.

See also: AWS API Documentation

Synopsis

  create-firewall-rule
--action <value>
[--block-override-dns-type <value>]
[--block-override-domain <value>]
[--block-override-ttl <value>]
[--block-response <value>]
[--client-token <value>]
[--confidence-threshold <value>]
[--description <value>]
[--dns-advanced-protection <value>]
[--firewall-domain-list-id <value>]
--name <value>
[--priority <value>]
--dns-view-id <value>
[--q-type <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--v2-debug]

Options

--action (string)

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 .

Possible values:

  • ALLOW
  • ALERT
  • BLOCK

--block-override-dns-type (string)

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 .

Possible values:

  • CNAME

--block-override-domain (string)

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 .

--block-override-ttl (integer)

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 .

--block-response (string)

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

Possible values:

  • NODATA
  • NXDOMAIN
  • OVERRIDE

--client-token (string)

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.

--confidence-threshold (string)

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

Possible values:

  • LOW
  • MEDIUM
  • HIGH

--description (string)

An optional description for the firewall rule.

--dns-advanced-protection (string)

Whether to enable advanced DNS threat protection for this rule. Advanced protection can detect and block DNS tunneling and Domain Generation Algorithm (DGA) threats.

Possible values:

  • DGA
  • DNS_TUNNELING

--firewall-domain-list-id (string)

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

--name (string)

A descriptive name for the firewall rule.

--priority (long)

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.

--dns-view-id (string)

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

--q-type (string)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

action -> (string)

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

blockOverrideDnsType -> (string)

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

blockOverrideDomain -> (string)

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

blockOverrideTtl -> (integer)

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

blockResponse -> (string)

The response to return when the action is BLOCK.

confidenceThreshold -> (string)

The confidence threshold for advanced threat detection.

createdAt -> (timestamp)

The date and time when the firewall rule was created.

description -> (string)

The description of the firewall rule.

dnsAdvancedProtection -> (string)

Whether advanced DNS threat protection is enabled for this rule.

firewallDomainListId -> (string)

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

id -> (string)

The unique identifier for the firewall rule.

name -> (string)

The name of the firewall rule.

priority -> (long)

The priority of the firewall rule.

dnsViewId -> (string)

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

queryType -> (string)

The DNS query type that this rule matches.

status -> (string)

The operational status of the firewall rule.

updatedAt -> (timestamp)

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