ec2_vpc_igw — Управление интернет-шлюзом AWS VPC
Новая версия 2.0.
- Описание
- Требования к хосту, на котором выполняется модуль
- Параметры
- Примеры
- Возвращаемые значения
- Примечания
Описание
- Управление интернет-шлюзом AWS VPC
Требования к хосту, на котором выполняется модуль
- python >= 2.6
- boto
Параметры
| Параметр | Обязательный | Значение по умолчанию | Варианты | Комментарии |
|---|---|---|---|---|
| aws_access_key |
нет |
Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY.
Псевдонимы: ec2_access_key, access_key
|
||
| aws_secret_key |
нет |
Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY.
Псевдонимы: ec2_secret_key, secret_key
|
||
| ec2_url |
нет |
URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковое есть.
|
||
| profile (добавлен в 1.6)
|
нет |
Использует профиль boto. Работает только с boto >= 2.24.0.
|
||
| region |
нет |
AWS регион для использования. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если таковое есть. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
Псевдонимы: aws_region, ec2_region
|
||
| security_token (добавлен в 1.6)
|
нет |
AWS STS токен безопасности. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN.
Псевдонимы: access_token
|
||
| state |
нет | present |
|
Создание или завершение работы IGW
|
| tags (добавлен в 2.4)
|
нет |
Словарь тегов для применения к интернет-шлюзу. Любые теги, которые в настоящее время применены к интернет-шлюзу и отсутствуют здесь, будут удалены.
Псевдонимы: resource_tags
|
||
| validate_certs (добавлен в 1.5)
|
нет | да |
|
Если установлено значение «нет», сертификаты SSL не будут проверяться для версий boto >= 2.6.0.
|
| vpc_id |
да |
ID VPC для VPC, в котором нужно управлять интернет-шлюзом.
|
Примеры
# Note: These examples do not set authentication details, see the AWS Guide for details.
# Ensure that the VPC has an Internet Gateway.
# The Internet Gateway ID is can be accessed via {{igw.gateway_id}} for use in setting up NATs etc.
ec2_vpc_igw:
vpc_id: vpc-abcdefgh
state: present
register: igw
Возвращаемые значения
Общие возвращаемые значения описаны здесь Возвращаемые значения, следующие поля уникальны для данного модуля:
| Имя | Описание | Возвращается | Тип | Пример |
|---|---|---|---|---|
| changed |
Если были внесены какие-либо изменения в интернет-шлюз.
|
всегда | bool | {'changed': False} |
| gateway_id |
Уникальный идентификатор интернет-шлюза.
|
I(state=present) | str | {'gateway_id': 'igw-XXXXXXXX'} |
| tags |
Теги, связанные с интернет-шлюзом.
|
I(state=present) | dict | {'tags': {'Ansible': 'Test'}} |
| vpc_id |
ID VPC, связанный с интернет-шлюзом.
|
I(state=present) | str | {'vpc_id': 'vpc-XXXXXXXX'} |
Примечания
Примечание
- Если параметры не заданы в модуле, можно использовать следующие переменные окружения в порядке убывания приоритета
AWS_URLилиEC2_URL,AWS_ACCESS_KEY_IDилиAWS_ACCESS_KEYилиEC2_ACCESS_KEY,AWS_SECRET_ACCESS_KEYилиAWS_SECRET_KEYилиEC2_SECRET_KEY,AWS_SECURITY_TOKENилиEC2_SECURITY_TOKEN,AWS_REGIONилиEC2_REGION. - Ansible использует конфигурационный файл boto (обычно ~/.boto), если учетные данные не предоставлены. См. http://boto.readthedocs.org/en/latest/boto_config_tut.html
-
AWS_REGIONилиEC2_REGIONмогут быть использованы для указания региона AWS, когда это необходимо, но это также можно настроить в конфигурационном файле boto
Статус
Этот модуль помечен как stableinterface, что означает, что разработчики этого модуля гарантируют, что не будут внесены несовместимые с обратной совместимостью изменения интерфейса.
Для получения помощи в разработке модулей, если вы так заинтересованы, пожалуйста, ознакомьтесь с Справочной информацией по сообществу и участию в разработке, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/ec2_vpc_igw_module.html