Spec-Zone.ru › AWS CLI v2

[ aws . wafv2 ]

получить-настроенный-набор-правил

Описание

Получает указанный настроенный набор правил.

Примечание

Это предназначено только для использования поставщиками настроенных наборов правил. Поставщиками являются Amazon Web Services и продавцы в Amazon Web Services Marketplace.

Поставщики, вы можете использовать API настроенных наборов правил, чтобы обеспечить контролируемое развертывание ваших версионированных предложений настроенных групп правил для ваших клиентов. API являются ListManagedRuleSets , GetManagedRuleSet , PutManagedRuleSetVersions и UpdateManagedRuleSetVersionExpiryDate .

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

Синтаксис

  get-managed-rule-set
--name <value>
--scope <value>
--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]

Параметры

--name (строка)

Название настроенного набора правил. Вы используете его вместе с идентификатором набора правил для идентификации набора правил.

Это имя присваивается соответствующей настроенной группе правил, к которой ваши клиенты могут получить доступ и использовать.

--scope (строка)

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

Для работы с CloudFront вы также должны указать регион US East (N. Вирджиния), как указано ниже:

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

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

  • CLOUDFRONT
  • REGIONAL

--id (строка)

Уникальный идентификатор настроенного набора правил. Идентификатор возвращается в ответах на команды, такие как list . Вы предоставляете его для операций, таких как get и update .

--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-auto-prompt (булево)

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

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

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

Вывод

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

Запрошенный настроенный набор правил.

Name -> (строка)

Название настроенного набора правил. Вы используете его вместе с идентификатором набора правил для идентификации набора правил.

Это имя присваивается соответствующей настроенной группе правил, к которой ваши клиенты могут получить доступ и использовать.

Id -> (строка)

Уникальный идентификатор настроенного набора правил. Идентификатор возвращается в ответах на команды, такие как list . Вы предоставляете его для операций, таких как get и update .

ARN -> (строка)

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

Description -> (строка)

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

PublishedVersions -> (отображение)

Версии этого настроенного набора правил, доступные для использования клиентами.

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

значение -> (структура)

Информация для одной версии настроенного набора правил.

Примечание

Это предназначено только для использования поставщиками настроенных наборов правил. Поставщиками являются Amazon Web Services и продавцы в Amazon Web Services Marketplace.

Поставщики, вы можете использовать API настроенных наборов правил, чтобы обеспечить контролируемое развертывание ваших версионированных предложений настроенных групп правил для ваших клиентов. API являются ListManagedRuleSets , GetManagedRuleSet , PutManagedRuleSetVersions и UpdateManagedRuleSetVersionExpiryDate .

AssociatedRuleGroupArn -> (строка)

Amazon Resource Name (ARN) группы правил поставщика, используемой для определения опубликованной версии вашей настроенной группы правил.

Capacity -> (целое число)

Web ACL емкостные единицы (WCU), необходимые для этой группы правил.

WAF использует WCU для расчета и управления оперативными ресурсами, которые используются для запуска ваших правил, групп правил и web ACL. WAF вычисляет емкость по-разному для каждого типа правил, чтобы отразить относительную стоимость каждого правила. Простые правила, которые стоят недорого, используют меньше WCU, чем более сложные правила, которые используют больше вычислительной мощности. Емкость группы правил фиксируется при создании, что помогает пользователям планировать использование WCU web ACL при использовании группы правил. Дополнительную информацию см. в разделе «Емкостные единицы WAF web ACL (WCU)» в «Руководстве разработчика WAF».

ForecastedLifetime -> (целое число)

Время, которое вы ожидаете, что эта версия вашей настроенной группы правил просуществует в днях.

PublishTimestamp -> (отметка времени)

Время, когда вы впервые опубликовали эту версию.

Время представлено в формате Coordinated Universal Time (UTC). Формат UTC включает специальный обозначитель Z. Например, «2016-09-27T14:50Z».

LastUpdateTimestamp -> (отметка времени)

Последнее время обновления этой версии.

Время представлено в формате Coordinated Universal Time (UTC). Формат UTC включает специальный обозначитель Z. Например, «2016-09-27T14:50Z».

ExpiryTimestamp -> (отметка времени)

Время истечения действия этой версии.

Время представлено в формате Coordinated Universal Time (UTC). Формат UTC включает специальный обозначитель Z. Например, «2016-09-27T14:50Z».

RecommendedVersion -> (строка)

Версия, которую вы хотели бы, чтобы ваши клиенты использовали.

LabelNamespace -> (строка)

Префикс имени пространства меток для настроенных групп правил, предлагаемых клиентам из этого настроенного набора правил. Все метки, добавленные правилами в настроенной группе правил, имеют этот префикс.

  • Синтаксис префикса имени пространства меток для настроенной группы правил следующий: awswaf:managed:<vendor>:<rule group name> :
  • Когда правило с меткой соответствует веб-запросу, WAF добавляет полное квалифицированное имя метки в запрос. Полное квалифицированное имя метки состоит из имени пространства меток из группы правил или web ACL, где определено правило, и метки из правила, разделенные двоеточием: <label namespace>:<label from rule>

LockToken -> (строка)

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

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

Spec-Zone.ru

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