Spec-Zone.ru › AWS CLI v2

[ aws . network-firewall ]

describe-logging-configuration

Описание

Возвращает конфигурацию ведения журнала для указанного файрволла.

См. также: Документация AWS API

Синтаксис

  describe-logging-configuration
[--firewall-arn <value>]
[--firewall-name <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]

Параметры

--firewall-arn (строка)

Amazon Resource Name (ARN) файрволла.

Вы должны указать ARN или имя, и вы можете указать оба.

--firewall-name (строка)

Дескриптивное имя файрволла. Вы не можете изменить имя файрволла после его создания.

Вы должны указать ARN или имя, и вы можете указать оба.

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON следует формату, предоставленному в --generate-cli-skeleton. Если другие аргументы предоставляются в командной строке, эти значения переопределят значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного в JSON, так как строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит каркас JSON в стандартный вывод без отправки запроса к API. Если предоставлено значение без значения или значение input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, он выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, он проверит входные данные команды и вернёт пример выходного JSON для этой команды. Сгенерированный каркас JSON нестабилен между версиями AWS CLI и нет гарантий обратной совместимости в сгенерированном каркасе JSON.

Глобальные параметры

--debug (булево)

Включить отладку ведения журнала.

--endpoint-url (строка)

Переопределить URL по умолчанию команды заданным URL.

--no-verify-ssl (булево)

По умолчанию AWS CLI использует SSL при общении с сервисами AWS. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.

--no-paginate (булево)

Отключить автоматическую постраничность. Если автоматическая постраничность отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования для вывода команд.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определённый профиль из вашего файла аутентификации.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

  • вкл
  • выкл
  • авто

--no-sign-request (булево)

Не подписывать запросы. Кредиты не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Файл сертификатов CA для использования при проверке SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и без таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и без таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены в виде закодированной в base64 строки. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, отображающего двоичный блок, fileb:// всегда будет обрабатываться как двоичный и использовать содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть правильно отформатировано для настроенного cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (булево)

Отключить пейджер CLI для вывода.

--cli-auto-prompt (булево)

Автоматически запросить параметры ввода CLI.

--no-cli-auto-prompt (булево)

Отключить автоматическое запроса параметров ввода CLI.

Вывод

FirewallArn -> (строка)

Amazon Resource Name (ARN) файрволла.

LoggingConfiguration -> (структура)

Определяет, как Network Firewall выполняет ведение журнала для файрволла.

LogDestinationConfigs -> (список)

Определяет места назначения ведения журнала для журналов для файрволла. Network Firewall генерирует журналы для правил с состоянием.

(структура)

Определяет, куда Network Firewall отправляет журналы для файрволла для одного типа журнала. Используется в LoggingConfiguration. Вы можете отправлять каждый тип журнала в базу данных Amazon S3, группу журналов CloudWatch или поток доставки Firehose.

Network Firewall генерирует журналы для правил с состоянием. Вы можете сохранять типы журналов об оповещениях, потоках и TLS.

LogType -> (строка)

Тип журнала для записи. Вы можете записывать следующие типы журналов из своего движка Network Firewall с состоянием.

  • ALERT - Журналы для трафика, который соответствует вашим правилам с состоянием и имеет действие, отправляющее оповещение. Правило с состоянием отправляет оповещения для действий правила DROP, ALERT и REJECT. Для получения дополнительной информации, см. StatefulRule.
  • FLOW - Стандартные журналы потоков сетевого трафика. Движок правил с состоянием записывает журналы потоков для всего сетевого трафика, который он получает. Каждый запись журнала потока захватывает сетевой поток для конкретной стандартной группы правил без состояния.
  • TLS - Журналы событий, связанных с инспекцией TLS. Для получения дополнительной информации см. Инспекция SSL/TLS-трафика с конфигурациями инспекции TLS в Руководстве разработчика Network Firewall.

LogDestinationType -> (строка)

Тип места хранения назначения для отправки этих журналов. Вы можете отправлять журналы в базу данных Amazon S3, группу журналов CloudWatch или поток доставки Firehose.

LogDestination -> (массив)

Именованное местоположение для журналов, предоставленное в отображении ключ:значение, специфичное для выбранного типа назначения.

  • Для базы данных Amazon S3 укажите имя ведра, с ключом bucketName, и необязательно укажите префикс с ключом prefix. Следующий пример указывает базу данных Amazon S3 с именем DOC-EXAMPLE-BUCKET и префиксом alerts : "LogDestination": { "bucketName": "DOC-EXAMPLE-BUCKET", "prefix": "alerts" }
  • Для группы журналов CloudWatch укажите имя группы журналов CloudWatch, с ключом logGroup. Следующий пример указывает группу журналов с именем alert-log-group : "LogDestination": { "logGroup": "alert-log-group" }
  • Для потока доставки Firehose укажите имя потока доставки, с ключом deliveryStream. Следующий пример указывает поток доставки с именем alert-delivery-stream : "LogDestination": { "deliveryStream": "alert-delivery-stream" }

key -> (строка)

value -> (строка)

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API