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_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода в общий список, созданный во время выполнения плейбука. Также может использоваться переменная окружения 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 -		Поддерживаемый AWS сервис конечной точки vpc. Используйте модуль ec2_vpc_endpoint_info для описания поддерживаемых сервисов конечных точек. Требуется при создании конечной точки.
state -	Варианты: present ← absent	present для обеспечения создания ресурса. absent для удаления ресурса
validate_certs логический тип	Варианты: нет да ←	При установке "нет", сертификаты SSL не будут проверены для версий boto >= 2.6.0.
vpc_endpoint_id -		Один или несколько идентификаторов конечных точек vpc для удаления из учетной записи AWS
vpc_id -		Требуется при создании конечной точки VPC.
wait логический тип	Варианты: нет ← да	При указании, будет ожидание статуса доступности для состояния 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': 'Разрешить', '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.9/modules/ec2_vpc_endpoint_module.html