Модуль community.aws.waf_info — получение информации об ACL, правилах, условиях и фильтрах WAF
Примечание
Этот модуль входит в коллекцию community.aws (версия 10.1.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.aws. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: community.aws.waf_info.
Добавлено в community.aws 1.0.0
УСТАРЕЛО
- Удалено в:
-
версии 12.0.0
- Причина:
-
Amazon прекратила поддержку сервиса «WAF Classic».
- Альтернатива:
-
Вместо него используйте сервис и модули «AWS WAF (WAFv2)».
Краткое описание
- Получение информации об ACL, правилах, условиях и фильтрах WAF.
- До выпуска версии 5.0.0 этот модуль назывался
community.aws.aws_waf_info. Использование не изменилось.
Псевдонимы: aws_waf_info
Требования
На узле, выполняющем этот модуль, должны быть установлены перечисленные ниже компоненты.
- python >= 3.6
- boto3 >= 1.34.0
- botocore >= 1.34.0
Параметры
Параметр | Комментарии |
|---|---|
access_key псевдонимы: aws_access_key_id, aws_access_key строка | Идентификатор ключа доступа AWS. Дополнительную информацию о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды Параметры aws_access_key и profile являются взаимоисключающими. Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для согласованности с AWS botocore SDK. |
aws_ca_bundle путь | Путь к пакету центров сертификации, используемому для проверки SSL-сертификатов. Также можно использовать переменную среды |
aws_config словарь | Словарь для изменения конфигурации botocore. Параметры перечислены в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
debug_botocore_endpoint_logs логическое значение | Использовать регистратор Также можно использовать переменную среды Варианты:
|
endpoint_url псевдонимы: aws_endpoint_url строка | URL для подключения вместо конечных точек AWS по умолчанию. Хотя этот параметр можно использовать для подключения к другим сервисам, совместимым с AWS, коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную среды |
name строка | Имя межсетевого экрана веб-приложений. |
profile псевдонимы: aws_profile строка | Именованный профиль AWS для аутентификации. Дополнительную информацию об именованных профилях см. в документации AWS: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также можно использовать переменную среды Параметр profile является взаимоисключающим с параметрами aws_access_key, aws_secret_key и session_token. |
region псевдонимы: aws_region строка | Регион AWS для использования. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также можно использовать переменную среды Дополнительную информацию см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. |
secret_key псевдонимы: aws_secret_access_key, aws_secret_key строка | Секретный ключ доступа AWS. Дополнительную информацию о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды Параметры secret_key и profile являются взаимоисключающими. Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для согласованности с AWS botocore SDK. |
session_token псевдонимы: aws_session_token строка | Токен сеанса AWS STS для использования с временными учетными данными. Дополнительную информацию о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменную среды Параметры session_token и profile являются взаимоисключающими. |
validate_certs логическое значение | Если задано значение Настоятельно не рекомендуется задавать validate_certs=false; вместо этого рассмотрите возможность задать параметр aws_ca_bundle. Варианты:
|
waf_regional логическое значение | Использовать ли модуль Варианты:
|
Примечания
Примечание
- Внимание: Для модулей переменные среды и файлы конфигурации считываются из контекста «узла» Ansible, а не из контекста «контроллера». Поэтому может потребоваться явно скопировать файлы на «узел». Для плагинов поиска и подключения переменные среды и файлы конфигурации считываются из контекста «контроллера» Ansible, а не из контекста «узла».
- Используемый Ansible пакет AWS SDK (boto3) также может считывать значения по умолчанию для учетных данных и других параметров, например региона, из файлов конфигурации в контексте «узла» Ansible (обычно
~/.aws/credentials). Дополнительную информацию см. на странице https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.
Примеры
- name: obtain all WAF information
community.aws.waf_info:
- name: obtain all information for a single WAF
community.aws.waf_info:
name: test_waf
- name: obtain all information for a single WAF Regional
community.aws.waf_info:
name: test_waf
waf_regional: true
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
wafs сложный тип | WAF, соответствующие переданным аргументам. Возвращается: при успешном выполнении |
|
default_action целое число |
Действие, которое выполняется, если ни одно из правил, содержащихся в WebACL, не соответствует запросу. Возвращается: всегда Пример: |
|
metric_name строка |
Понятное имя или описание метрик для этого WebACL. Возвращается: всегда Пример: |
|
name строка |
Понятное имя или описание WebACL. Возвращается: всегда Пример: |
|
rules сложный тип |
Массив, содержащий действие для каждого правила в WebACL и приоритет этого правила. Возвращается: всегда |
|
action строка |
Действие, которое выполняется при совпадении правила. Возвращается: всегда Пример: |
|
metric_name строка |
Понятное имя или описание метрик для этого правила. Возвращается: всегда Пример: |
|
name строка |
Понятное имя или описание правила. Возвращается: всегда Пример: |
|
predicates список / элементы=строка |
Список Predicates содержит Predicate для каждого объекта ByteMatchSet, IPSet, SizeConstraintSet, SqlInjectionMatchSet или XssMatchSet в правиле. Возвращается: всегда Пример: |
Статус
- Этот модуль будет удален в версии 12.0.0. [устарело]
- Дополнительную информацию см. в разделе УСТАРЕЛО.
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/aws/waf_info_module.html