Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . route53globalresolver ]

batch-create-firewall-rule¶

Description¶

Creates multiple DNS firewall rules in a single operation. This is more efficient than creating rules individually when you need to set up multiple rules at once.

Synopsis¶

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

--firewall-rules (list)

The BatchCreateFirewallRuleInputItem objects contain the information for each Firewall rule.

(structure)

Information about a DNS Firewall rule to create in a batch operation.

action -> (string)

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

blockOverrideDnsType -> (string)

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

blockOverrideDomain -> (string)

The custom domain name for the BLOCK response.

blockOverrideTtl -> (integer)

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

blockResponse -> (string)

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

clientToken -> (string)

A unique string that identifies the request and ensures idempotency.

confidenceThreshold -> (string)

The confidence threshold for advanced threat detection.

description -> (string)

A description of the firewall rule.

dnsAdvancedProtection -> (string)

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

firewallDomainListId -> (string)

The ID of the firewall domain list to associate with the rule.

name -> (string)

A name for the firewall rule.

priority -> (long)

The priority of the firewall rule.

dnsViewId -> (string)

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

qType -> (string)

The DNS query type that the firewall rule should match.

Shorthand Syntax:

action=string,blockOverrideDnsType=string,blockOverrideDomain=string,blockOverrideTtl=integer,blockResponse=string,clientToken=string,confidenceThreshold=string,description=string,dnsAdvancedProtection=string,firewallDomainListId=string,name=string,priority=long,dnsViewId=string,qType=string ...

JSON Syntax:

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

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

failures -> (list)

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

(structure)

Information about the result of creating a DNS Firewall rule in a batch operation.

firewallRule -> (structure)

The firewall rule that was created in the batch operation.

action -> (string)

The action configured for the created firewall rule.

blockOverrideDnsType -> (string)

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

blockOverrideDomain -> (string)

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

blockOverrideTtl -> (integer)

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

blockResponse -> (string)

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

clientToken -> (string)

The unique string that identified the request and ensured idempotency.

confidenceThreshold -> (string)

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

createdAt -> (timestamp)

The date and time when the firewall rule was created.

description -> (string)

The description of the created firewall rule.

dnsAdvancedProtection -> (string)

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

firewallDomainListId -> (string)

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

id -> (string)

The unique identifier of the created firewall rule.

managedDomainListName -> (string)

The name of the managed domain list associated with the created firewall rule.

name -> (string)

The name of the created firewall rule.

priority -> (long)

The priority of the created firewall rule.

dnsViewId -> (string)

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

queryType -> (string)

The DNS query type that the created firewall rule matches.

status -> (string)

The current status of the created firewall rule.

updatedAt -> (timestamp)

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

code -> (integer)

The HTTP response code for the batch operation result.

message -> (string)

A message describing the result of the batch operation, including error details if applicable.

successes -> (list)

High level information about the DNS Firewall rules that were created.

(structure)

Information about the result of creating a DNS Firewall rule in a batch operation.

firewallRule -> (structure)

The firewall rule that was created in the batch operation.

action -> (string)

The action configured for the created firewall rule.

blockOverrideDnsType -> (string)

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

blockOverrideDomain -> (string)

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

blockOverrideTtl -> (integer)

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

blockResponse -> (string)

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

clientToken -> (string)

The unique string that identified the request and ensured idempotency.

confidenceThreshold -> (string)

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

createdAt -> (timestamp)

The date and time when the firewall rule was created.

description -> (string)

The description of the created firewall rule.

dnsAdvancedProtection -> (string)

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

firewallDomainListId -> (string)

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

id -> (string)

The unique identifier of the created firewall rule.

managedDomainListName -> (string)

The name of the managed domain list associated with the created firewall rule.

name -> (string)

The name of the created firewall rule.

priority -> (long)

The priority of the created firewall rule.

dnsViewId -> (string)

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

queryType -> (string)

The DNS query type that the created firewall rule matches.

status -> (string)

The current status of the created firewall rule.

updatedAt -> (timestamp)

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

code -> (integer)

The HTTP response code for the batch operation result.

message -> (string)

A message describing the result of the batch operation, including error details if applicable.

Table of Contents

Feedback

User Guide