Spec-Zone.ru › AWS CLI v2

[ aws . waf-regional ]

get-rule

Описание

Примечание

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

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

Возвращает Правило, которое определяется по RuleId, включенному в запрос GetRule.

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

Синтаксис

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

Идентификатор Правила, которое требуется получить. RuleId возвращается командами 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-адреса команды на предоставленный.

--no-verify-ssl (логическое значение)

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

--no-paginate (логическое значение)

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

--output (строка)

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

  • json
  • текст
  • таблица
  • 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.

Вывод

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

Информация о Правиле, указанном в запросе GetRule. Дополнительную информацию см. в следующих разделах:

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

RuleId -> (строка)

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

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

Name -> (строка)

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

MetricName -> (строка)

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

Predicates -> (список)

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

(структура)

Примечание

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

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

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

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

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

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

Type -> (строка)

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

DataId -> (строка)

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

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

Spec-Zone.ru

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