ec2_vpc_endpoint_facts – Получение данных об AWS VPC-эндпоинтах с использованием методов AWS.
Новая версия 2.4.
Синопсис
- Получает различные данные, связанные с 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 |
|
| ec2_url
-
|
URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковая существует.
|
|
| filters
-
|
Словарь фильтров для применения. Каждый элемент словаря состоит из ключа фильтра и значения фильтра. См. http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpcEndpoints.html для возможных фильтров.
|
|
Примечания
Примечание
- Если параметры не заданы в модуле, могут использоваться следующие переменные окружения в порядке убывания приоритета
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
Примеры
# Simple example of listing all support AWS services for VPC endpoints
- name: List supported AWS endpoint services
ec2_vpc_endpoint_facts:
query: services
region: ap-southeast-2
register: supported_endpoint_services
- name: Get all endpoints in ap-southeast-2 region
ec2_vpc_endpoint_facts:
query: endpoints
region: ap-southeast-2
register: existing_endpoints
- name: Get all endpoints with specific filters
ec2_vpc_endpoint_facts:
query: endpoints
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
ec2_vpc_endpoint_facts:
query: endpoints
region: ap-southeast-2
vpc_endpoint_ids:
- vpce-12345678
register: endpoint_details
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| service_names
список |
query равно services
|
Названия служб AWS VPC-эндпоинтов
Пример:
{'service_names': ['com.amazonaws.ap-southeast-2.s3']}
|
| vpc_endpoints
список |
query равно endpoints
|
Список эндпоинтов, соответствующих запросу. Каждый эндпоинт имеет ключи creation_timestamp, policy_document, route_table_ids, service_name, state, vpc_endpoint_id, vpc_id.
Пример:
{'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'}]}
|
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- 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.7/modules/ec2_vpc_endpoint_facts_module.html