community.aws.wafv2_ip_set модуль — wafv2_ip_set

Примечание

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

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

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

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

Новая функция в community.aws 1.5.0

Обзор
Требования
Параметры
Примечания
Примеры
Значения возврата

Обзор

Создание, изменение и удаление наборов IP-адресов для WAFv2.

Требования

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

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.
addresses список / элементы=строка	Содержит массив строк, которые задают один или несколько IP-адресов или блоков IP-адресов в нотации CIDR (Classless Inter-Domain Routing). Обязательно при state=present. При state=absent и определённых addresses будут удалены только указанные IP-адреса из набора IP-адресов. Сам набор IP-адресов останется.
aws_ca_bundle путь	Расположение файла сертификата CA для проверки 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`
description строка	Описание набора IP-адресов.
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.
ip_address_version строка	Указывает, является ли это набором IP-адресов IPv4 или IPv6. Обязательно при state=present. Варианты: `"IPV4"` `"IPV6"`
name строка / обязательно	Имя набора IP-адресов.
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.
purge_addresses логический тип	Если установлено значение `no`, существующие адреса останутся на месте. Будет произведено изменение и добавление, но удаление не будет. Варианты: `false` `true` ← (по умолчанию)
purge_tags логический тип	Если purge_tags=true и tags установлено, существующие теги будут очищены с точным соответствием параметру tags. Если параметр tags не задан, теги не будут изменены, даже если purge_tags=True. Ключи тегов, начинающиеся с `aws:`, зарезервированы Amazon и не могут быть изменены. Поэтому они будут проигнорированы для параметра purge_tags. Дополнительную информацию см. в документации Amazon https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions. Варианты: `false` `true` ← (по умолчанию)
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.

scope string / обязательно	Указывает, предназначен ли этот параметр для распределения AWS CloudFront или для регионального приложения, такого как API Gateway или Application LoadBalancer. Варианты: `"CLOUDFRONT"` `"REGIONAL"`
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.
state строка / обязательно	Присутствует или отсутствует правило. Варианты: `"present"` `"absent"`
tags псевдонимы: resource_tags словарь	Словарь, представляющий теги, которые должны быть применены к ресурсу. Если параметр tags не задан, теги не будут изменены.
validate_certs булево	При установке в значение `false`, сертификаты SSL для связи с API AWS не будут проверены. Установка validate_certs=false категорически не рекомендуется. В качестве альтернативы, рассмотрите возможность установки aws_ca_bundle вместо этого. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Поддержка purge_tags была добавлена в релизе 4.0.0.
Внимание: Для модулей переменные среды и конфигурационные файлы читаются из контекста Ansible «хост», а не из контекста «контроллер». Поэтому файлы может потребоваться явно скопировать на «хост». Для плагинов поиска и подключения переменные среды и конфигурационные файлы читаются из контекста Ansible «контроллер», а не из контекста «хост».
AWS SDK (boto3), который используется Ansible, также может читать значения по умолчанию для учетных данных и других параметров, таких как регион, из своих конфигурационных файлов в контексте Ansible «хост» (обычно ~/.aws/credentials). Дополнительную информацию см. в https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.

Примеры

- name: test ip set
  wafv2_ip_set:
    name: test02
    state: present
    description: hallo eins
    scope: REGIONAL
    ip_address_version: IPV4
    addresses:
      - 8.8.8.8/32
      - 8.8.4.4/32
    tags:
      A: B
      C: D

Значения возврата

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

Ключ	Описание
addresses список / элементы=строка	Текущие адреса набора IP-адресов Возвращается: Всегда, пока набор IP-адресов существует Пример: `["8.8.8.8/32", "8.8.4.4/32"]`
arn строка	ARN набора IP-адресов Возвращается: Всегда, пока набор IP-адресов существует Пример: `"arn:aws:wafv2:eu-central-1:11111111:regional/ipset/test02/4b007330-2934-4dc5-af24-82dcb3aeb127"`
description строка	Описание набора IP-адресов Возвращается: Всегда, пока набор IP-адресов существует Пример: `"Some IP set description"`
ip_address_version строка	Версия IP-адреса набора Возвращается: Всегда, пока набор IP-адресов существует Пример: `"IPV4"`
name строка	Имя набора IP-адресов Возвращается: Всегда, пока набор IP-адресов существует Пример: `"test02"`

Авторы

Markus Bergholz (@markuman)

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

© 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/wafv2_ip_set_module.html