AWS CLI Command Reference

[ aws . route53globalresolver ]

update-firewall-rule

Description

Updates the configuration of a DNS firewall rule.

See also: AWS API Documentation

Synopsis

  update-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-rule-id <value>
[--name <value>]
[--priority <value>]
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

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, or a threat in a DNS Firewall Advanced rule.

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 .

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 .

Constraints:

  • min: 1
  • max: 256
  • pattern: \*?[-a-zA-Z0-9.]+

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

Constraints:

  • min: 0
  • max: 604800

--block-response (string)

The way that you want DNS Firewall to block the request. Used for the rule action setting BLOCK .

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.

Constraints:

  • min: 1
  • max: 256

--confidence-threshold (string)

The confidence threshold for DNS Firewall Advanced. You must provide this value when you create a DNS Firewall Advanced rule.

Possible values:

  • LOW
  • MEDIUM
  • HIGH

--description (string)

The description for the Firewall rule.

Constraints:

  • min: 1
  • max: 256

--dns-advanced-protection (string)

The type of the DNS Firewall Advanced rule. Valid values are DGA and DNS_TUNNELING.

Possible values:

  • DGA
  • DNS_TUNNELING

--firewall-rule-id (string) [required]

The ID of the DNS Firewall rule.

Constraints:

  • min: 1
  • max: 64
  • pattern: [-.a-zA-Z0-9]+

--name (string)

The name of the DNS Firewall rule.

Constraints:

  • min: 1
  • max: 64
  • pattern: (?!^[0-9]+$)([a-zA-Z0-9-_/' ']+)

--priority (long)

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.

Constraints:

  • min: 1
  • max: 10000

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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
  • yaml
  • yaml-stream

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

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, or a threat in a DNS Firewall Advanced rule.

Possible values:

  • ALLOW
  • ALERT
  • BLOCK

blockOverrideDnsType -> (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 .

Possible values:

  • CNAME

blockOverrideDomain -> (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 .

Constraints:

  • min: 1
  • max: 256
  • pattern: \*?[-a-zA-Z0-9.]+

blockOverrideTtl -> (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 .

Constraints:

  • min: 0
  • max: 604800

blockResponse -> (string)

The way that you want DNS Firewall to block the request. Used for the rule action setting BLOCK .

Possible values:

  • NODATA
  • NXDOMAIN
  • OVERRIDE

confidenceThreshold -> (string)

The confidence threshold for DNS Firewall Advanced. You must provide this value when you create a DNS Firewall Advanced rule.

Possible values:

  • LOW
  • MEDIUM
  • HIGH

createdAt -> (timestamp)

The time and date the Firewall rule was created.

description -> (string)

The description of the Firewall rule.

Constraints:

  • min: 1
  • max: 256

dnsAdvancedProtection -> (string)

The type of the DNS Firewall Advanced rule. Valid values are DGA and DNS_TUNNELING.

Possible values:

  • DGA
  • DNS_TUNNELING

firewallDomainListId -> (string)

The ID of the domain list associated with the Firewall rule.

Constraints:

  • min: 1
  • max: 64
  • pattern: [-.a-zA-Z0-9]+

id -> (string)

The ID of the Firewall rule.

Constraints:

  • min: 1
  • max: 64
  • pattern: [-.a-zA-Z0-9]+

name -> (string)

The name of the Firewall rule.

Constraints:

  • min: 1
  • max: 64
  • pattern: (?!^[0-9]+$)([a-zA-Z0-9-_/' ']+)

priority -> (long)

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.

Constraints:

  • min: 1
  • max: 10000

dnsViewId -> (string)

The ID of the DNS view the Firewall rule is associated with.

Constraints:

  • min: 1
  • max: 64
  • pattern: [-.a-zA-Z0-9]+

queryType -> (string)

The DNS query type you want the rule to evaluate.

Constraints:

  • min: 0
  • max: 16

status -> (string)

The operational status of the firewall rule.

Possible values:

  • CREATING
  • OPERATIONAL
  • UPDATING
  • DELETING

updatedAt -> (timestamp)

The time and date the rule was updated.
© Copyright 2025, Amazon Web Services. Created using Sphinx.