Spec-Zone.ru › Ansible

Модуль community.aws.ec2_transit_gateway — Создание и удаление AWS Transit Gateways

Примечание

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

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

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

Для использования в playbook укажите: community.aws.ec2_transit_gateway.

Новое в community.aws 1.0.0

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

Описание

  • Создает AWS Transit Gateways.
  • Удаляет AWS Transit Gateways.
  • Обновляет метки существующих шлюзов transit.

Требования

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

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

Параметры

Параметр

Комментарии

access_key

aliases: aws_access_key_id, aws_access_key, ec2_access_key

string

Идентификатор ключа доступа 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.

asn

integer

Частный номер автономной системы (ASN) для стороны Amazon сеанса BGP.

Диапазон составляет от 64512 до 65534 для 16-битных ASN и от 4200000000 до 4294967294 для 32-битных ASN.

auto_associate

boolean

Включить или отключить автоматическое связывание с таблицей маршрутов ассоциации по умолчанию.

Варианты:

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

auto_attach

boolean

Включить или отключить автоматическое принятие запросов на подключение.

Варианты:

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

auto_propagate

boolean

Включить или отключить автоматическое распространение маршрутов в таблицу маршрутов распространения по умолчанию.

Варианты:

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

aws_ca_bundle

path

Расположение пакета CA, используемого при проверке SSL-сертификатов.

Переменная среды AWS_CA_BUNDLE также может использоваться.

aws_config

dictionary

Словарь для изменения конфигурации botocore.

Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

debug_botocore_endpoint_logs

boolean

Использовать botocore.endpoint регистратор для анализа уникальных (а не общих) "resource:action" вызовов API, выполненных во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода в общий список, сделанный во время playbook.

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

Варианты:

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

description

string

Описание шлюза транзита.

dns_support

boolean

Включить ли поддержку AWS DNS.

Варианты:

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

endpoint_url

aliases: ec2_url, aws_endpoint_url, s3_url

string

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

Переменные среды AWS_URL или EC2_URL также могут использоваться в порядке убывания предпочтения.

Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01.

Поддержка переменной среды EC2_URL устарела и будет удалена в релизе после 2024-12-01.

profile

aliases: aws_profile

string

Именованный профиль 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_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 ← (по умолчанию)

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 для соответствия SDK AWS botocore.

Псевдоним 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

present для создания ресурса.

absent для удаления ресурса.

Варианты:

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

tags

aliases: resource_tags

dictionary

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

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

Примечания

Примечание

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

Примеры

- name: Create a new transit gateway using defaults
  community.aws.ec2_transit_gateway:
    state: present
    region: us-east-1
    description: personal-testing
  register: created_tgw

- name: Create a new transit gateway with options
  community.aws.ec2_transit_gateway:
    asn: 64514
    auto_associate: false
    auto_propagate: false
    dns_support: true
    description: "nonprod transit gateway"
    purge_tags: false
    state: present
    region: us-east-1
    tags:
      Name: nonprod transit gateway
      status: testing

- name: Remove a transit gateway by description
  community.aws.ec2_transit_gateway:
    state: absent
    region: us-east-1
    description: personal-testing

- name: Remove a transit gateway by id
  community.aws.ec2_transit_gateway:
    state: absent
    region: ap-southeast-2
    transit_gateway_id: tgw-3a9aa123
  register: deleted_tgw

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

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

Ключ

Описание

transit_gateway

complex

Атрибуты шлюза транзита.

Возвращается: state=present

creation_time

string

Время создания шлюза транзита.

Возвращается: всегда

Пример: "2019-03-06T17:13:51+00:00"

description

string

Описание шлюза транзита.

Возвращается: всегда

Пример: "my test tgw"

options

complex

Атрибуты параметров шлюза транзита

Возвращается: всегда

amazon_side_asn

string

Приватный автономный системный номер (ASN) для стороны Amazon сессии BGP. Диапазон составляет от 64512 до 65534 для 16-битных ASN и от 4200000000 до 4294967294 для 32-битных ASN.

Возвращается: всегда

Пример: "64512"

association_default_route_table_id

string

ID таблицы маршрутов ассоциации по умолчанию.

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

Пример: "tgw-rtb-abc123444"

auto_accept_shared_attachements

string

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

Возвращается: всегда

Пример: "disable"

default_route_table_association

string

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

Возвращается: всегда

Пример: "enable"

default_route_table_propagation

string

Указывает, автоматически ли подключения ресурсов распространяют маршруты на таблицу маршрутов распространения по умолчанию.

Возвращается: всегда

Пример: "disable"

dns_support

string

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

Возвращается: всегда

Пример: "enable"

propagation_default_route_table_id

string

ID таблицы маршрутов распространения по умолчанию.

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

Пример: "tgw-rtb-def456777"

vpn_ecmp_support

string

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

Возвращается: всегда

Пример: "enable"

owner_id

string

Учётная запись, которой принадлежит шлюз транзита.

Возвращается: всегда

Пример: "123456789012"

state

string

Состояние шлюза транзита.

Возвращается: всегда

Пример: "pending"

tags

dictionary

Словарь тегов ресурса

Возвращается: всегда

Пример: {"tags": {"Name": "nonprod_tgw"}}

transit_gateway_arn

string

ID шлюза транзита.

Возвращается: всегда

Пример: "tgw-3a9aa123"

transit_gateway_id

string

ID шлюза транзита.

Возвращается: всегда

Пример: "tgw-3a9aa123"

Авторы

  • Боб Болдин (@BobBoldin)

Ссылки на сборник

  • Отслеживание проблем
  • Репозиторий (источники)
  • Общение

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

Spec-Zone.ru

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