Модуль amazon.aws.ec2_vpc_endpoint — создание и удаление конечных точек AWS VPC

Примечание

Этот модуль входит в коллекцию amazon.aws (версия 11.3.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install amazon.aws. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: amazon.aws.ec2_vpc_endpoint.

Добавлено в amazon.aws 1.0.0

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

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

Требования

Следующие требования должны быть выполнены на узле, на котором выполняется этот модуль.

python >= 3.6
boto3 >= 1.35.0
botocore >= 1.35.0

Параметры

Параметр	Комментарии
access_key псевдонимы: aws_access_key_id, aws_access_key строка	Идентификатор ключа доступа AWS. Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные окружения `AWS_ACCESS_KEY_ID` или `AWS_ACCESS_KEY` в порядке убывания приоритета. Параметры aws_access_key и profile являются взаимоисключающими. Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для соответствия AWS SDK botocore.
aws_ca_bundle путь	Расположение пакета центров сертификации для проверки сертификатов SSL. Также можно использовать переменную окружения `AWS_CA_BUNDLE`.
aws_config словарь	Словарь для изменения конфигурации botocore. Параметры перечислены в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
client_token строка	Необязательный токен клиента для обеспечения идемпотентности.
debug_botocore_endpoint_logs логическое значение	Используйте регистратор `botocore.endpoint` для анализа уникальных (а не общего количества) вызовов API `"resource:action"`, выполненных во время задачи, и вывода их набора в ключ resource_actions результатов задачи. Используйте callback `aws_resource_action` для вывода общего списка вызовов, выполненных во время плейбука. Также можно использовать переменную окружения `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
endpoint_url псевдонимы: aws_endpoint_url строка	URL для подключения вместо конечных точек AWS по умолчанию. Хотя этот параметр можно использовать для подключения к другим сервисам, совместимым с AWS, коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную окружения `AWS_URL`.
policy json	Правильно отформатированная политика JSON в виде строки; см. https://github.com/ansible/ansible/issues/7005#issuecomment-42894813. Параметр используется при создании конечной точки. Если он не указан, AWS применит политику по умолчанию, предоставляющую полный доступ к сервису.
profile псевдонимы: aws_profile строка	Именованный профиль AWS для аутентификации. Дополнительные сведения об именованных профилях см. в документации AWS: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также можно использовать переменную окружения `AWS_PROFILE`. Параметр profile взаимоисключающий с параметрами aws_access_key, aws_secret_key и session_token.
purge_tags логическое значение	Если задано `purge_tags=true` и указан `tags`, существующие теги ресурса будут удалены, чтобы их набор точно соответствовал указанному параметру `tags`. Если параметр `tags` не указан, теги не будут изменены, даже если задано `purge_tags=True`. Ключи тегов, начинающиеся с `aws:`, зарезервированы Amazon и не могут быть изменены. Поэтому при обработке параметра `purge_tags` они будут проигнорированы. Дополнительные сведения см. в документации Amazon: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions. Варианты: `false` `true` ← (по умолчанию)
region псевдонимы: aws_region строка	Регион AWS, который следует использовать. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также можно использовать переменную окружения `AWS_REGION`. Дополнительные сведения см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.
route_table_ids список / элементы=строка	Список из одного или нескольких идентификаторов таблиц маршрутизации для привязки к конечной точке. Если указан идентификатор конечной точки, в таблицу маршрутизации добавляется маршрут с ее адресом назначения. Идентификаторы таблиц маршрутизации допустимы только для конечных точек типа Gateway.
secret_key псевдонимы: aws_secret_access_key, aws_secret_key строка	Секретный ключ доступа AWS. Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные окружения `AWS_SECRET_ACCESS_KEY` или `AWS_SECRET_KEY` в порядке убывания приоритета. Параметры secret_key и profile являются взаимоисключающими. Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для соответствия AWS SDK botocore.
service строка	Сервис конечных точек VPC, поддерживаемый AWS. Используйте модуль amazon.aws.ec2_vpc_endpoint_info, чтобы получить сведения о поддерживаемых сервисах конечных точек. Обязателен при создании конечной точки.
session_token псевдонимы: aws_session_token строка	Токен сеанса AWS STS для использования с временными учетными данными. Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменную окружения `AWS_SESSION_TOKEN`. Параметры session_token и profile являются взаимоисключающими.
state строка	`present` — обеспечить создание ресурса. `absent` — удалить ресурс. Варианты: `"present"` ← (по умолчанию) `"absent"`
tags псевдонимы: resource_tags словарь	Словарь с тегами, которые следует применить к ресурсу. Если параметр `tags` не указан, теги не будут изменены.
validate_certs логическое значение	Если задано значение `false`, сертификаты SSL при обмене данными с API AWS проверяться не будут. Настоятельно не рекомендуется задавать validate_certs=false; вместо этого рассмотрите возможность указать aws_ca_bundle. Варианты: `false` `true` ← (по умолчанию)
vpc_endpoint_id строка	Идентификатор одной или нескольких конечных точек VPC для удаления из учетной записи AWS. Обязателен, если `state=absent`.
vpc_endpoint_security_groups список / элементы=строка добавлено в amazon.aws 2.1.0	Список групп безопасности для привязки к конечной точке. Требуется `vpc_endpoint_type=GatewayLoadBalancer` или `vpc_endpoint_type=Interface`.
vpc_endpoint_subnets список / элементы=строка добавлено в amazon.aws 2.1.0	Список подсетей для привязки к конечной точке. Требуется `vpc_endpoint_type=GatewayLoadBalancer` или `vpc_endpoint_type=Interface`.
vpc_endpoint_type строка добавлено в amazon.aws 1.5.0	Тип конечной точки. Варианты: `"Interface"` `"Gateway"` ← (по умолчанию) `"GatewayLoadBalancer"`
vpc_id строка	Обязателен при создании конечной точки VPC.
wait логическое значение	Если параметр указан, модуль будет ожидать, пока статус `state=present` не станет available. К сожалению, при удалении это не учитывается из-за отличий в поведении AWS. Варианты: `false` ← (по умолчанию) `true`
wait_timeout целое число	Используется совместно с `wait`. Количество секунд ожидания изменения статуса. К сожалению, при удалении это не учитывается из-за отличий в поведении AWS. По умолчанию: `320`

Примечания

Примечание

Поддержка tags и purge_tags добавлена в выпуске 1.5.0.
Параметр policy_file удален в выпуске 6.0.0; вместо него используйте параметр policy и плагин поиска ansible.builtin.file.
Внимание: Для модулей переменные окружения и файлы конфигурации считываются в контексте «узла» Ansible, а не «контроллера». Поэтому файлы может потребоваться явно скопировать на «узел». Для плагинов поиска и подключения переменные окружения и файлы конфигурации считываются в контексте «контроллера» Ansible, а не «узла».
Используемый Ansible пакет AWS SDK (boto3) также может считывать значения по умолчанию для учетных данных и других параметров, например региона, из файлов конфигурации в контексте «узла» Ansible (обычно ~/.aws/credentials). Дополнительные сведения см. на странице https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.

Примеры

# 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
  amazon.aws.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 with the default policy
  amazon.aws.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: Delete newly created vpc endpoint
  amazon.aws.ec2_vpc_endpoint:
    state: absent
    vpc_endpoint_id: "{{ new_vpc_endpoint.result['VpcEndpointId'] }}"
    region: ap-southeast-2

Возвращаемые значения

Общие возвращаемые значения описаны здесь, далее перечислены поля, уникальные для этого модуля:

Ключ	Описание
endpoints list / elements=dictionary	Результирующие конечные точки, возвращаемые вызовом модуля. Возвращается: при успешном выполнении
creation_timestamp string	Дата и время создания конечной точки. Возвращается: всегда
dns_entries list / elements=dictionary	Список записей DNS для конечной точки. Возвращается: всегда
dns_name string	Имя DNS. Возвращается: всегда
hosted_zone_id string	Идентификатор частной размещённой зоны. Возвращается: при успешном выполнении
groups list / elements=dictionary	Список групп безопасности, связанных с сетевым интерфейсом. Возвращается: всегда
group_id string	Идентификатор группы безопасности. Возвращается: всегда
group_name string	Имя группы безопасности. Возвращается: всегда
ip_address_type string	Тип IP-адреса для конечной точки. Возвращается: при успешном выполнении
network_interface_ids list / elements=string	Список сетевых интерфейсов для конечной точки. Возвращается: всегда
owner_id string	Идентификатор учётной записи AWS, которой принадлежит конечная точка. Возвращается: всегда
policy_document string	Документ политики, связанный с конечной точкой. Возвращается: всегда
private_dns_enabled boolean	Указывает, связана ли VPC с частной размещённой зоной. Возвращается: всегда
requester_managed boolean	Указывает, управляет ли конечной точкой связанная с ней служба. Возвращается: всегда
route_table_ids list / elements=string	Список идентификаторов таблиц маршрутизации, связанных с конечной точкой. Возвращается: всегда
service_name string	Имя службы, с которой связана конечная точка. Возвращается: всегда
state string	Состояние конечной точки. Возвращается: всегда
subnet_ids list / elements=string	Список подсетей, связанных с конечной точкой. Возвращается: всегда
tags list / elements=dictionary	Список тегов, связанных с конечной точкой. Возвращается: всегда
vpc_endpoint_id string	Идентификатор конечной точки. Возвращается: всегда
vpc_endpoint_type string	Тип конечной точки. Возвращается: всегда
vpc_id string	Идентификатор VPC. Возвращается: всегда

Авторы

Karen Cheng (@Etherdaemon)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/amazon/aws/ec2_vpc_endpoint_module.html