Модуль amazon.aws.ec2_vpc_endpoint_info – Получает сведения об узлах конечных точек VPC AWS с помощью методов AWS
Примечание
Этот модуль является частью коллекции amazon.aws (версия 8.2.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install amazon.aws. Для использования этого модуля требуются дополнительные зависимости. Подробнее см. Требования.
Чтобы использовать его в книге задач, укажите: amazon.aws.ec2_vpc_endpoint_info.
Новое в amazon.aws 1.0.0
Описание
- Получает различные сведения об узлах конечных точек VPC AWS.
Требования
Ниже перечислены требования, необходимые на хосте, который выполняет этот модуль.
- python >= 3.6
- boto3 >= 1.26.0
- botocore >= 1.29.0
Параметры
Параметр | Комментарии |
|---|---|
access_key псевдонимы: aws_access_key_id, aws_access_key, ec2_access_key строка | ID ключа доступа AWS. Дополнительную информацию об маркерах доступа см. в документации AWS по https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды Опции aws_access_key и profile взаимоисключающие. Псевдоним aws_access_key_id добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore. Псевдоним ec2_access_key устарел и будет удалён в релизе после 2024-12-01. Поддержка переменной среды |
aws_ca_bundle путь | Расположение пакета CA-сертификатов для проверки SSL-сертификатов. Также можно использовать переменную среды |
aws_config словарь | Словарь для модификации конфигурации botocore. Параметры можно найти в документации AWS по https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
debug_botocore_endpoint_logs булево | Используйте Также можно использовать переменную среды Варианты:
|
endpoint_url псевдонимы: ec2_url, aws_endpoint_url, s3_url строка | URL для подключения вместо стандартных конечных точек AWS. Хотя это можно использовать для подключения к другим совместимым с AWS сервисам, коллекции amazon.aws и community.aws протестированы только против AWS. Также можно использовать переменные среды Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01. Поддержка переменной среды |
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. Также можно использовать переменную среды Опция profile взаимоисключающая с опциями aws_access_key, aws_secret_key и security_token. |
region псевдонимы: aws_region, ec2_region строка | AWS регион для использования. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, region игнорируется. Также можно использовать переменные среды Дополнительную информацию см. в документации Amazon AWS по http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. Псевдоним Поддержка переменной среды |
secret_key псевдонимы: aws_secret_access_key, aws_secret_key, ec2_secret_key строка | Секретный ключ доступа AWS. Дополнительную информацию об маркерах доступа см. в документации AWS по https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды Опции secret_key и profile взаимоисключающие. Псевдоним aws_secret_access_key добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore. Псевдоним ec2_secret_key устарел и будет удалён в релизе после 2024-12-01. Поддержка переменной среды |
session_token псевдонимы: aws_session_token, security_token, aws_security_token, access_token строка | Токен сеанса AWS STS для использования с временными учетными данными. Дополнительную информацию об маркерах доступа см. в документации AWS по https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды Опции 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. Поддержка переменных среды |
validate_certs boolean | При установке в Настройка validate_certs=false крайне не рекомендуется; в качестве альтернативы, рассмотрите настройку aws_ca_bundle вместо этого. Варианты:
|
vpc_endpoint_ids список / элементы=строка | Идентификаторы конкретных конечных точек для получения подробной информации. |
Примечания
Примечание
- Поддержка параметра query была удалена в релизе 6.0.0. Этот модуль теперь запросы только конечных точек. Информацию об услугах конечных точек можно получить, используя модуль amazon.aws.ec2_vpc_endpoint_service_info.
- Внимание: Для модулей переменные среды и конфигурационные файлы считываются из контекста Ansible «хост» а не «контроллер». Следовательно, файлы могут потребоваться скопировать в «хост». Для плагинов поиска и подключения переменные среды и конфигурационные файлы считываются из контекста Ansible «контроллер», а не «хост».
- AWS SDK (boto3), который использует Ansible, также может считывать значения по умолчанию для учетных данных и других настроек, таких как регион, из своих конфигурационных файлов в контексте 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 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. Возвращается: всегда |
Ссылки на коллекцию
© 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_info_module.html