Spec-Zone.ru › AWS CLI v2

[ aws . wafv2 ]

создание набора шаблонов регулярных выражений

Описание

Создаёт RegexPatternSet, который вы используете в RegexPatternSetReferenceStatement, чтобы WAF проверял компонент веб-запроса на наличие указанных шаблонов.

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

Синтаксис

  create-regex-pattern-set
--name <value>
--scope <value>
[--description <value>]
--regular-expression-list <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 (строка)

Имя набора. Вы не можете изменить имя после создания набора.

--scope (строка)

Указывает, относится ли набор к глобальному типу ресурса, например, к распределению Amazon CloudFront. Для приложения Amplify используйте CLOUDFRONT.

Для работы с CloudFront необходимо также указать регион США Восточный (Северная Вирджиния) следующим образом:

  • CLI - Укажите регион при использовании области CloudFront: --scope=CLOUDFRONT --region=us-east-1.
  • API и SDK - Для всех вызовов используйте конечную точку региона us-east-1.

Возможные значения:

  • CLOUDFRONT
  • REGIONAL

--description (строка)

Описание набора, помогающее в идентификации.

--regular-expression-list (список)

Массив строк регулярных выражений.

(структура)

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

RegexString -> (строка)

Строка, представляющая регулярное выражение.

Сокращённый синтаксис:

RegexString=string ...

Синтаксис JSON:

[
  {
    "RegexString": "string"
  }
  ...
]

--tags (список)

Массив пар ключ:значение для ассоциации с ресурсом.

(структура)

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

Вы можете маркировать управляемые вами ресурсы Amazon Web Services с помощью WAF: правила ACL, группы правил, наборы IP и наборы шаблонов регулярных выражений. Вы не можете управлять или просматривать теги через консоль WAF.

Key -> (строка)

Часть пары ключ:значение, определяющей тег. Вы можете использовать ключ тега для описания категории информации, например, «клиент». Ключи тегов чувствительны к регистру.

Value -> (строка)

Часть пары ключ:значение, определяющей тег. Вы можете использовать значение тега для описания конкретного значения в категории, например, «companyA» или «companyB». Значения тегов чувствительны к регистру.

Сокращённый синтаксис:

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

Для создания набора шаблонов регулярных выражений для использования в ваших правилах ACL и группах правил

Следующая create-regex-pattern-set команда создаёт набор шаблонов регулярных выражений с двумя указанными шаблонами регулярных выражений.

aws wafv2 create-regex-pattern-set \
    --name regexPatterSet01 \
    --scope REGIONAL \
    --description 'Test web-acl' \
    --regular-expression-list '[{"RegexString": "/[0-9]*/"},{"RegexString": "/[a-z]*/"}]'

Вывод:

{
    "Summary":{
        "ARN":"arn:aws:wafv2:us-west-2:123456789012:regional/regexpatternset/regexPatterSet01/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
        "Description":"Test web-acl",
        "Name":"regexPatterSet01",
        "LockToken":"0bc01e21-03c9-4b98-9433-6229cbf1ef1c",
        "Id":"a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
    }
}

Дополнительную информацию см. в разделах Наборы IP и наборы шаблонов регулярных выражений в Руководстве разработчика AWS WAF, AWS Firewall Manager и AWS Shield Advanced.

Вывод

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

Общая информация о RegexPatternSet, возвращаемая операциями, такими как создание и перечисление. Она содержит информацию, такую как ID, который вы можете использовать для извлечения и управления RegexPatternSet, и ARN, который вы предоставляете RegexPatternSetReferenceStatement для использования набора шаблонов в правиле.

Name -> (строка)

Имя экземпляра типа данных. Вы не можете изменить имя после создания экземпляра.

Id -> (строка)

Уникальный идентификатор набора. Этот идентификатор возвращается в ответах на команды создания и перечисления. Вы предоставляете его для операций обновления и удаления.

Description -> (строка)

Описание набора, помогающее в идентификации.

LockToken -> (строка)

Токен, используемый для оптимистической блокировки. WAF возвращает токен вашему get и list запросам, чтобы отметить состояние сущности на момент запроса. Чтобы внести изменения в сущность, связанную с токеном, вы предоставляете токен таким операциям, как update и delete. WAF использует токен, чтобы убедиться, что с момента последнего извлечения сущности не было внесено никаких изменений. Если изменения были внесены, обновление завершается с WAFOptimisticLockException. В этом случае выполните ещё одно get и используйте новый токен, возвращённый этой операцией.

ARN -> (строка)

Amazon Resource Name (ARN) сущности.

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

Spec-Zone.ru

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