Spec-Zone.ru › Ansible

community.aws.ec2_transit_gateway_vpc_attachment_info модуль — описывает привязки AWS Transit Gateway VPC

Примечание

Этот модуль входит в коллекцию 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_info.

Новая в community.aws 4.0.0

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

Обзор

  • Описывает привязки AWS Transit Gateway VPC.

Требования

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

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

Параметры

Параметр

Комментарии

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.

... (остальные строки) ...
END_OF_DOCUMENT_MARKER

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.

validate_certs

boolean

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

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

Доступные значения:

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

Примечания

Примечание

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

Примеры

# Describe a specific Transit Gateway attachment.
- community.aws.ec2_transit_gateway_vpc_attachment_info:
    id: 'tgw-attach-0123456789abcdef0'

# Describe all attachments attached to a transit gateway.
- community.aws.ec2_transit_gateway_vpc_attachment_info:
    filters:
      transit-gateway-id: tgw-0fedcba9876543210'

# Describe all attachments in an account.
- community.aws.ec2_transit_gateway_vpc_attachment_info:
    filters:
      transit-gateway-id: tgw-0fedcba9876543210'

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

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

Ключ

Описание

transit_gateway_attachments

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

Атрибуты прикреплений шлюза транзита.

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

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

строка

Идентификатор шлюза транзита, к которому подключено прикрепление.

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

Пример: "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_info_module.html

Spec-Zone.ru

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