put-logging-configuration
Описание
Примечание
Это документация по AWS WAF Classic. Для получения дополнительной информации см. AWS WAF Classic в руководстве разработчика.
Связывает LoggingConfiguration со специфицированным веб-ACL.
Вы можете получить информацию обо всем трафике, который инспектирует AWS WAF, выполнив следующие действия:
- Создайте Amazon Kinesis Data Firehose. Создайте Data Firehose с PUT-источником и в регионе, в котором вы работаете. Однако, если вы собираете логи для Amazon CloudFront, всегда создавайте Firehose в регионе США Восточный (Северная Вирджиния).
Примечание
Не создавайте Data Firehose, используяKinesis stream в качестве источника.- Свяжите этот Firehose с вашим веб-ACL с помощью запроса
PutLoggingConfiguration.
После успешного включения ведения журнала с помощью запроса PutLoggingConfiguration, AWS WAF создаст роль службы с необходимыми разрешениями для записи логов в Amazon Kinesis Data Firehose. Для получения дополнительной информации см. Ведение журнала информации о трафике веб-ACL в Руководстве разработчика AWS WAF.
См. также: AWS API Documentation
Синтаксис
put-logging-configuration
--logging-configuration <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]
Параметры
--logging-configuration (структура)
Amazon Kinesis Data Firehose, который содержит информацию о проинспектированном трафике, данные замаскированных полей и Amazon Resource Name (ARN) веб-ACL для мониторинга.
Примечание
При указанииType в RedactedFields, необходимо использовать одно из следующих значений: URI , QUERY_STRING , HEADER или METHOD.ResourceArn -> (строка)
LogDestinationConfigs.LogDestinationConfigs -> (список)
Массив Amazon Kinesis Data Firehose ARN.
(строка)
RedactedFields -> (список)
Части запроса, которые вы хотите замаскировать в логах. Например, если вы замаскируете поле cookie, поле cookie в Firehose будет xxx.
(структура)
Примечание
Это документация по AWS WAF Classic. Для получения дополнительной информации см. AWS WAF Classic в руководстве разработчика.
Указывает, где в веб-запросе искать TargetString.
Type -> (строка)
Часть веб-запроса, которую вы хотите, чтобы AWS WAF искал указанную строку. Части запроса, которые можно искать, включают следующие:
-
HEADER: Указанный заголовок запроса, например, значение заголовкаUser-AgentилиReferer. Если вы выберетеHEADERдля типа, укажите имя заголовка вData. -
METHOD: Метод HTTP, который указывает тип операции, которую запрос просит выполнить источнику. Amazon CloudFront поддерживает следующие методы:DELETE,GET,HEAD,OPTIONS,PATCH,POSTиPUT. -
QUERY_STRING: Строка запроса, которая является частью URL, появляющейся после символа?, если таковой имеется. -
URI: Часть веб-запроса, которая идентифицирует ресурс, например,/images/daily-ad.jpg. -
BODY: Часть запроса, которая содержит дополнительные данные, которые вы хотите отправить на ваш веб-сервер в качестве тела HTTP-запроса, такие как данные из формы. Тело запроса следует сразу после заголовков запроса. Обратите внимание, что только первые8192байт тела запроса передаются AWS WAF для проверки. Для разрешения или блокирования запросов на основе длины тела можно создать набор ограничений размера. Для получения дополнительной информации см. CreateSizeConstraintSet. -
SINGLE_QUERY_ARG: Параметр в строке запроса, который будет проверен, например, ИмяПользователя или РегионПродаж. Максимальная длина дляSINGLE_QUERY_ARGсоставляет 30 символов. -
ALL_QUERY_ARGS: АналогичноSINGLE_QUERY_ARG, но вместо проверки одного параметра AWS WAF проверит все параметры в строке запроса на значение или шаблон regex, который вы укажете вTargetString.
Data -> (строка)
Когда значение Type равно HEADER, введите имя заголовка, который вы хотите, чтобы AWS WAF искал, например, User-Agent или Referer. Наименование заголовка не учитывает регистр.
Когда значение Type равно SINGLE_QUERY_ARG, введите имя параметра, который вы хотите, чтобы AWS WAF искал, например, UserName или SalesRegion. Наименование параметра не учитывает регистр.
Если значение Type — любое другое значение, опустите Data.
Сокращенный синтаксис:
ResourceArn=string,LogDestinationConfigs=string,string,RedactedFields=[{Type=string,Data=string},{Type=string,Data=string}]
Синтаксис JSON:
{
"ResourceArn": "string",
"LogDestinationConfigs": ["string", ...],
"RedactedFields": [
{
"Type": "URI"|"QUERY_STRING"|"HEADER"|"METHOD"|"BODY"|"SINGLE_QUERY_ARG"|"ALL_QUERY_ARGS",
"Data": "string"
}
...
]
}
--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
- таблица
- yaml
- yaml-поток
--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.
Примеры
Примечание
Для использования следующих примеров необходимо установить и настроить AWS CLI. Для получения дополнительной информации см. руководство по началу работы в Руководстве пользователя AWS CLI.
Если не указано иное, все примеры используют правила цитирования, похожие на Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей терминальной среды. См. Использование кавычек со строками в Руководстве пользователя AWS CLI.
Для создания конфигурации ведения журнала для ARN веб-ACL со указанным ARN потока Kinesis Firehose
Следующий put-logging-configuration пример отображает конфигурацию ведения журнала для WAF с CloudFront.
aws waf put-logging-configuration \
--logging-configuration ResourceArn=arn:aws:waf::123456789012:webacl/3bffd3ed-fa2e-445e-869f-a6a7cf153fd3,LogDestinationConfigs=arn:aws:firehose:us-east-1:123456789012:deliverystream/aws-waf-logs-firehose-stream,RedactedFields=[]
Вывод:
{
"LoggingConfiguration": {
"ResourceArn": "arn:aws:waf::123456789012:webacl/3bffd3ed-fa2e-445e-869f-a6a7cf153fd3",
"LogDestinationConfigs": [
"arn:aws:firehose:us-east-1:123456789012:deliverystream/aws-waf-logs-firehose-stream"
]
}
}
Вывод
LoggingConfiguration -> (структура)
Конфигурация ведения журнала, переданная в запросе.
ResourceArn -> (строка)
LogDestinationConfigs .LogDestinationConfigs -> (список)
Массив идентификаторов ресурсов Amazon Kinesis Data Firehose.
(строка)
RedactedFields -> (список)
Части запроса, которые требуется скрыть в логах. Например, если вы скрываете поле cookie, поле cookie в Firehose будет xxx .
(структура)
Примечание
Это документация для AWS WAF Classic. Дополнительную информацию см. в руководстве разработчика для AWS WAF Classic.
Указывает, где в веб-запросе искать TargetString .
Type -> (строка)
Часть веб-запроса, которую AWS WAF должен искать для указанной строки. Вы можете искать в следующих частях запроса:
-
HEADER: Указанный заголовок запроса, например, значение заголовкаUser-AgentилиReferer. Если вы выбралиHEADERдля типа, укажите имя заголовка вData. -
METHOD: Метод HTTP, указывающий тип операции, которую запрос просит выполнить исходному серверу. Amazon CloudFront поддерживает следующие методы:DELETE,GET,HEAD,OPTIONS,PATCH,POSTиPUT. -
QUERY_STRING: Строка запроса, которая представляет собой часть URL, расположенную после символа?, если таковой имеется. -
URI: Часть веб-запроса, идентифицирующая ресурс, например,/images/daily-ad.jpg. -
BODY: Часть запроса, содержащая дополнительные данные, которые вы хотите отправить на свой веб-сервер в качестве тела HTTP-запроса, например, данные из формы. Тело запроса следует непосредственно за заголовками запроса. Обратите внимание, что AWS WAF для проверки передает только первые8192байтов тела запроса. Чтобы разрешать или блокировать запросы на основе длины тела, вы можете создать набор ограничений размера. Дополнительные сведения см. в разделе CreateSizeConstraintSet . -
SINGLE_QUERY_ARG: Параметр в строке запроса, который вы хотите проверить, например, UserName или SalesRegion. Максимальная длинаSINGLE_QUERY_ARGсоставляет 30 символов. -
ALL_QUERY_ARGS: АналогичноSINGLE_QUERY_ARG, но вместо проверки одного параметра AWS WAF проверит все параметры в строке запроса на значение или шаблон регулярного выражения, указанные вTargetString.
Data -> (строка)
Если значение Type равно HEADER , введите имя заголовка, который вы хотите, чтобы AWS WAF искал, например, User-Agent или Referer . Название заголовка не чувствительно к регистру.
Если значение Type равно SINGLE_QUERY_ARG , введите имя параметра, который вы хотите, чтобы AWS WAF искал, например, UserName или SalesRegion . Название параметра не чувствительно к регистру.
Если значение Type имеет другое значение, опустите Data .
© Copyright 2025, Amazon Web Services. Created using Sphinx.