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 -		Необязательный маркер клиента для обеспечения идемпотентности
debug_botocore_endpoint_logs булево добавлено в 2.8	Варианты: нет ← да	Используйте логирование botocore.endpoint для анализа уникальных (а не общих) API-вызовов «resource:action», выполняемых во время задачи, выводя набор в ключ task results. Используйте обратный вызов aws_resource_action для вывода общего списка, созданного во время выполнения playbook. Также можно использовать переменную окружения ANSIBLE_DEBUG_BOTOCORE_LOGS.
ec2_url строка		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 строка		Использует профиль 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 строка		Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. псевдонимы: access_token
service -		Служба конечной точки vpc, поддерживаемая AWS. Используйте модуль ec2_vpc_endpoint_facts для описания поддерживаемых служб конечных точек. Требуется при создании конечной точки.
state -	Варианты: present ← absent	present — для обеспечения создания ресурса. absent — для удаления ресурса
validate_certs булево	Варианты: нет да ←	При установке в «нет», сертификаты SSL не будут проверены для версий boto >= 2.6.0.
vpc_endpoint_id -		Один или несколько идентификаторов конечных точек vpc для удаления из учетной записи AWS
vpc_id -		Требуется при создании конечной точки VPC.
wait булево	Варианты: нет ← да	При указании ожидается состояние 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), если учетные данные не предоставлены. См. 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.

- 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 список	успех	Результат вызова модуля Пример: [{'creation_timestamp': '2017-02-20T05:04:15+00:00', 'policy_document': {'Id': 'Policy1450910922815', 'Statement': [{'Action': 's3:', 'Effect': 'Allow', 'Principal': '', 'Resource': ['arn:aws:s3:::/', 'arn:aws:s3:::*'], 'Sid': 'Stmt1450910920641'}], 'Version': '2012-10-17'}, 'route_table_ids': ['rtb-abcd1234'], 'service_name': 'com.amazonaws.ap-southeast-2.s3', 'vpc_endpoint_id': 'vpce-a1b2c3d4', 'vpc_id': 'vpc-abbad0d0'}]

Статус

Гарантия обратной совместимости интерфейса этого модуля не предоставляется. [превью]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

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.8/modules/ec2_vpc_endpoint_module.html