Spec-Zone.ru › AWS CLI v2

[ aws . waf ]

get-rule

Описание

Примечание

Это документация по AWS WAF Classic. Для получения дополнительной информации см. AWS WAF Classic в руководстве разработчика.

Для последней версии AWS WAF используйте API AWS WAFV2 и см. Руководство разработчика AWS WAF. В последней версии AWS WAF используется единый набор конечных точек для региональных и глобальных применений.

Возвращает правило, заданное в запросе.

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

Синтаксис

  get-rule
--rule-id <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]

Параметры

--rule-id (строка)

Идентификатор правила, которое необходимо получить. Идентификатор возвращается командами CreateRule и ListRules.

--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 (строка)

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

  • on
  • off
  • auto

--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 (логическое)

Отключить вывод через pager для CLI.

--cli-auto-prompt (логическое)

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

--no-cli-auto-prompt (логическое)

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

Вывод

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

Информация о правиле, заданном в запросе. Для получения более подробной информации см. следующие разделы:

  • Rule : Содержит MetricName , Name , массив объектов Predicate и RuleId
  • Predicate : Каждый объект Predicate содержит DataId , Negated и Type

RuleId -> (строка)

Уникальный идентификатор правила. Используйте RuleId для получения дополнительной информации о правиле (см. GetRule), обновление правила (см. UpdateRule), вставка правила в набор правил или удаление из набора правил (см. UpdateWebACL) или удаление правила из AWS WAF (см. DeleteRule).

RuleId возвращается командами CreateRule и ListRules .

Name -> (строка)

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

MetricName -> (строка)

Дружественное имя или описание метрик для этого правила. Имя может содержать только буквенно-цифровые символы (A-Z, a-z, 0-9), максимальную длину 128 и минимальную длину 1. Оно не может содержать пробелы или имена метрик, зарезервированные для AWS WAF, включая «All» и «Default_Action». Вы не можете изменить MetricName после создания правила.

Predicates -> (список)

Объект Predicates содержит по одному элементу Predicate для каждого объекта ByteMatchSet, IPSet или SqlInjectionMatchSet, которые нужно включить в правило.

(структура)

Примечание

Это документация по AWS WAF Classic. Для получения дополнительной информации см. AWS WAF Classic в руководстве разработчика.

Для последней версии AWS WAF используйте API AWS WAFV2 и см. Руководство разработчика AWS WAF. В последней версии AWS WAF используется единый набор конечных точек для региональных и глобальных применений.

Указывает объекты ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet и SizeConstraintSet, которые нужно добавить в правило, и указывает, хотите ли вы инвертировать настройки, например, запросы, которые НЕ происходят с IP-адреса 192.0.2.44.

Negated -> (логическое)

Установите Negated в False, если вы хотите, чтобы AWS WAF разрешал, блокировал или учитывал запросы, основанные на настройках указанного ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet или SizeConstraintSet. Например, если правило включает IP-адрес 192.0.2.44, AWS WAF будет разрешать или блокировать запросы, основанные на этом IP-адресе.

Установите Negated в True, если вы хотите, чтобы AWS WAF разрешал или блокировал запрос, основанные на инвертировании настроек в ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet или SizeConstraintSet. Например, если правило включает IP-адрес 192.0.2.44, AWS WAF будет разрешать, блокировать или учитывать запросы со всех IP-адресов, *кроме* 192.0.2.44.

Type -> (строка)

Тип предиката в правиле, например, ByteMatch или IPSet.

DataId -> (строка)

Уникальный идентификатор предиката в правиле, например, ByteMatchSetId или IPSetId. Идентификатор возвращается соответствующей командой Create или List.

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

Spec-Zone.ru

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