Spec-Zone.ru › AWS CLI v2

[ aws . waf-regional ]

create-rule

Описание

Примечание

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

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

Создаёт Rule, содержащий объекты IPSet, объекты ByteMatchSet и другие предикаты, определяющие запросы, которые вы хотите заблокировать. Если вы добавляете более одного предиката к Rule, запрос должен соответствовать всем условиям, чтобы быть разрешённым или заблокированным. Например, предположим, что вы добавили следующее к Rule:

  • IPSet, который соответствует IP-адресу 192.0.2.44/32
  • ByteMatchSet, который соответствует значению в заголовке BadBot в User-Agent

Затем вы добавляете Rule к WebACL и указываете, что хотите заблокировать запросы, удовлетворяющие условиям Rule. Для блокировки запроса он должен исходить от IP-адреса 192.0.2.44 и заголовок User-Agent в запросе должен содержать значение BadBot.

Чтобы создать и настроить Rule, выполните следующие шаги:

  • Создайте и обновите предикаты, которые вы хотите включить в Rule. Для получения дополнительной информации см. CreateByteMatchSet, CreateIPSet и CreateSqlInjectionMatchSet.
  • Используйте GetChangeToken, чтобы получить маркер изменения, который вы предоставляете в параметре ChangeToken запроса CreateRule.
  • Отправьте запрос CreateRule.
  • Используйте GetChangeToken, чтобы получить маркер изменения, который вы предоставляете в параметре ChangeToken запроса UpdateRule.
  • Отправьте запрос UpdateRule, чтобы указать предикаты, которые вы хотите включить в Rule.
  • Создайте и обновите WebACL, содержащий Rule. Для получения дополнительной информации см. CreateWebACL.

Дополнительную информацию о том, как использовать API AWS WAF для разрешения или блокирования HTTP-запросов, см. в руководстве разработчика AWS WAF.

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

Синтаксис

  create-rule
--name <value>
--metric-name <value>
--change-token <value>
[--tags <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]

Параметры

--name (строка)

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

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

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

--change-token (строка)

Значение, возвращённое последним вызовом GetChangeToken.

--tags (список)

(структура)

Примечание

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

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

Тег, связанный с ресурсом AWS. Теги — это пары ключ:значение, которые вы можете использовать для категоризации и управления вашими ресурсами, например, для выставления счетов. Например, вы можете установить ключ тега на «клиент», а значение — на имя или идентификатор клиента. Вы можете указать один или несколько тегов для добавления к каждому ресурсу AWS, не более 50 тегов для ресурса.

Теги доступны только через API, SDK и CLI. Вы не можете управлять или просматривать теги через консоль AWS WAF Classic. Вы можете добавлять теги к ресурсам AWS, которые вы управляете через AWS WAF Classic: web ACL, группам правил и правилам.

Ключ -> (строка)

Значение -> (строка)

Краткая синтаксическая запись:

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "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
  • 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 (булево)

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

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

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

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

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

Вывод

Правило -> (структура)

Правило, возвращаемое в ответе CreateRule.

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 символов и минимальной длиной один. Оно не может содержать пробелы или имена метрик, зарезервированные AWS WAF, включая «All» и «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.

ChangeToken -> (строка)

ChangeToken, который вы использовали для отправки запроса CreateRule. Вы также можете использовать это значение для запроса статуса запроса. Для получения дополнительной информации см. GetChangeTokenStatus.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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