community.aws.ec2_transit_gateway_vpc_attachment модуль — Создание и удаление прикреплений VPC шлюзов AWS Transit Gateway

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: community.aws.ec2_transit_gateway_vpc_attachment.

Новое в community.aws 4.0.0

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

Обзор

Создаёт, удаляет и обновляет прикрепления VPC шлюзов AWS Transit Gateway.

Требования

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

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

Параметры

Параметр	Комментарии
access_key псевдонимы: aws_access_key_id, aws_access_key, ec2_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` или `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.
appliance_mode_support булево	Устанавливает, настроено ли подключение для работы в режиме appliance. При включенном режиме appliance Transit Gateway, используя 4-кортежи IP-пакета, выбирает единственный ENI Transit Gateway в VPC Appliance для всего времени существования потока, чтобы отправлять трафик. Варианты: `false` `true`
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` обратный вызов для вывода в список всех выполненных во время выполнения playbook. Также может использоваться переменная среды `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
dns_support булево	Включена ли поддержка DNS. Варианты: `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.
id псевдонимы: attachment_id строка	Идентификатор подключения Transit Gateway. Если id не задан, поиск будет выполнен с использованием transit_gateway и name. Если возвращено несколько результатов, модуль завершится ошибкой. Необходимо указать хотя бы один из параметров name, transit_gateway и id.
ipv6_support булево	Включена ли поддержка IPv6. Варианты: `false` `true`
name строка	Тэг `Name` подключения Transit Gateway. Если указаны как id, так и name, то будет обновлен тэг `Name` у существующего подключения с совпадающим id. Установка тэга `Name` в tags также приведет к обновлению тэга `Name`. Необходимо указать хотя бы один из параметров name, transit_gateway и id.
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_subnets булево	Если purge_subnets=true, существующие подсети будут удалены из подключения, чтобы точно соответствовать заданным в subnets. Варианты: `false` `true` ← (по умолчанию)

END_OF_DOCUMENT_MARKER

purge_tags boolean	Если 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` ← (default)
region aliases: aws_region, ec2_region string	Регион 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 aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key string	Секретный ключ доступа 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 для согласованности с AWS botocore SDK. Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной окружения `EC2_SECRET_KEY` устарела и будет удалена в релизе после 2024-12-01.
session_token aliases: aws_session_token, security_token, aws_security_token, access_token string	Сеансовый токен 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 string	Создать или удалить подключение Transit Gateway. Варианты: `"present"` ← (default) `"absent"`
subnets list / elements=string	Идентификатор подсетей, в которых необходимо создать подключение Transit Gateway VPC. Обязательно при создании нового подключения.
tags aliases: resource_tags dictionary	Словарь, представляющий теги, которые необходимо применить к ресурсу. Если параметр tags не задан, теги не будут изменены.
transit_gateway aliases: transit_gateway_id string	Идентификатор Transit Gateway, к которому принадлежит подключение. При создании нового подключения необходимо указать transit_gateway. Необходимо указать хотя бы один из параметров: name, transit_gateway и id. transit_gateway является неизменяемым параметром и не может быть обновлен для существующего подключения.
validate_certs boolean	При установке в значение `false`, сертификаты SSL не будут проверяться для связи с API AWS. Установка validate_certs=false настоятельно не рекомендуется. В качестве альтернативы рассмотрите возможность установки aws_ca_bundle. Варианты: `false` `true` ← (default)
wait boolean	Необходимо ли ожидать, пока подключение Transit Gateway достигнет состояния `Available` или `Deleted`, прежде чем модуль вернет результат. Варианты: `false` `true` ← (default)
wait_timeout integer	Максимальное время ожидания (в секундах), пока подключение Transit Gateway достигнет ожидаемого состояния. По умолчанию 600 секунд.

Примечания

Примечание

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

Примеры

# Create a Transit Gateway attachment
- community.aws.ec2_transit_gateway_vpc_attachment:
    state: present
    transit_gateway: 'tgw-123456789abcdef01'
    name: AnsibleTest-1
    subnets:
      - subnet-00000000000000000
      - subnet-11111111111111111
      - subnet-22222222222222222
    ipv6_support: true
    purge_subnets: true
    dns_support: true
    appliance_mode_support: true
    tags:
      TestTag: changed data in Test Tag

# Set sub options on a Transit Gateway attachment
- community.aws.ec2_transit_gateway_vpc_attachment:
    state: present
    id: 'tgw-attach-0c0c5fd0b0f01d1c9'
    name: AnsibleTest-1
    ipv6_support: true
    purge_subnets: false
    dns_support: false
    appliance_mode_support: true

# Delete the transit gateway
- community.aws.ec2_transit_gateway_vpc_attachment:
    state: absent
    id: 'tgw-attach-0c0c5fd0b0f01d1c9'

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

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

Ключ	Описание
transit_gateway_attachments список / элементы=словарь	Атрибуты прикреплений Transit Gateway. Возвращается: успешно
creation_time строка	Маркер времени создания прикрепления в формате ISO 8601. Возвращается: успешно Пример: `"2022-03-10T16:40:26+00:00"`
options словарь	Дополнительные параметры прикрепления VPC. Возвращается: успешно
appliance_mode_support строка	Указывает, включена ли поддержка режима устройства. Возвращается: успешно Пример: `"enable"`
dns_support строка	Указывает, включена ли поддержка DNS. Возвращается: успешно Пример: `"disable"`
ipv6_support строка	Указывает, отключена ли поддержка IPv6. Возвращается: успешно Пример: `"disable"`
state строка	Состояние прикрепления. Возвращается: успешно Пример: `"deleting"`
subnet_ids список / элементы=строка	Идентификаторы подсетей, используемых прикреплением. Возвращается: успешно Пример: `["subnet-0123456789abcdef0", "subnet-11111111111111111"]`
tags словарь	Словарь, представляющий теги ресурсов. Возвращается: успешно
transit_gateway_attachment_id строка	Идентификатор прикрепления. Возвращается: успешно Пример: `"tgw-attach-0c0c5fd0b0f01d1c9"`
transit_gateway_id строка	Идентификатор шлюза Transit Gateway, к которому подключено прикрепление. Возвращается: успешно Пример: `"tgw-0123456789abcdef0"`
vpc_id строка	Идентификатор VPC, к которому подключено прикрепление. Возвращается: успешно Пример: `"vpc-0123456789abcdef0"`
vpc_owner_id строка	Идентификатор учетной записи, к которой принадлежит VPC. Возвращается: успешно Пример: `"123456789012"`

Авторы

Mark Chappell (@tremble)

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

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