community.aws.ec2_vpc_peering_info модуль — Получает данные о связи VPC AWS с использованием методов AWS.

Примечание

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

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

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

Для использования в плейбуке укажите: community.aws.ec2_vpc_peering_info.

Новый в community.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 строка	Идентификатор ключа доступа 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.
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.
filters словарь	Словарь фильтров для применения. Каждый элемент словаря состоит из ключа фильтра и значения фильтра. Возможные фильтры см. в https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpcPeeringConnections.html. По умолчанию: `{}`
peer_connection_ids список / элементы=строка	Список идентификаторов конкретных соединений VPC для получения подробной информации.
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.
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.
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. Также могут использоваться переменные окружения `AWS_SECRET_ACCESS_KEY`, `AWS_SECRET_KEY`, или `EC2_SECRET_KEY` в порядке убывания приоритета. Параметры secret_key и profile взаимоисключающие. Псевдоним aws_secret_access_key был добавлен в релизе 5.1.0 для соответствия SDK AWS botocore. Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной окружения `EC2_SECRET_KEY` устарела и будет удалена в релизе после 2024-12-01.

END_OF_DOCUMENT_MARKER

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 устарели и будут удалены в релизе после 01.12.2024.

Поддержка переменных среды EC2_SECRET_KEY и AWS_SECURITY_TOKEN устарела и будет удалена в релизе после 01.12.2024.

validate_certs

boolean

При установке в значение false, сертификаты SSL не будут проверятся при общении с API AWS.

Установка validate_certs=false крайне не рекомендуется; вместо этого рассмотрите возможность настройки aws_ca_bundle.

Варианты:

false
true ← (по умолчанию)

Примечания

Примечание

Внимание: Для модулей переменные среды и конфигурационные файлы считываются из контекста хоста 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 VPC Peers
- name: List all vpc peers
  community.aws.ec2_vpc_peering_info:
    region: ap-southeast-2
  register: all_vpc_peers

- name: Debugging the result
  ansible.builtin.debug:
    msg: "{{ all_vpc_peers.result }}"

- name: Get details on specific VPC peer
  community.aws.ec2_vpc_peering_info:
    peer_connection_ids:
      - pcx-12345678
      - pcx-87654321
    region: ap-southeast-2
  register: all_vpc_peers

- name: Get all vpc peers with specific filters
  community.aws.ec2_vpc_peering_info:
    region: ap-southeast-2
    filters:
      status-code: ['pending-acceptance']
  register: pending_vpc_peers

Значения возврата

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

Ключ	Описание
result список / элементы=строка	Результат описания. Возвращается: успешно
vpc_peering_connections список / элементы=строка	Подробности соответствующих соединений VPC peering. Возвращается: успешно
accepter_vpc_info сложный	Информация о VPC, принявшей соединение. Возвращается: успешно
cidr_block строка	Основной CIDR для VPC. Возвращается: когда соединение находится в состоянии принятия. Пример: `"10.10.10.0/23"`
cidr_block_set сложный	Список всех CIDR для VPC. Возвращается: когда соединение находится в состоянии принятия.
cidr_block строка	Блок CIDR, используемый VPC. Возвращается: успешно Пример: `"10.10.10.0/23"`
owner_id строка	AWS аккаунт, которому принадлежит VPC. Возвращается: успешно Пример: `"123456789012"`
peering_options словарь	Дополнительная конфигурация peering. Возвращается: когда соединение находится в состоянии принятия.
allow_dns_resolution_from_remote_vpc булево	Указывает, может ли VPC разрешать общедоступные имена хостов DNS до частных IP-адресов при запросе из экземпляров в паре VPC. Возвращается: успешно
allow_egress_from_local_classic_link_to_remote_vpc булево	Указывает, может ли локальное соединение ClassicLink взаимодействовать с VPC-партнёром через соединение VPC peering. Возвращается: успешно
allow_egress_from_local_vpc_to_remote_classic_link булево	Указывает, может ли локальная VPC взаимодействовать с ClassicLink-соединением в паре VPC через соединение VPC peering. Возвращается: успешно
region строка	AWS регион, в котором находится VPC. Возвращается: успешно Пример: `"us-east-1"`
vpc_id строка	Идентификатор VPC Возвращается: успешно Пример: `"vpc-0123456789abcdef0"`
requester_vpc_info сложный	Информация о VPC, запросившей соединение. Возвращается: успешно
cidr_block строка	Основной CIDR для VPC. Возвращается: если соединение не в состоянии удаления. Пример: `"10.10.10.0/23"`
cidr_block_set сложный	Список всех CIDR для VPC. Возвращается: если соединение не в состоянии удаления.
cidr_block строка	Блок CIDR, используемый VPC Возвращается: успешно Пример: `"10.10.10.0/23"`

END_OF_DOCUMENT_MARKER

owner_id string	Учётная запись AWS, владеющая VPC. Возвращается: успех Пример: `"123456789012"`
peering_options словарь	Дополнительная конфигурация для перинга. Возвращается: когда подключение не находится в состоянии удаления.
allow_dns_resolution_from_remote_vpc булево	Указывает, может ли VPC разрешать общедоступные имена хостов DNS до частных IP-адресов при запросе из экземпляров в связанной VPC. Возвращается: успех
allow_egress_from_local_classic_link_to_remote_vpc булево	Указывает, может ли локальное подключение ClassicLink взаимодействовать с удалённой VPC через подключение VPC перинга. Возвращается: успех
allow_egress_from_local_vpc_to_remote_classic_link булево	Указывает, может ли локальная VPC взаимодействовать с подключением ClassicLink в удалённой VPC через подключение VPC перинга. Возвращается: успех
region строка	AWS регион, в котором находится VPC. Возвращается: успех Пример: `"us-east-1"`
vpc_id строка	ID VPC. Возвращается: успех Пример: `"vpc-0123456789abcdef0"`
status сложный	Подробности текущего состояния подключения. Возвращается: успех
code строка	Краткое описание состояния подключения. Возвращается: успех Пример: `"active"`
message строка	Дополнительная информация о состоянии подключения. Возвращается: успех Пример: `"Pending Acceptance by 123456789012"`
tags словарь	Теги, применённые к подключению. Возвращается: успех
vpc_peering_connection_id строка	ID подключения VPC перинга. Возвращается: успех Пример: `"pcx-0123456789abcdef0"`

Авторы

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/community/aws/ec2_vpc_peering_info_module.html