ec2_vpc_endpoint - Создание и удаление конечных точек AWS VPC.
Новая версия 2.4.
- Обзор
- Требования (к хосту, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
- Примечания
Обзор
- Создает конечные точки AWS VPC.
- Удаляет конечные точки AWS VPC.
- Этот модуль поддерживает режим проверки.
Требования (к хосту, на котором выполняется модуль)
- boto
- boto3
- 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 | ||
| client_token | нет | Необязательный маркер клиента для обеспечения идемпотентности | ||
| ec2_url | нет | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковая имеется. | ||
| policy | нет | Правильно отформатированный JSON-политика в виде строки, см. https://github.com/ansible/ansible/issues/7005#issuecomment-42894813. Не может быть использовано с policy_file. Параметр при создании конечной точки. Если не указан, AWS будет использовать политику по умолчанию, предоставляющую полный доступ к службе. | ||
| policy_path | нет | Путь к файлу с правильно отформатированной JSON-политикой, см. https://github.com/ansible/ansible/issues/7005#issuecomment-42894813 по правильному использованию. Не может быть использовано с policy. Параметр при создании конечной точки. Если не указан, AWS будет использовать политику по умолчанию, предоставляющую полный доступ к службе. | ||
| 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 | ||
| route_table_ids | нет | Список одного или нескольких идентификаторов таблиц маршрутизации для подключения к конечной точке. Маршрут добавляется в таблицу маршрутизации с адресатом конечной точки, если он предоставлен. | ||
| security_token (добавлен в 1.6)
| нет | Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. псевдонимы: access_token | ||
| service | нет | Поддерживаемая AWS служба конечных точек vpc. Используйте модуль ec2_vpc_endpoint_facts для описания поддерживаемых служб конечных точек. Требуется при создании конечной точки. | ||
| state | нет | present |
| present для обеспечения создания ресурса. absent для удаления ресурса |
| validate_certs (добавлен в 1.5)
| нет | да |
| Если установлено "нет", сертификаты SSL не будут проверяться для версий boto >= 2.6.0. |
| vpc_endpoint_id | нет | Один или несколько идентификаторов конечных точек vpc для удаления из учетной записи AWS | ||
| vpc_id | нет | Требуется при создании конечной точки VPC. | ||
| wait | нет |
| Если указано, дожидается статуса available для state present. К сожалению, это игнорируется для действий по удалению из-за различий в поведении от AWS. | |
| wait_timeout | нет | 320 | Используется вместе с wait. Количество секунд ожидания статуса. К сожалению, это игнорируется для действий по удалению из-за различий в поведении от AWS. |
Примеры
# Note: These examples do not set authentication details, see the AWS Guide for details.
- name: Create new vpc endpoint with a json template for policy
ec2_vpc_endpoint:
state: present
region: ap-southeast-2
vpc_id: vpc-12345678
service: com.amazonaws.ap-southeast-2.s3
policy: " {{ lookup( 'template', 'endpoint_policy.json.j2') }} "
route_table_ids:
- rtb-12345678
- rtb-87654321
register: new_vpc_endpoint
- name: Create new vpc endpoint the default policy
ec2_vpc_endpoint:
state: present
region: ap-southeast-2
vpc_id: vpc-12345678
service: com.amazonaws.ap-southeast-2.s3
route_table_ids:
- rtb-12345678
- rtb-87654321
register: new_vpc_endpoint
- name: Create new vpc endpoint with json file
ec2_vpc_endpoint:
state: present
region: ap-southeast-2
vpc_id: vpc-12345678
service: com.amazonaws.ap-southeast-2.s3
policy_file: "{{ role_path }}/files/endpoint_policy.json"
route_table_ids:
- rtb-12345678
- rtb-87654321
register: new_vpc_endpoint
- name: Delete newly created vpc endpoint
ec2_vpc_endpoint:
state: absent
nat_gateway_id: "{{ new_vpc_endpoint.result['VpcEndpointId'] }}"
region: ap-southeast-2
Возвращаемые значения
Общие возвращаемые значения описаны здесь Возвращаемые значения, следующие поля уникальны для данного модуля:
| имя | описание | возвращаемое | тип | пример |
|---|---|---|---|---|
| endpoints | Результирующие конечные точки из вызова модуля | успех | список | [{'policy_document': {'Version': '2012-10-17', 'Id': 'Policy1450910922815', 'Statement': [{'Action': 's3:*', 'Principal': '*', 'Resource': ['arn:aws:s3:::*/*', 'arn:aws:s3:::*'], 'Effect': 'Allow', 'Sid': 'Stmt1450910920641'}]}, 'vpc_endpoint_id': 'vpce-a1b2c3d4', 'vpc_id': 'vpc-abbad0d0', 'service_name': 'com.amazonaws.ap-southeast-2.s3', 'creation_timestamp': '2017-02-20T05:04:15+00:00', 'route_table_ids': ['rtb-abcd1234']}] |
Примечания
Примечание
- Если параметры не заданы в модуле, могут использоваться следующие переменные среды в порядке убывания приоритета
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
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимостью.
Для помощи в разработке модулей, если вы так решили, прочитайте Информация о сообществе и участие, Тестирование 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_endpoint_module.html