ec2_vpc_endpoint - Создание и удаление конечных точек AWS VPC.

Новая версия 2.4.

Обзор
- Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
- Автор

Обзор

Создаёт конечные точки AWS VPC.
Удаляет конечные точки AWS VPC.
Этот модуль поддерживает режим проверки.

Требования

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

boto
boto3
python >= 2.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
aws_access_key	Значение по умолчанию: None	Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. псевдонимы: ec2_access_key, access_key
aws_secret_key	Значение по умолчанию: None	Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. псевдонимы: ec2_secret_key, secret_key
client_token		Необязательный маркер клиента для обеспечения идемпотентности
ec2_url	Значение по умолчанию: None	URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковая имеется.
policy		Правильно отформатированная json политика в виде строки, см. https://github.com/ansible/ansible/issues/7005#issuecomment-42894813. Не может использоваться с параметром policy_file. Вариант при создании конечной точки. Если не задан, AWS будет использовать политику по умолчанию, предоставляющую полный доступ к сервису.
policy_file		Путь к файлу с правильно отформатированной политикой в формате json, см. https://github.com/ansible/ansible/issues/7005#issuecomment-42894813 по правильному использованию. Не может использоваться с параметром policy. Вариант при создании конечной точки. Если не задан, AWS будет использовать политику по умолчанию, предоставляющую полный доступ к сервису. псевдонимы: policy_path
profile (добавлен в 1.6)	Значение по умолчанию: None	Использует профиль 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)	Значение по умолчанию: None	Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. псевдонимы: access_token
service		Сервис поддерживаемый AWS для конечных точек vpc. Используйте модуль ec2_vpc_endpoint_facts для описания поддерживаемых сервисов конечных точек. Требуется при создании конечной точки.
state	Варианты: present ← absent	present для обеспечения создания ресурса. absent для удаления ресурса
validate_certs (добавлен в 1.5)	Варианты: no yes ←	При установке в значение "no", сертификаты SSL не будут проверяться для версий boto >= 2.6.0.
vpc_endpoint_id		Один или несколько идентификаторов конечных точек vpc для удаления из учетной записи AWS
vpc_id		Требуется при создании конечной точки VPC.
wait	Варианты: yes no ←	Если указано, будет ожидать состояния available для состояния present. К сожалению, это игнорируется для действий по удалению из-за разницы в поведении AWS.
wait_timeout	Значение по умолчанию: 320	Используется в сочетании с wait. Количество секунд ожидания состояния. К сожалению, это игнорируется для действий по удалению из-за разницы в поведении AWS.

Примечания

Примечание

Если параметры не заданы в модуле, можно использовать следующие переменные окружения в порядке убывания приоритета 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

Примеры

# 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']}]

Статус

Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.

Автор

Karen Cheng(@Etherdaemon)

Подсказка

Если вы заметите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/ec2_vpc_endpoint_module.html