Spec-Zone.ru › Ansible

Модуль amazon.aws.ec2_transit_gateway_vpc_attachment_info — описывает подключения VPC к AWS Transit Gateway

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: amazon.aws.ec2_transit_gateway_vpc_attachment_info.

Добавлено в community.aws 4.0.0

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

Краткое описание

  • Описывает подключения VPC к AWS Transit Gateway.

Требования

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

  • python >= 3.6
  • boto3 >= 1.35.0
  • botocore >= 1.35.0

Параметры

Параметр

Комментарии

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 botocore SDK.

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 результатов задачи. Используйте обработчик обратного вызова aws_resource_action, чтобы вывести общий список вызовов, выполненных в ходе плейбука.

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

Варианты:

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

endpoint_url

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

строка

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

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

filters

словарь

Словарь фильтров, которые нужно применить. Каждый элемент словаря состоит из ключа фильтра и его значения.

Указание фильтра tag:Name переопределяет параметр name.

id

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

строка

Идентификатор подключения Transit Gateway.

Взаимоисключающий с name и filters.

include_deleted

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

Если указано include_deleted=True, будут также возвращены подключения в удалённом состоянии.

Указание фильтра state переопределяет параметр include_deleted.

Варианты:

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

name

строка

Тег Name подключения Transit Gateway.

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.

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 botocore SDK.

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 взаимоисключающие.

validate_certs

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

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

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

Варианты:

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

Примечания

Примечание

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

Примеры

- name: Describe a specific Transit Gateway attachment
  amazon.aws.ec2_transit_gateway_vpc_attachment_info:
    id: "tgw-attach-0123456789abcdef0"

- name: Describe all attachments attached to a transit gateway
  amazon.aws.ec2_transit_gateway_vpc_attachment_info:
    filters:
      transit-gateway-id: "tgw-0fedcba9876543210"

- name: Describe all attachments in an account
  amazon.aws.ec2_transit_gateway_vpc_attachment_info:

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

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

Ключ

Описание

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"

security_group_referencing_support

строка

Указывает, отключена ли поддержка ссылок на группы безопасности.

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

Пример: "enable"

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)
  • Alina Buzachis (@alinabuzachis)

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

  • Отслеживание проблем
  • Репозиторий (исходный код)
  • Связь

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/amazon/aws/ec2_transit_gateway_vpc_attachment_info_module.html

Spec-Zone.ru

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