Spec-Zone.ru › Ansible

Модуль amazon.aws.ec2_transit_gateway_vpc_attachment — создание и удаление подключений 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.

Добавлено в 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 SDK botocore.

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

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

Варианты:

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

dns_support

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

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

Варианты:

  • false
  • true

endpoint_url

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

строка

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

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

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

строка

Создать или удалить подключение Transit Gateway.

Варианты:

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

subnets

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

Идентификаторы подсетей, в которых нужно создать подключение VPC к Transit Gateway.

Обязательный параметр при создании подключения.

tags

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

словарь

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

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

transit_gateway

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

строка

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

При создании нового подключения необходимо указать transit_gateway.

Необходимо указать хотя бы один из параметров name, transit_gateway и id.

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

validate_certs

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

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

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

Варианты:

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

wait

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

Ожидать ли, пока подключение Transit Gateway перейдет в состояние Available или Deleted, прежде чем модуль завершит работу.

Варианты:

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

wait_timeout

целое число

Максимальное время ожидания (в секундах) перехода подключения Transit Gateway в ожидаемое состояние.

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

По умолчанию: 600

Примечания

Примечание

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

Примеры

- name: Create a Transit Gateway attachment
  amazon.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"

- name: Set sub options on a Transit Gateway attachment
  amazon.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

- name: Delete the transit gateway
  amazon.aws.ec2_transit_gateway_vpc_attachment:
    state: "absent"
    id: "tgw-attach-0c0c5fd0b0f01d1c9"

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

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

Ключ

Описание

attachments

list / elements=dictionary

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

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

creation_time

string

Метка даты и времени в формате ISO 8601, указывающая, когда было создано подключение.

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

Пример: "2022-03-10T16:40:26+00:00"

options

dictionary

Дополнительные параметры подключения VPC.

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

appliance_mode_support

string

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

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

Пример: "enable"

dns_support

string

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

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

Пример: "disable"

ipv6_support

string

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

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

Пример: "disable"

security_group_referencing_support

string

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

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

Пример: "enable"

state

string

Состояние подключения.

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

Пример: "deleting"

subnet_ids

list / elements=string

Идентификаторы подсетей, используемых подключением.

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

Пример: ["subnet-0123456789abcdef0", "subnet-11111111111111111"]

tags

dictionary

Словарь, представляющий теги ресурса.

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

transit_gateway_attachment_id

string

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

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

Пример: "tgw-attach-0c0c5fd0b0f01d1c9"

transit_gateway_id

string

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

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

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

vpc_id

string

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

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

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

vpc_owner_id

string

Идентификатор учетной записи, которой принадлежит VPC.

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

Пример: "1234567890122"

Авторы

  • 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_module.html

Spec-Zone.ru

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