Модуль amazon.aws.ec2_vpc_endpoint_info — получение сведений о конечных точках AWS VPC с помощью методов AWS

Примечание

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

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

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

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

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

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Получает различные сведения о конечных точках 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 botocore SDK.
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.
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`.
filters словарь	Словарь фильтров для применения. Каждый элемент словаря состоит из ключа фильтра и его значения. Список возможных фильтров см. на странице https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpcEndpoints.html. По умолчанию: `{}`
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.
region псевдонимы: aws_region строка	Используемый регион AWS. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также можно использовать переменную окружения `AWS_REGION`. Дополнительные сведения см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.
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 botocore SDK.
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 являются взаимоисключающими.
validate_certs логическое значение	Если задано значение `false`, SSL-сертификаты при взаимодействии с API AWS проверяться не будут. Настоятельно не рекомендуется устанавливать validate_certs=false; в качестве альтернативы рассмотрите возможность задать aws_ca_bundle. Варианты: `false` `true` ← (по умолчанию)
vpc_endpoint_ids список / элементы=строка	Идентификаторы конкретных конечных точек, сведения о которых нужно получить.

Примечания

Примечание

Поддержка параметра query была удалена в выпуске 6.0.0. Теперь этот модуль выполняет запросы только для конечных точек. Сведения о службах конечных точек можно получить с помощью модуля amazon.aws.ec2_vpc_endpoint_service_info.
Внимание: Для модулей переменные окружения и файлы конфигурации считываются из контекста «узла» Ansible, а не из контекста «контроллера». Поэтому файлы может потребоваться явно скопировать на «узел». Для плагинов поиска и подключения переменные окружения и файлы конфигурации считываются из контекста «контроллера» Ansible, а не из контекста «узла».
Используемый Ansible пакет AWS SDK (boto3) также может считывать значения учетных данных и других параметров по умолчанию, например региона, из файлов конфигурации в контексте «узла» Ansible (обычно ~/.aws/credentials). Дополнительные сведения см. на странице https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.

Примеры

# Simple example of listing all support AWS services for VPC endpoints
- name: Get all endpoints in ap-southeast-2 region
  amazon.aws.ec2_vpc_endpoint_info:
    region: ap-southeast-2
  register: existing_endpoints

- name: Get all endpoints with specific filters
  amazon.aws.ec2_vpc_endpoint_info:
    region: ap-southeast-2
    filters:
      vpc-id:
        - vpc-12345678
        - vpc-87654321
      vpc-endpoint-state:
        - available
        - pending
  register: existing_endpoints

- name: Get details on specific endpoint
  amazon.aws.ec2_vpc_endpoint_info:
    region: ap-southeast-2
    vpc_endpoint_ids:
      - vpce-12345678
  register: endpoint_details

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

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

Ключ	Описание
vpc_endpoints список / элементы=словарь	Список соответствующих конечных точек. Возвращается: всегда Пример: {"vpc_endpoints": [{"creation_timestamp": "2017-02-16T11:06:48+00:00", "policy_document": "\"{\\\"Version\\\":\\\"2012-10-17\\\",\\\"Id\\\":\\\"Policy1450910922815\\\", \\\"Statement\\\":[{\\\"Sid\\\":\\\"Stmt1450910920641\\\",\\\"Effect\\\":\\\"Allow\\\", \\\"Principal\\\":\\\"\\\",\\\"Action\\\":\\\"s3:\\\",\\\"Resource\\\":[\\\"arn:aws:s3:::/\\\",\\\"arn:aws:s3:::*\\\"]}]}\"\n", "route_table_ids": ["rtb-abcd1234"], "service_name": "com.amazonaws.ap-southeast-2.s3", "state": "available", "vpc_endpoint_id": "vpce-abbad0d0", "vpc_id": "vpc-1111ffff"}]}
creation_timestamp строка	Дата и время создания конечной точки. Возвращается: всегда
dns_entries список / элементы=словарь	Список DNS-записей для конечной точки. Возвращается: всегда
dns_name строка	Имя DNS. Возвращается: всегда
hosted_zone_id строка	Идентификатор частной размещенной зоны. Возвращается: при успехе
groups список / элементы=словарь	Список групп безопасности, связанных с сетевым интерфейсом. Возвращается: всегда
group_id строка	Идентификатор группы безопасности. Возвращается: всегда
group_name строка	Имя группы безопасности. Возвращается: всегда
ip_address_type строка	Тип IP-адреса конечной точки. Возвращается: при успехе
network_interface_ids список / элементы=строка	Список сетевых интерфейсов конечной точки. Возвращается: всегда
owner_id строка	Идентификатор учетной записи AWS, которой принадлежит конечная точка. Возвращается: всегда
policy_document строка	Документ политики, связанный с конечной точкой. Возвращается: всегда
private_dns_enabled логическое значение	Указывает, связана ли VPC с частной размещенной зоной. Возвращается: всегда
requester_managed логическое значение	Указывает, управляется ли конечная точка соответствующей службой. Возвращается: всегда
route_table_ids список / элементы=строка	Список идентификаторов таблиц маршрутизации, связанных с конечной точкой. Возвращается: всегда
service_name строка	Имя службы, с которой связана конечная точка. Возвращается: всегда
state строка	Состояние конечной точки. Возвращается: всегда
subnet_ids список / элементы=строка	Список подсетей, связанных с конечной точкой. Возвращается: всегда
tags список / элементы=словарь	Список тегов, связанных с конечной точкой. Возвращается: всегда
vpc_endpoint_id строка	Идентификатор конечной точки. Возвращается: всегда
vpc_endpoint_type строка	Тип конечной точки. Возвращается: всегда
vpc_id строка	Идентификатор 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_info_module.html