Модуль community.aws.directconnect_gateway — Управление шлюзом AWS Direct Connect
Примечание
Этот модуль входит в коллекцию community.aws (версия 8.0.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.aws. Для использования этого модуля необходимы дополнительные требования, см. Требования для подробностей.
Чтобы использовать его в плейбуке, укажите: community.aws.directconnect_gateway.
Впервые появился в community.aws 1.0.0
Обзор
- Создаёт шлюз AWS Direct Connect.
- Удаляет шлюз AWS Direct Connect.
- Подключает виртуальные шлюзы к шлюзу Direct Connect.
- Отключает виртуальные шлюзы от шлюза Direct Connect.
- До версии 5.0.0 этот модуль назывался
community.aws.aws_direct_connect_gateway. Использование не изменилось.
Псевдонимы: aws_direct_connect_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 и profile взаимоисключающие. Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для соответствия SDK AWS botocore. Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды |
amazon_asn строка | ASN со стороны Amazon. Требуется при state=present. |
aws_ca_bundle путь | Расположение пакета CA для проверки SSL-сертификатов. Также может использоваться переменная среды |
aws_config словарь | Словарь для изменения конфигурации botocore. Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
debug_botocore_endpoint_logs логический | Использовать логгер Также может использоваться переменная среды Варианты:
|
direct_connect_gateway_id строка | Идентификатор существующего шлюза Direct Connect. Требуется при state=absent. |
endpoint_url псевдонимы: ec2_url, aws_endpoint_url, s3_url строка | URL для подключения вместо стандартных конечных точек AWS. Хотя это можно использовать для подключения к другим совместимым с AWS службам, коллекции amazon.aws и community.aws протестированы только с AWS. Также могут использоваться переменные среды Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01. Поддержка переменной среды |
name строка | Имя шлюза Direct Connect для создания или удаления. |
profile псевдонимы: aws_profile строка | Используемый именованный профиль AWS для аутентификации. Дополнительную информацию об именованных профилях см. в документации AWS https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также может использоваться переменная среды Параметр profile взаимоисключающий с параметрами aws_access_key, aws_secret_key и security_token. |
region псевдонимы: aws_region, ec2_region строка | Используемый регион AWS. Для глобальных служб, таких как IAM, Route53 и CloudFront, region игнорируется. Также могут использоваться переменные среды Дополнительную информацию см. в документации Amazon AWS http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. Псевдоним Поддержка переменной среды |
secret_key псевдонимы: aws_secret_access_key, aws_secret_key, ec2_secret_key строка | Секретный ключ доступа AWS. Дополнительную информацию об маркерах доступа см. в документации AWS https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также могут использоваться переменные среды Параметры secret_key и profile взаимоисключающие. Псевдоним aws_secret_access_key был добавлен в релизе 5.1.0 для соответствия SDK AWS botocore. Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды |
session_token aliases: aws_session_token, security_token, aws_security_token, access_token строка | Токен сессии AWS STS для использования с временными учетными данными. См. документацию AWS для получения дополнительной информации об access token https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также могут использоваться переменные среды Параметры 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. Поддержка переменных среды |
state строка | Установите state=present, чтобы гарантировать создание ресурса. Установите state=absent, чтобы удалить ресурс. Варианты:
|
validate_certs логический тип | При установке в Сильно не рекомендуется устанавливать validate_certs=false. В качестве альтернативы, установите aws_ca_bundle. Варианты:
|
virtual_gateway_id строка | ID шлюза VPN существующего виртуального шлюза. |
wait_timeout целое число | Сколько времени ждать удаления ассоциации. По умолчанию: |
Примечания
Примечание
- Внимание: Для модулей переменные окружения и файлы конфигурации читаются из контекста Ansible «хост», а не «контроллер». В связи с этим файлы могут потребоваться явно скопировать на «хост». Для плагинов поиска и подключения переменные окружения и файлы конфигурации читаются из контекста Ansible «контроллер», а не «хост».
- AWS SDK (boto3), используемый Ansible, также может читать значения по умолчанию для учетных данных и других настроек, таких как регион, из своих файлов конфигурации в контексте Ansible «хост» (обычно
~/.aws/credentials). См. https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html для получения дополнительной информации.
Примеры
- name: Create a new direct connect gateway attached to virtual private gateway
community.aws.directconnect_gateway:
state: present
name: my-dx-gateway
amazon_asn: 7224
virtual_gateway_id: vpg-12345
register: created_dxgw
- name: Create a new unattached dxgw
community.aws.directconnect_gateway:
state: present
name: my-dx-gateway
amazon_asn: 7224
register: created_dxgw
Возвращаемые значения
Общие значения возврата документированы здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
result сложный тип | Атрибуты шлюза Direct Connect Возвращаемое значение: state=present |
|
amazon_side_asn строка |
ASN со стороны Amazon. Возвращаемое значение: success |
|
direct_connect_gateway_id строка |
ID шлюза Direct Connect. Возвращаемое значение: success |
|
direct_connect_gateway_name строка |
Имя шлюза Direct Connect. Возвращаемое значение: success |
|
direct_connect_gateway_state строка |
Состояние шлюза Direct Connect. Возвращаемое значение: success |
|
owner_account строка |
AWS идентификатор учетной записи владельца шлюза Direct Connect. Возвращаемое значение: success |
Ссылки на сборку
© 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/directconnect_gateway_module.html