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

Примечание

Этот плагин входит в состав коллекции community.aws (версия 1.3.0).

Для его установки используйте: ansible-galaxy collection install community.aws.

Для использования в playbook укажите: community.aws.aws_waf_facts.

Новый в версии 1.0.0: of community.aws

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

Описание

Получение информации для WAF ACL, правил, условий и фильтров.
Этот модуль назывался aws_waf_facts до Ansible 2.9. Использование не изменилось.

Требования

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

boto
boto3
python >= 2.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
aws_access_key строка		Ключ доступа AWS. Если не задан, используется значение переменной среды AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Если задан параметр profile, этот параметр игнорируется. Одновременное использование параметров aws_access_key и profile устарело и будет исключено после 2022-06-01. псевдонимы: ec2_access_key, access_key
aws_ca_bundle путь		Расположение файла сертификатов CA для проверки SSL-сертификатов. Используется только для модулей на основе boto3. Примечание: Файл сертификатов CA читается на стороне модуля и может потребоваться явно скопировать его с контроллера, если модуль не выполняется локально.
aws_config словарь		Словарь для изменения конфигурации botocore. Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Для модулей boto используется только ключ 'user_agent'. Дополнительные параметры конфигурации boto можно найти по адресу http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto.
aws_secret_key строка		Секретный ключ AWS. Если не задан, используется значение переменной среды AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Если задан параметр profile, этот параметр игнорируется. Одновременное использование параметров aws_secret_key и profile устарело и будет исключено после 2022-06-01. псевдонимы: ec2_secret_key, secret_key
debug_botocore_endpoint_logs булево	Варианты: нет ← да	Используйте логигер botocore.endpoint для анализа уникальных (а не общих) вызовов API «ресурс:действие», производимых во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action, чтобы вывести полный список, созданный во время выполнения playbook. Также может быть использована переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS.
ec2_url строка		URL для подключения к облаку EC2 или Eucalyptus (по умолчанию модуль будет использовать адреса EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной среды EC2_URL, если таковая имеется. псевдонимы: aws_endpoint_url, endpoint_url
name строка		Имя веб-шлюза приложений.
profile строка		Использует профиль boto. Работает только с boto >= 2.24.0. Использование profile переопределяет aws_access_key, aws_secret_key и security_token, а поддержка их одновременного использования с profile устарела. aws_access_key, aws_secret_key и security_token будут исключены в качестве параметров, когда используется profile после 2022-06-01. псевдонимы: aws_profile
region строка		Регион AWS для использования. Если не указан, используется значение переменной среды AWS_REGION или EC2_REGION, если таковая имеется. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region псевдонимы: aws_region, ec2_region
security_token строка		Токен безопасности AWS STS. Если не задан, используется значение переменной среды AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Если задан параметр profile, этот параметр игнорируется. Одновременное использование параметров security_token и profile устарело и будет исключено после 2022-06-01. псевдонимы: aws_security_token, access_token
validate_certs булево	Варианты: нет да ←	При значении "нет", SSL-сертификаты не будут проверены для версий boto >= 2.6.0.
waf_regional булево	Варианты: нет ← да	Использовать модуль waf-regional.

Примечания

Примечание

Если параметры не заданы внутри модуля, следующие переменные среды могут быть использованы в порядке убывания приоритета AWS_URL или EC2_URL, AWS_PROFILE или AWS_DEFAULT_PROFILE, AWS_ACCESS_KEY_ID или AWS_ACCESS_KEY или EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY или AWS_SECRET_KEY или EC2_SECRET_KEY, AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN, AWS_REGION или EC2_REGION, AWS_CA_BUNDLE
Ansible использует конфигурационный файл boto (обычно ~/.boto), если данные о учетных записях не предоставлены. См. https://boto.readthedocs.io/en/latest/boto_config_tut.html
AWS_REGION или EC2_REGION обычно используются для указания региона AWS, когда это необходимо, но это также можно настроить в конфигурационном файле boto

Примеры

- name: obtain all WAF information
  community.aws.aws_waf_info:

- name: obtain all information for a single WAF
  community.aws.aws_waf_info:
    name: test_waf

- name: obtain all information for a single WAF Regional
  community.aws.aws_waf_info:
    name: test_waf
    waf_regional: true

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:

Ключ			Возвращаемое	Описание
wafs сложный			успех	WAF, соответствующие переданным аргументам.
	default_action целое число		всегда	Действие, которое выполняется, если ни одно из правил WebACL не соответствует. Пример: BLOCK
	metric_name строка		всегда	Дружественное имя или описание метрик для данной WebACL. Пример: test_waf_metric
	name строка		всегда	Дружественное имя или описание WebACL. Пример: test_waf
	rules сложный		всегда	Массив, содержащий действие для каждого правила в WebACL, а также приоритет правила.
		action строка	всегда	Действие, которое выполняется, если правило соответствует. Пример: BLOCK
		metric_name строка	всегда	Дружественное имя или описание метрик для этого правила. Пример: ipblockrule
		name строка	всегда	Дружественное имя или описание правила. Пример: ip_block_rule
		predicates список / элементы=строка	всегда	Список предикатов содержит предикат для каждого объекта 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/aws/aws_waf_facts_module.html