Spec-Zone.ru › AWS CLI v2

[ aws . wafv2 ]

describe-managed-rule-group

Описание

Предоставляет подробную информацию о управляемом наборе правил, включая описания правил.

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

Синтаксис

  describe-managed-rule-group
--vendor-name <value>
--name <value>
--scope <value>
[--version-name <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]

Параметры

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

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

--name (строка)

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

--scope (строка)

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

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

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

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

  • CLOUDFRONT
  • REGIONAL

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

Версия набора правил. Можно использовать только версию, которая не запланирована к истечению срока действия. Если не указано, WAF использует версию по умолчанию поставщика.

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

Для получения описания управляемого набора правил

Следующий describe-managed-rule-group получает описание управляемого набора правил AWS.

aws wafv2 describe-managed-rule-group \
    --vendor-name AWS \
    --name AWSManagedRulesCommonRuleSet \
    --scope REGIONAL

Вывод:

{
    "Capacity": 700,
    "Rules": [
        {
            "Name": "NoUserAgent_HEADER",
            "Action": {
                "Block": {}
            }
        },
        {
            "Name": "UserAgent_BadBots_HEADER",
            "Action": {
                "Block": {}
            }
        },
        {
            "Name": "SizeRestrictions_QUERYSTRING",
            "Action": {
                "Block": {}
            }
        },
        {
            "Name": "SizeRestrictions_Cookie_HEADER",
            "Action": {
                "Block": {}
            }
        },
        {
            "Name": "SizeRestrictions_BODY",
            "Action": {
                "Block": {}
            }
        },
        {
            "Name": "SizeRestrictions_URIPATH",
            "Action": {
                "Block": {}
            }
        },
        {
            "Name": "EC2MetaDataSSRF_BODY",
            "Action": {
                "Block": {}
            }
        },
        {
            "Name": "EC2MetaDataSSRF_COOKIE",
            "Action": {
                "Block": {}
            }
        },
        {
            "Name": "EC2MetaDataSSRF_URIPATH",
            "Action": {
                "Block": {}
            }
        },
        {
            "Name": "EC2MetaDataSSRF_QUERYARGUMENTS",
            "Action": {
                "Block": {}
            }
        },
        {
            "Name": "GenericLFI_QUERYARGUMENTS",
            "Action": {
                "Block": {}
            }
        },
        {
            }
            "Name": "GenericLFI_URIPATH",
            "Action": {
                "Block": {}
            }
        },
        {
            "Name": "GenericLFI_BODY",
            "Action": {
                "Block": {}
            }
        },
        {
            "Name": "RestrictedExtensions_URIPATH",
            "Action": {
                "Block": {}
            }
        },
        {
            "Name": "RestrictedExtensions_QUERYARGUMENTS",
            "Action": {
                "Block": {}
            }
        },
        {
            "Name": "GenericRFI_QUERYARGUMENTS",
            "Action": {
                "Block": {}
            }
        },
        {
            "Name": "GenericRFI_BODY",
            "Action": {
                "Block": {}
            }
        },
        {
            "Name": "GenericRFI_URIPATH",
            "Action": {
                "Block": {}
            }
        },
        {
            "Name": "CrossSiteScripting_COOKIE",
            "Action": {
                "Block": {}
            }
        },
        {
            "Name": "CrossSiteScripting_QUERYARGUMENTS",
            "Action": {
                "Block": {}
            }
        },
        {
            "Name": "CrossSiteScripting_BODY",
            "Action": {
                "Block": {}
            }
        },
        {
            "Name": "CrossSiteScripting_URIPATH",
            "Action": {
                "Block": {}
            }
        }
    ]
}

Дополнительную информацию см. в разделе Управляемые наборы правил в руководстве разработчика AWS WAF, AWS Firewall Manager и AWS Shield Advanced.

Вывод

VersionName -> (строка)

Версия управляемой группы правил.

SnsTopicArn -> (строка)

Идентификатор ресурса Amazon (ARN) темы Amazon Simple Notification Service (SNS), используемой для уведомлений об изменениях в управляемой группе правил. Вы можете подписаться на тему SNS, чтобы получать уведомления при изменении управляемой группы правил, например, о новых версиях и о завершении срока действия версии. Дополнительную информацию см. в руководстве разработчика Amazon Simple Notification Service.

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

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

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

Rules -> (список)

(структура)

Высокоуровневая информация о правиле, возвращаемая операциями, такими как DescribeManagedRuleGroup. Это предоставляет информацию, такую как идентификатор, который можно использовать для получения и управления RuleGroup, и ARN, который вы предоставляете для RuleGroupReferenceStatement, чтобы использовать группу правил в правиле.

Name -> (строка)

Название правила.

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

Действие, которое WAF должен выполнить с веб-запросом, когда он соответствует утверждению правила. Настройки на уровне веб-ACL могут переопределять настройку действия правила.

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

Указывает WAF заблокировать веб-запрос.

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

Определяет пользовательский ответ на веб-запрос.

Дополнительную информацию о настройке веб-запросов и ответов см. в разделе «Настройка веб-запросов и ответов в WAF» в руководстве разработчика WAF.

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

Код HTTP-статуса, который нужно вернуть клиенту.

Список кодов статуса, которые можно использовать в пользовательских ответах, см. в руководстве разработчика WAF.

CustomResponseBodyKey -> (строка)

Ссылка на тело ответа, которое WAF должен вернуть клиенту веб-запроса. Вы можете определить пользовательский ответ для действия правила или для действия по умолчанию веб-ACL, которое настроено на блокирование. Для этого сначала определите ключ и значение тела ответа в настройке CustomResponseBodies для WebACL или RuleGroup, где вы хотите его использовать. Затем в настройке действия правила или действия по умолчанию веб-ACL BlockAction сошлитесь на тело ответа с помощью этого ключа.

ResponseHeaders -> (список)

HTTP-заголовки, которые нужно использовать в ответе. Вы можете указать любое имя заголовка, кроме content-type. Повторяющиеся имена заголовков не допускаются.

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

(структура)

Пользовательский заголовок для обработки пользовательских запросов и ответов. Используется в CustomResponse и CustomRequestHandling.

Name -> (строка)

Имя пользовательского заголовка.

При вставке WAF заголовка в запрос он добавляет префикс к этому имени x-amzn-waf- для предотвращения путаницы с заголовками, которые уже есть в запросе. Например, для имени заголовка sample WAF вставляет заголовок x-amzn-waf-sample.

Value -> (строка)

Значение пользовательского заголовка.

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

Указывает WAF разрешить веб-запрос.

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

Определяет пользовательскую обработку веб-запроса.

Дополнительную информацию о настройке веб-запросов и ответов см. в разделе «Настройка веб-запросов и ответов в WAF» в руководстве разработчика WAF.

InsertHeaders -> (список)

HTTP-заголовки, которые нужно вставить в запрос. Повторяющиеся имена заголовков не допускаются.

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

(структура)

Пользовательский заголовок для обработки пользовательских запросов и ответов. Используется в CustomResponse и CustomRequestHandling.

Name -> (строка)

Имя пользовательского заголовка.

При вставке WAF заголовка в запрос он добавляет префикс к этому имени x-amzn-waf- для предотвращения путаницы с заголовками, которые уже есть в запросе. Например, для имени заголовка sample WAF вставляет заголовок x-amzn-waf-sample.

Value -> (строка)

Значение пользовательского заголовка.

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

Указывает WAF посчитать веб-запрос и продолжить оценку запроса с оставшимися правилами в веб-ACL.

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

Определяет пользовательскую обработку веб-запроса.

Дополнительную информацию о настройке веб-запросов и ответов см. в разделе «Настройка веб-запросов и ответов в WAF» в руководстве разработчика WAF.

InsertHeaders -> (список)

HTTP-заголовки, которые нужно вставить в запрос. Повторяющиеся имена заголовков не допускаются.

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

(структура)

Пользовательский заголовок для обработки пользовательских запросов и ответов. Используется в CustomResponse и CustomRequestHandling.

Name -> (строка)

Имя пользовательского заголовка.

При вставке WAF заголовка в запрос он добавляет префикс к этому имени x-amzn-waf- для предотвращения путаницы с заголовками, которые уже есть в запросе. Например, для имени заголовка sample WAF вставляет заголовок x-amzn-waf-sample.

Value -> (строка)

Значение пользовательского заголовка.

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

Указывает WAF выполнить проверку CAPTCHA на веб-запрос.

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

Определяет пользовательскую обработку веб-запроса, если проверка CAPTCHA определяет, что токен запроса действителен и не истек.

Дополнительную информацию о настройке веб-запросов и ответов см. в разделе «Настройка веб-запросов и ответов в WAF» в руководстве разработчика WAF.

InsertHeaders -> (список)

HTTP-заголовки, которые нужно вставить в запрос. Повторяющиеся имена заголовков не допускаются.

(структура)

Пользовательский заголовок для обработки пользовательских запросов и ответов. Используется в CustomResponse и CustomRequestHandling.

Name -> (строка)

Имя пользовательского заголовка.

При вставке WAF заголовка в запрос он добавляет префикс к этому имени x-amzn-waf- для предотвращения путаницы с заголовками, которые уже есть в запросе. Например, для имени заголовка sample WAF вставляет заголовок x-amzn-waf-sample.

Value -> (строка)

Значение пользовательского заголовка.

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

Указывает WAF выполнить проверку Challenge на веб-запрос.

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

Определяет пользовательскую обработку веб-запроса, если проверка challenge определяет, что токен запроса действителен и не истек.

Дополнительную информацию о настройке веб-запросов и ответов см. в разделе «Настройка веб-запросов и ответов в WAF» в руководстве разработчика WAF.

InsertHeaders -> (список)

HTTP-заголовки, которые нужно вставить в запрос. Повторяющиеся имена заголовков не допускаются.

(структура)

Пользовательский заголовок для обработки пользовательских запросов и ответов. Используется в CustomResponse и CustomRequestHandling.

Name -> (строка)

Имя пользовательского заголовка.

При вставке WAF заголовка в запрос он добавляет префикс к этому имени x-amzn-waf- для предотвращения путаницы с заголовками, которые уже есть в запросе. Например, для имени заголовка sample WAF вставляет заголовок x-amzn-waf-sample.

Value -> (строка)

Значение пользовательского заголовка.

LabelNamespace -> (строка)

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

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

AvailableLabels -> (список)

Метки, которые добавляют одно или несколько правил в этой группе правил к соответствующим веб-запросам. Эти метки определены в RuleLabels правила.

(структура)

Список меток, используемых одним или несколькими правилами RuleGroup. Этот сводный объект используется для следующих списков групп правил:

  • AvailableLabels - Метки, которые правила добавляют к соответствующим запросам. Эти метки определены в RuleLabels правила.
  • ConsumedLabels - Метки, по которым правила ищут соответствия. Эти метки определены в спецификации LabelMatchStatement в определении утверждения правила.

Name -> (строка)

Спецификация отдельной метки.

ConsumedLabels -> (список)

Метки, по которым одно или несколько правил в этой группе правил ищут соответствие в утверждениях о соответствии меткам. Эти метки определены в спецификации LabelMatchStatement в определении утверждения правила.

(структура)

Список меток, используемых одним или несколькими правилами RuleGroup. Этот сводный объект используется для следующих списков групп правил:

  • AvailableLabels - Метки, которые правила добавляют к соответствующим запросам. Эти метки определены в RuleLabels правила.
  • ConsumedLabels - Метки, по которым правила ищут соответствие. Эти метки определены в спецификации LabelMatchStatement в определении утверждения правила.

Name -> (строка)

Спецификация отдельной метки.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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