ec2_vpc_igw – Управление интернет-шлюзом VPC AWS
Описание
- Управление интернет-шлюзом VPC AWS
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- boto
- boto3
- botocore
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
|
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 |
|
|
debug_botocore_endpoint_logs
логическое значение
добавлен в 2.8
|
|
Используйте логгер botocore.endpoint для анализа уникальных (а не общих) API-вызовов «ресурс:действие», выполняемых во время задачи, выводя набор в ключ resource_actions результатов задачи. Используйте обратный вызов aws_resource_action для вывода полного списка, сделанного во время выполнения плейбука. Может также использоваться переменная окружения ANSIBLE_DEBUG_BOTOCORE_LOGS.
|
|
ec2_url
строка
|
URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она присутствует.
|
|
|
profile
строка
|
Использует профиль 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
строка
|
AWS STS security token. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN.
Псевдонимы: access_token |
|
|
state
-
|
|
Создать или удалить IGW
|
|
tags
-
добавлен в 2.4
|
Словарь тегов для применения к интернет-шлюзу. Любые теги, которые сейчас применены к интернет-шлюзу и отсутствуют здесь, будут удалены.
Псевдонимы: resource_tags |
|
|
validate_certs
логическое значение
|
|
Если установлено «нет», сертификаты SSL для boto версий >= 2.6.0 не будут проверены.
|
|
vpc_id
- / обязательно
|
ID VPC для VPC, в котором нужно управлять интернет-шлюзом.
|
Примечания
Примечание
- Если параметры не заданы в модуле, можно использовать следующие переменные среды в порядке убывания приоритета
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), если учетные данные не предоставлены. См. https://boto.readthedocs.io/en/latest/boto_config_tut.html
-
AWS_REGIONилиEC2_REGIONобычно используются для указания AWS-региона, когда это требуется, но его также можно настроить в конфигурационном файле boto
Примеры
# 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
логическое значение
|
всегда |
Если изменения были внесены в интернет-шлюз.
Пример:
{'changed': False}
|
|
gateway_id
строка
|
state=present |
Уникальный идентификатор интернет-шлюза.
Пример:
{'gateway_id': 'igw-XXXXXXXX'}
|
|
tags
словарь
|
state=present |
Теги, связанные с интернет-шлюзом.
Пример:
{'tags': {'Ansible': 'Test'}}
|
|
vpc_id
строка
|
state=present |
ID VPC, связанный с интернет-шлюзом.
Пример:
{'vpc_id': 'vpc-XXXXXXXX'}
|
Статус
- В дальнейшем этот модуль гарантирует обратную совместимость изменений интерфейса. [stableinterface]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Robert Estelle (@erydo)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/ec2_vpc_igw_module.html