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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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.26.0
botocore >= 1.29.0

Параметры

Параметр	Комментарии
access_key псевдонимы: aws_access_key_id, aws_access_key, ec2_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` или `EC2_ACCESS_KEY` в порядке убывания приоритета. Параметры aws_access_key и profile взаимоисключающие. Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore. Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной окружения `EC2_ACCESS_KEY` устарела и будет удалена в релизе после 2024-12-01.
aws_ca_bundle путь	Расположение файла с набором сертификатов CA для проверки 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`, чтобы проанализировать уникальные (а не все) `"resource:action"` API-вызовы, сделанные во время задания, выведя набор в ключ resource_actions в результатах задания. Используйте обратный вызов `aws_resource_action`, чтобы вывести полный список, сделанный во время выполнения книги задач. Также может быть использована переменная окружения `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
endpoint_url псевдонимы: ec2_url, aws_endpoint_url, s3_url строка	URL для подключения вместо стандартных конечных точек AWS. Хотя это можно использовать для подключения к другим совместимым с AWS службам, коллекции amazon.aws и community.aws протестированы только для AWS. Также могут быть использованы переменные окружения `AWS_URL` или `EC2_URL` в порядке убывания приоритета. Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01. Поддержка переменной окружения `EC2_URL` устарела и будет удалена в релизе после 2024-12-01.
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 и security_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, ec2_region строка	AWS-регион для использования. Для глобальных служб, таких как IAM, Route53 и CloudFront, region игнорируется. Также могут быть использованы переменные окружения `AWS_REGION` или `EC2_REGION`. См. документацию Amazon AWS для получения дополнительной информации http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. Псевдоним `ec2_region` устарел и будет удален в релизе после 2024-12-01. Поддержка переменной окружения `EC2_REGION` устарела и будет удалена в релизе после 2024-12-01.
route_table_ids список / элементы=строка	Список одного или нескольких идентификаторов таблиц маршрутизации для прикрепления к конечной точке. Маршрут добавляется в таблицу маршрутизации с пунктом назначения конечной точки, если он предоставлен. Идентификаторы таблиц маршрутизации действительны только для конечных точек шлюза.

secret_key aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key string	Секретный ключ доступа 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`, или `EC2_SECRET_KEY` также могут использоваться в порядке убывания предпочтения. Параметры secret_key и profile являются взаимоисключающими. Псевдоним aws_secret_access_key был добавлен в релизе 5.1.0 для согласованности с AWS botocore SDK. Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной окружения `EC2_SECRET_KEY` устарела и будет удалена в релизе после 2024-12-01.
service string	Поддерживаемая службой AWS служба конечной точки VPC. Используйте модуль amazon.aws.ec2_vpc_endpoint_info для описания поддерживаемых служб конечных точек. Обязательно при создании конечной точки.
session_token aliases: aws_session_token, security_token, aws_security_token, access_token string	Сеансовый токен 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`, `AWS_SECURITY_TOKEN` или `EC2_SECURITY_TOKEN` также могут использоваться в порядке убывания предпочтения. Параметры security_token и profile являются взаимоисключающими. Псевдонимы aws_session_token и session_token были добавлены в релизе 3.2.0, а параметр был переименован из security_token в session_token в релизе 6.0.0. Псевдонимы security_token, aws_security_token и access_token устарели и будут удалены в релизе после 2024-12-01. Поддержка переменных окружения `EC2_SECRET_KEY` и `AWS_SECURITY_TOKEN` устарела и будет удалена в релизе после 2024-12-01.
state string	`present` для обеспечения создания ресурса. `absent` для удаления ресурса. Варианты: `"present"` ← (по умолчанию) `"absent"`
tags aliases: resource_tags dictionary	Словарь, представляющий теги, которые будут применены к ресурсу. Если параметр tags не задан, теги не будут изменены.
validate_certs boolean	При установке в значение `false`, SSL-сертификаты не будут проверяться для связи с API AWS. Установка validate_certs=false настоятельно не рекомендуется, в качестве альтернативы рассмотрите возможность установки aws_ca_bundle. Варианты: `false` `true` ← (по умолчанию)
vpc_endpoint_id string	Один или несколько ID конечных точек VPC для удаления из учетной записи AWS. Обязательно, если `state=absent`.
vpc_endpoint_security_groups list / elements=string добавлено в amazon.aws 2.1.0	Список групп безопасности для подключения к конечной точке. Требуется `vpc_endpoint_type=GatewayLoadBalancer` или `vpc_endpoint_type=Interface`.
vpc_endpoint_subnets list / elements=string добавлено в amazon.aws 2.1.0	Список подсетей для подключения к конечной точке. Требуется `vpc_endpoint_type=GatewayLoadBalancer` или `vpc_endpoint_type=Interface`.
vpc_endpoint_type string добавлено в amazon.aws 1.5.0	Тип конечной точки. Варианты: `"Interface"` `"Gateway"` ← (по умолчанию) `"GatewayLoadBalancer"`
vpc_id string	Обязательно при создании конечной точки VPC.
wait boolean	При указании будет ожидать, пока статус не достигнет available для `state=present`. К сожалению, это игнорируется для действий по удалению из-за различий в поведении AWS. Варианты: `false` ← (по умолчанию) `true`
wait_timeout integer	Используется в сочетании с `wait`. Количество секунд ожидания статуса. К сожалению, это игнорируется для действий по удалению из-за различий в поведении AWS. По умолчанию: `320`

Примечания

Примечание

Поддержка tags и purge_tags была добавлена в релизе 1.5.0.
Параметр policy_file был удален в релизе 6.0.0, пожалуйста, используйте опцию policy и плагин поиска ansible.builtin.file вместо него.
Внимание: Для модулей переменные окружения и конфигурационные файлы считываются из контекста Ansible «хост», а не из контекста «контроллер». Следовательно, файлы могут потребоваться скопировать явно на «хост». Для плагинов поиска и подключения переменные окружения и конфигурационные файлы считываются из контекста Ansible «контроллер», а не из контекста «хост».
AWS SDK (boto3), который используется Ansible, также может считывать значения по умолчанию для учетных данных и других настроек, таких как регион, из своих конфигурационных файлов в контексте 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	Полученные конечные точки из вызова модуля. Возвращается: success
creation_timestamp string	Дата и время создания конечной точки. Возвращается: всегда
dns_entries list / elements=dictionary	Список записей DNS для конечной точки. Возвращается: всегда
dns_name string	DNS имя. Возвращается: всегда
hosted_zone_id string	ID частной хостинг-зоны. Возвращается: success
groups list / elements=dictionary	Список групп безопасности, связанных с сетевым интерфейсом. Возвращается: всегда
group_id string	ID группы безопасности. Возвращается: всегда
group_name string	Имя группы безопасности. Возвращается: всегда
ip_address_type string	Тип IP-адреса для конечной точки. Возвращается: success
network_interface_ids list / elements=string	Список сетевых интерфейсов для конечной точки. Возвращается: всегда
owner_id string	ID учетной записи AWS, которой принадлежит конечная точка. Возвращается: всегда
policy_document string	Документ политики, связанный с конечной точкой. Возвращается: всегда
private_dns_enabled boolean	Указывает, связана ли VPC с частной хостинг-зоной. Возвращается: всегда
requester_managed boolean	Указывает, управляет ли конечной точкой её служба. Возвращается: всегда
route_table_ids list / elements=string	Список ID таблиц маршрутизации, связанных с конечной точкой. Возвращается: всегда
service_name string	Имя службы, с которой связана конечная точка. Возвращается: всегда
state string	Состояние конечной точки. Возвращается: всегда
subnet_ids list / elements=string	Список подсетей, связанных с конечной точкой. Возвращается: всегда
tags list / elements=dictionary	Список тегов, связанных с конечной точкой. Возвращается: всегда
vpc_endpoint_id string	ID конечной точки. Возвращается: всегда
vpc_endpoint_type string	Тип конечной точки. Возвращается: всегда

vpc_id

string

Идентификатор VPC.

Возвращаемое значение: всегда

Авторы

Karen Cheng (@Etherdaemon)

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

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