Spec-Zone.ru › Ansible

community.aws.waf_info модуль – Получение информации о WAF ACL, правилах, условиях и фильтрах

Примечание

Этот модуль входит в коллекцию community.aws (версия 8.0.0).

У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.aws. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.

Для использования в книге задач укажите: community.aws.waf_info.

Добавлена в community.aws 1.0.0

  • Описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Описание

  • Получение информации о WAF ACL, правилах, условиях и фильтрах.
  • До версии 5.0.0 этот модуль назывался community.aws.aws_waf_info. Способ использования не изменился.

Псевдонимы: aws_waf_info

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

  • python >= 3.6
  • boto3 >= 1.26.0
  • botocore >= 1.29.0

Параметры

Параметр

Комментарии

access_key

псевдонимы: aws_access_key_id, aws_access_key, ec2_access_key

строка

ID ключа доступа AWS.

Дополнительную информацию о маркерах доступа см. в документации AWS https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также можно использовать переменные среды AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY в порядке убывания приоритета.

Параметры aws_access_key и profile взаимоисключают друг друга.

Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore.

Псевдоним ec2_access_key устарел и будет удалён в релизе после 2024-12-01.

Поддержка переменной среды EC2_ACCESS_KEY устарела и будет удалена в релизе после 2024-12-01.

aws_ca_bundle

путь

Расположение файла CA Bundle для проверки SSL-сертификатов.

Также можно использовать переменную среды AWS_CA_BUNDLE.

aws_config

словарь

Словарь для изменения настроек botocore.

Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

debug_botocore_endpoint_logs

логический

Использовать botocore.endpoint логгер для анализа уникальных (а не общих) "resource:action" API-вызовов, сделанных во время задачи, выводимых в ключ resource_actions результатов задачи. Используйте aws_resource_action обратный вызов для вывода общего списка, сделанного во время выполнения плейбука.

Также можно использовать переменную среды ANSIBLE_DEBUG_BOTOCORE_LOGS.

Варианты:

  • false ← (по умолчанию)
  • true

endpoint_url

псевдонимы: ec2_url, aws_endpoint_url, s3_url

строка

URL для подключения вместо стандартных конечных точек AWS. Хотя это можно использовать для подключения к другим службам, совместимым с AWS, коллекции amazon.aws и community.aws протестированы только для AWS.

Также можно использовать переменные среды AWS_URL или EC2_URL в порядке убывания приоритета.

Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01.

Поддержка переменной среды EC2_URL устарела и будет удалена в релизе после 2024-12-01.

name

строка

Имя межсетевого экрана веб-приложений.

profile

псевдонимы: aws_profile

строка

Используемый именованный профиль AWS для аутентификации.

Дополнительную информацию об именованных профилях см. в документации AWS https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html.

Также можно использовать переменную среды AWS_PROFILE.

Параметр profile взаимоисключает параметры aws_access_key, aws_secret_key и security_token.

region

псевдонимы: aws_region, ec2_region

строка

Используемый регион AWS.

Для глобальных служб, таких как IAM, Route53 и CloudFront, region игнорируется.

Также можно использовать переменные среды AWS_REGION или EC2_REGION.

Дополнительную информацию см. в документации Amazon AWS http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

Псевдоним ec2_region устарел и будет удалён в релизе после 2024-12-01.

Поддержка переменной среды EC2_REGION устарела и будет удалена в релизе после 2024-12-01.

secret_key

псевдонимы: aws_secret_access_key, aws_secret_key, ec2_secret_key

строка

Секретный ключ доступа AWS.

Дополнительную информацию о маркерах доступа см. в документации AWS https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также можно использовать переменные среды AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, или EC2_SECRET_KEY в порядке убывания приоритета.

Параметры secret_key и profile взаимоисключают друг друга.

Псевдоним aws_secret_access_key был добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore.

Псевдоним ec2_secret_key устарел и будет удалён в релизе после 2024-12-01.

Поддержка переменной среды EC2_SECRET_KEY устарела и будет удалена в релизе после 2024-12-01.

session_token

псевдонимы: aws_session_token, security_token, aws_security_token, access_token

строка

Токен сессии AWS STS для использования с временными учётными данными.

Дополнительную информацию о маркерах доступа см. в документации AWS https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также можно использовать переменные среды AWS_SESSION_TOKEN, AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN в порядке убывания приоритета.

Параметры security_token и profile взаимоисключают друг друга.

Псевдонимы aws_session_token и session_token были добавлены в релизе 3.2.0, а параметр был переименован из security_token в session_token в релизе 6.0.0.

Псевдонимы security_token, aws_security_token и access_token устарели и будут удалены в релизе после 2024-12-01.

Поддержка переменных среды EC2_SECRET_KEY и AWS_SECURITY_TOKEN устарела и будет удалена в релизе после 2024-12-01.
END_OF_DOCUMENT_MARKER

validate_certs

boolean

При установке в false, сертификаты SSL для связи с API AWS не будут проверяться.

Установка validate_certs=false настоятельно не рекомендуется, в качестве альтернативы, можно установить aws_ca_bundle.

Варианты:

  • false
  • true ← (по умолчанию)

waf_regional

boolean

Использовать модуль waf-regional?

Варианты:

  • false ← (по умолчанию)
  • true

Примечания

Примечание

  • Внимание: Для модулей переменные окружения и конфигурационные файлы читаются из контекста хоста Ansible, а не контекста контроллера. Поэтому файлы, возможно, нужно явно скопировать на хост. Для плагинов поиска и подключения переменные окружения и конфигурационные файлы читаются из контекста контроллера Ansible, а не контекста хоста.
  • AWS SDK (boto3), используемый Ansible, также может считывать значения по умолчанию для учетных данных и других настроек, таких как регион, из своих конфигурационных файлов в контексте хоста 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

complex

Защита AWS WAF, соответствующая переданным аргументам.

Возвращается: успешно

default_action

integer

Действие, выполняемое, если ни одна из правил WebACL не соответствует.

Возвращается: всегда

Пример: "BLOCK"

metric_name

string

Наименование или описание метрик для данной WebACL.

Возвращается: всегда

Пример: "test_waf_metric"

name

string

Наименование или описание WebACL.

Возвращается: всегда

Пример: "test_waf"

rules

complex

Массив, содержащий действия для каждого правила в WebACL, а также приоритет правила.

Возвращается: всегда

action

string

Действие, выполняемое, если правило соответствует.

Возвращается: всегда

Пример: "BLOCK"

metric_name

string

Наименование или описание метрик для данного правила.

Возвращается: всегда

Пример: "ipblockrule"

name

string

Наименование или описание правила.

Возвращается: всегда

Пример: "ip_block_rule"

predicates

list / elements=string

Список предикатов содержит предикат для каждого объекта ByteMatchSet, IPSet, SizeConstraintSet, SqlInjectionMatchSet или XssMatchSet в правиле.

Возвращается: всегда

Пример: [{"byte_match_set_id": "47b822b5-abcd-1234-faaf-1234567890", "byte_match_tuples": [{"field_to_match": {"type": "QUERY_STRING"}, "positional_constraint": "STARTS_WITH", "target_string": "bobbins", "text_transformation": "NONE"}], "name": "bobbins", "negated": false, "type": "ByteMatch"}]

Авторы

  • Mike Mochan (@mmochan)
  • Will Thames (@willthames)

Ссылки на коллекции

  • Отслеживание ошибок
  • Репозиторий (источники)
  • Связь

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/aws/waf_info_module.html

Spec-Zone.ru

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