batch-update-firewall-rule¶

Description¶

Updates multiple DNS firewall rules in a single operation. This is more efficient than updating rules individually.

Synopsis¶

  batch-update-firewall-rule
--firewall-rules <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¶

--firewall-rules (list) [required]

The DNS Firewall rule IDs to be updated.

(structure)

Information for updating a firewall rule in a batch operation.

action -> (string)

The action to take when a DNS query matches the firewall rule.

Possible values:

ALLOW

ALERT

BLOCK

blockOverrideDnsType -> (string)

The DNS record type for the custom response when the action is BLOCK.

Possible values:

CNAME

blockOverrideDomain -> (string)

The custom domain name for the BLOCK response.

Constraints:

min: 1

max: 256

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

blockOverrideTtl -> (integer)

The TTL value for the custom response when the action is BLOCK.

Constraints:

min: 0

max: 604800

blockResponse -> (string)

The type of block response to return when the action is BLOCK.

Possible values:

NODATA

NXDOMAIN

OVERRIDE

confidenceThreshold -> (string)

The confidence threshold for advanced threat detection.

Possible values:

LOW

MEDIUM

HIGH

description -> (string)

A description of the firewall rule.

Constraints:

min: 1

max: 256

dnsAdvancedProtection -> (string)

Whether to enable advanced DNS threat protection for the firewall rule.

Possible values:

DGA

DNS_TUNNELING

firewallRuleId -> (string) [required]

The unique identifier of the firewall rule to update.

Constraints:

min: 1

max: 64

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

name -> (string)

A name for the firewall rule.

Constraints:

min: 1

max: 64

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

priority -> (long)

The priority of the firewall rule.

Constraints:

min: 1

max: 10000

Shorthand Syntax:

action=string,blockOverrideDnsType=string,blockOverrideDomain=string,blockOverrideTtl=integer,blockResponse=string,confidenceThreshold=string,description=string,dnsAdvancedProtection=string,firewallRuleId=string,name=string,priority=long ...

JSON Syntax:

[
  {
    "action": "ALLOW"|"ALERT"|"BLOCK",
    "blockOverrideDnsType": "CNAME",
    "blockOverrideDomain": "string",
    "blockOverrideTtl": integer,
    "blockResponse": "NODATA"|"NXDOMAIN"|"OVERRIDE",
    "confidenceThreshold": "LOW"|"MEDIUM"|"HIGH",
    "description": "string",
    "dnsAdvancedProtection": "DGA"|"DNS_TUNNELING",
    "firewallRuleId": "string",
    "name": "string",
    "priority": long
  }
  ...
]

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

failures -> (list)

High level information about the DNS Firewall rules that failed to update.

(structure)

The result of updating a firewall rule in a batch operation.

firewallRule -> (structure) [required]

The firewall rule that was updated in the batch operation.

action -> (string)

The action configured for the updated firewall rule.

Possible values:

ALLOW

ALERT

BLOCK

blockOverrideDnsType -> (string)

The DNS record type configured for the updated firewall rule’s custom response.

Possible values:

CNAME

blockOverrideDomain -> (string)

The custom domain name configured for the updated firewall rule’s BLOCK response.

Constraints:

min: 1

max: 256

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

blockOverrideTtl -> (integer)

The TTL value configured for the updated firewall rule’s custom response.

Constraints:

min: 0

max: 604800

blockResponse -> (string)

The type of block response configured for the updated firewall rule.

Possible values:

NODATA

NXDOMAIN

OVERRIDE

clientToken -> (string)

The unique string that identified the request and ensured idempotency.

Constraints:

min: 1

max: 256

confidenceThreshold -> (string)

The confidence threshold configured for the updated firewall rule’s advanced threat detection.

Possible values:

LOW

MEDIUM

HIGH

createdAt -> (timestamp)

The date and time when the firewall rule was originally created.

description -> (string)

The description of the updated firewall rule.

Constraints:

min: 1

max: 256

dnsAdvancedProtection -> (string)

Whether advanced DNS threat protection is enabled for the updated firewall rule.

Possible values:

DGA

DNS_TUNNELING

firewallDomainListId -> (string)

The ID of the firewall domain list associated with the updated firewall rule.

Constraints:

min: 1

max: 64

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

id -> (string) [required]

The unique identifier of the updated firewall rule.

Constraints:

min: 1

max: 64

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

name -> (string)

The name of the updated firewall rule.

Constraints:

min: 1

max: 64

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

priority -> (long)

The priority of the updated firewall rule.

Constraints:

min: 1

max: 10000

dnsViewId -> (string)

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

Constraints:

min: 1

max: 64

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

queryType -> (string)

The DNS query type that the updated firewall rule matches.

Constraints:

min: 0

max: 16

status -> (string)

The current status of the updated firewall rule.

Possible values:

CREATING

OPERATIONAL

UPDATING

DELETING

updatedAt -> (timestamp)

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

code -> (integer) [required]

The response code for the update operation.

message -> (string)

The response message for the update operation.

successes -> (list)

High level information about the DNS Firewall rules that were successfully updated.

(structure)

The result of updating a firewall rule in a batch operation.

firewallRule -> (structure) [required]

The firewall rule that was updated in the batch operation.

action -> (string)

The action configured for the updated firewall rule.

Possible values:

ALLOW

ALERT

BLOCK

blockOverrideDnsType -> (string)

The DNS record type configured for the updated firewall rule’s custom response.

Possible values:

CNAME

blockOverrideDomain -> (string)

The custom domain name configured for the updated firewall rule’s BLOCK response.

Constraints:

min: 1

max: 256

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

blockOverrideTtl -> (integer)

The TTL value configured for the updated firewall rule’s custom response.

Constraints:

min: 0

max: 604800

blockResponse -> (string)

The type of block response configured for the updated firewall rule.

Possible values:

NODATA

NXDOMAIN

OVERRIDE

clientToken -> (string)

The unique string that identified the request and ensured idempotency.

Constraints:

min: 1

max: 256

confidenceThreshold -> (string)

The confidence threshold configured for the updated firewall rule’s advanced threat detection.

Possible values:

LOW

MEDIUM

HIGH

createdAt -> (timestamp)

The date and time when the firewall rule was originally created.

description -> (string)

The description of the updated firewall rule.

Constraints:

min: 1

max: 256

dnsAdvancedProtection -> (string)

Whether advanced DNS threat protection is enabled for the updated firewall rule.

Possible values:

DGA

DNS_TUNNELING

firewallDomainListId -> (string)

The ID of the firewall domain list associated with the updated firewall rule.

Constraints:

min: 1

max: 64

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

id -> (string) [required]

The unique identifier of the updated firewall rule.

Constraints:

min: 1

max: 64

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

name -> (string)

The name of the updated firewall rule.

Constraints:

min: 1

max: 64

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

priority -> (long)

The priority of the updated firewall rule.

Constraints:

min: 1

max: 10000

dnsViewId -> (string)

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

Constraints:

min: 1

max: 64

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

queryType -> (string)

The DNS query type that the updated firewall rule matches.

Constraints:

min: 0

max: 16

status -> (string)

The current status of the updated firewall rule.

Possible values:

CREATING

OPERATIONAL

UPDATING

DELETING

updatedAt -> (timestamp)

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

code -> (integer) [required]

The response code for the update operation.

message -> (string)

The response message for the update operation.

Table of Contents

Feedback

User Guide