Модуль community.aws.networkfirewall — управление брандмауэрами AWS Network Firewall

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_ID или AWS_ACCESS_KEY в порядке убывания приоритета.

Параметры aws_access_key и profile являются взаимоисключающими.

Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для соответствия AWS SDK botocore.

arn

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

строка

ARN брандмауэра.

Необходимо указать ровно один из параметров: arn или name.

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 для сбора уникальных (а не общих) вызовов API "resource:action", выполненных во время задачи, и выводить их список в ключ resource_actions результатов задачи. Используйте callback aws_resource_action, чтобы вывести общий список вызовов, выполненных в ходе плейбука.

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

Варианты:

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

delete_protection

логическое значение

Если delete_protection=True, брандмауэр защищён от удаления.

Если при создании параметр не указан, по умолчанию используется false.

Варианты:

• false
• true

description

строка

Описание брандмауэра.

endpoint_url

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

строка

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

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

name

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

строка

Имя брандмауэра.

После создания изменить нельзя.

Необходимо указать ровно один из параметров: arn или name.

policy

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

строка

ARN политики Network Firewall, используемой брандмауэром.

Обязателен при создании брандмауэра.

policy_change_protection

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

логическое значение

Если policy_change_protection=True, брандмауэр защищён от изменения прикреплённой к нему политики.

Если при создании параметр не указан, по умолчанию используется false.

Варианты:

• false
• true

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 и session_token.

purge_subnets

логическое значение

Если purge_subnets=true, существующие подсети будут удалены из брандмауэра при необходимости, чтобы их набор в точности соответствовал указанному в параметре subnets.

Варианты:

• 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

строка

Регион AWS.

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

Также можно использовать переменную окружения AWS_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.

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

Параметры secret_key и profile являются взаимоисключающими.

Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для соответствия AWS SDK botocore.

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.

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

Параметры session_token и profile являются взаимоисключающими.

state

строка

Создать или удалить брандмауэр.

Варианты:

• "present" ← (по умолчанию)
• "absent"

subnet_change_protection

логическое значение

Если subnet_change_protection=True, брандмауэр защищён от изменения набора подсетей, связанных с ним.

Если при создании параметр не указан, по умолчанию используется false.

Варианты:

• false
• true

subnets

список / элементы=строка

Идентификаторы подсетей, с которыми будет связан брандмауэр.

Обязателен при создании брандмауэра.

tags

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

словарь

Словарь с тегами, которые нужно применить к ресурсу.

Если параметр tags не задан, теги не будут изменены.

validate_certs

логическое значение

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

Настоятельно не рекомендуется устанавливать validate_certs=false. Вместо этого рассмотрите возможность задать параметр aws_ca_bundle.

Варианты:

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

wait

логическое значение

При создании — ожидать ли перехода брандмауэра в состояние READY.

При удалении — ожидать ли перехода брандмауэра в состояние DELETED.

При обновлении — ожидать ли перехода брандмауэра в состояние синхронизации конфигурации IN_SYNC.

Варианты:

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

wait_timeout

целое число

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

По умолчанию — 600 секунд.

firewall

dictionary

Полная информация о брандмауэре

Возвращается: при успехе

firewall

dictionary

Информация о брандмауэре

Возвращается: при успехе

delete_protection

string

Флаг, указывающий, можно ли удалить брандмауэр.

Возвращается: при успехе

Пример: "True"

description

string

Описание брандмауэра.

Возвращается: при успехе

Пример: "Description"

firewall_arn

string

ARN брандмауэра.

Возвращается: при успехе

Пример: "arn:aws:network-firewall:us-east-1:123456789012:firewall/ExampleFirewall"

firewall_id

string

Уникальный идентификатор брандмауэра.

Возвращается: при успехе

Пример: "12345678-abcd-1234-abcd-123456789abc"

firewall_name

string

Имя брандмауэра.

Возвращается: при успехе

Пример: "ExampleFirewall"

firewall_policy_arn

string

ARN политики брандмауэра, используемой брандмауэром.

Возвращается: при успехе

Пример: "arn:aws:network-firewall:us-east-1:123456789012:firewall-policy/ExamplePolicy"

firewall_policy_change_protection

boolean

Флаг, указывающий, можно ли изменить используемую брандмауэром политику брандмауэра.

Возвращается: при успехе

Пример: false

subnet_change_protection

boolean

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

Возвращается: при успехе

Пример: true

subnet_mappings

list / elements=dictionary

Список подсетей, в которых находятся конечные точки брандмауэра.

Возвращается: при успехе

subnet_id

string

Идентификатор подсети.

Возвращается: при успехе

Пример: "subnet-12345678"

subnets

list / elements=string

Список подсетей, в которых находятся конечные точки брандмауэра.

Возвращается: при успехе

Пример: ["subnet-12345678", "subnet-87654321"]

tags

dictionary

Теги, связанные с брандмауэром.

Возвращается: при успехе

Пример: {"SomeTag": "SomeValue"}

vpc_id

string

Идентификатор VPC, в которой используется брандмауэр.

Возвращается: при успехе

Пример: "vpc-0123456789abcdef0"

firewall_metadata

dictionary

Метаданные о брандмауэре

Возвращается: при успехе

configuration_sync_state_summary

string

Краткая сводка о состоянии синхронизации политики и групп правил.

Возвращается: при успехе

Пример: "IN_SYNC"

status

string

Краткая сводка о состоянии конечных точек брандмауэра.

Возвращается: при успехе

Пример: "READY"

sync_states

dictionary

Описание состояния конечных точек брандмауэра с разбивкой по зонам доступности, а также состояния синхронизации политик и групп правил.

Возвращается: при успехе

Пример: {"us-east-1a": {"attachment": {"endpoint_id": "vpce-123456789abcdef01", "status": "READY", "subnet_id": "subnet-12345678"}, "config": {"arn:aws:network-firewall:us-east-1:123456789012:firewall-policy/Ansible-Example": {"sync_status": "IN_SYNC", "update_token": "abcdef01-0000-0000-0000-123456789abc"}, "arn:aws:network-firewall:us-east-1:123456789012:stateful-rulegroup/ExampleDomainList": {"sync_status": "IN_SYNC", "update_token": "12345678-0000-0000-0000-abcdef012345"}}}}