Модуль amazon.aws.ec2_vpc_peering — создание, удаление, принятие и отклонение подключений пиринга VPC между двумя VPC.

Примечание

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

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

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

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

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

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

См. документацию AWS о подключениях пиринга VPC: https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/vpc-peering.html.

Псевдонимы: ec2_vpc_peer

Требования

Следующие требования необходимы на хосте, выполняющем этот модуль.

python >= 3.6
boto3 >= 1.35.0
botocore >= 1.35.0

Параметры

Параметр	Комментарии
access_key псевдонимы: aws_access_key_id, aws_access_key string	Идентификатор ключа доступа 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 path	Путь к пакету сертификатов центра сертификации, используемому для проверки SSL-сертификатов. Также можно использовать переменную среды `AWS_CA_BUNDLE`.
aws_config dictionary	Словарь для изменения конфигурации botocore. Список параметров приведен в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
debug_botocore_endpoint_logs boolean	Использовать регистратор `botocore.endpoint` для анализа уникальных (а не общего количества) вызовов API `"resource:action"`, выполненных во время задачи, и выводить набор в ключ resource_actions результатов задачи. Используйте callback `aws_resource_action`, чтобы вывести общий список вызовов, выполненных в ходе плейбука. Также можно использовать переменную среды `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
endpoint_url псевдонимы: aws_endpoint_url string	URL для подключения вместо конечных точек AWS по умолчанию. Этот параметр можно использовать для подключения к другим сервисам, совместимым с AWS, однако коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную среды `AWS_URL`.
peer_owner_id string	Номер учетной записи AWS для пиринга между учетными записями.
peer_region string	Регион принимающей VPC.
peer_vpc_id string	Идентификатор принимающей VPC.
peering_id string	Идентификатор подключения пиринга.
profile псевдонимы: aws_profile string	Именованный профиль 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.
purge_tags boolean	Если задано `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 string	Регион 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 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` в порядке убывания приоритета. Параметры secret_key и profile являются взаимоисключающими. Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для согласованности с AWS botocore SDK.
session_token псевдонимы: aws_session_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`. Параметры session_token и profile являются взаимоисключающими.
state string	Создание, удаление, принятие или отклонение подключения пиринга. Варианты: `"present"` ← (по умолчанию) `"absent"` `"accept"` `"reject"`
tags псевдонимы: resource_tags dictionary	Словарь тегов, применяемых к ресурсу. Если параметр `tags` не задан, теги не будут изменены.
validate_certs boolean	Если задано значение `false`, SSL-сертификаты при взаимодействии с API AWS проверяться не будут. Настоятельно не рекомендуется устанавливать validate_certs=false; вместо этого рассмотрите возможность указать aws_ca_bundle. Варианты: `false` `true` ← (по умолчанию)
vpc_id string	Идентификатор инициирующей VPC.
wait boolean	Ожидать завершения изменений состояния пиринга. Варианты: `false` ← (по умолчанию) `true`

Примечания

Примечание

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

Примеры

# Complete example to create and accept a local peering connection.
- name: Create local account EC2 VPC Peering Connection
  amazon.aws.ec2_vpc_peering:
    region: "ap-southeast-2"
    vpc_id: "vpc-12345678"
    peer_vpc_id: "vpc-87654321"
    state: "present"
    tags:
      Name: "Peering connection for VPC 21 to VPC 22"
      CostCode: "CC1234"
      Project: "phoenix"
  register: vpc_peer

- name: Accept local EC2 VPC Peering request
  amazon.aws.ec2_vpc_peering:
    region: "ap-southeast-2"
    peering_id: "{{ vpc_peer.peering_id }}"
    state: "accept"
  register: action_peer

# Complete example to delete a local peering connection.
- name: Create local account EC2 VPC Peering Connection
  amazon.aws.ec2_vpc_peering:
    region: "ap-southeast-2"
    vpc_id: "vpc-12345678"
    peer_vpc_id: "vpc-87654321"
    state: "present"
    tags:
      Name: "Peering connection for VPC 21 to VPC 22"
      CostCode: "CC1234"
      Project: "phoenix"
  register: vpc_peer

- name: Delete a local EC2 VPC Peering Connection
  amazon.aws.ec2_vpc_peering:
    region: "ap-southeast-2"
    peering_id: "{{ vpc_peer.peering_id }}"
    state: "absent"
  register: vpc_peer

  # Complete example to create and accept a cross account peering connection.
- name: Create cross account EC2 VPC Peering Connection
  amazon.aws.ec2_vpc_peering:
    region: "ap-southeast-2"
    vpc_id: "vpc-12345678"
    peer_vpc_id: "vpc-12345678"
    peer_owner_id: "123456789012"
    state: "present"
    tags:
      Name: "Peering connection for VPC 21 to VPC 22"
      CostCode: "CC1234"
      Project: "phoenix"
  register: vpc_peer

- name: Accept EC2 VPC Peering Connection from remote account
  amazon.aws.ec2_vpc_peering:
    region: "ap-southeast-2"
    peering_id: "{{ vpc_peer.peering_id }}"
    profile: "bot03_profile_for_cross_account"
    state: "accept"
  register: vpc_peer

# Complete example to create and accept an intra-region peering connection.
- name: Create intra-region EC2 VPC Peering Connection
  amazon.aws.ec2_vpc_peering:
    region: "us-east-1"
    vpc_id: "vpc-12345678"
    peer_vpc_id: "vpc-87654321"
    peer_region: "us-west-2"
    state: "present"
    tags:
      Name: "Peering connection for us-east-1 VPC to us-west-2 VPC"
      CostCode: "CC1234"
      Project: "phoenix"
  register: vpc_peer

- name: Accept EC2 VPC Peering Connection from peer region
  amazon.aws.ec2_vpc_peer:
    region: "us-west-2"
    peering_id: "{{ vpc_peer.peering_id }}"
    state: "accept"
  register: vpc_peer

# Complete example to create and reject a local peering connection.
- name: Create local account EC2 VPC Peering Connection
  amazon.aws.ec2_vpc_peering:
    region: "ap-southeast-2"
    vpc_id: "vpc-12345678"
    peer_vpc_id: "vpc-87654321"
    state: "present"
    tags:
      Name: "Peering connection for VPC 21 to VPC 22"
      CostCode: "CC1234"
      Project: "phoenix"
  register: vpc_peer

- name: Reject a local EC2 VPC Peering Connection
  amazon.aws.ec2_vpc_peering:
    region: "ap-southeast-2"
    peering_id: "{{ vpc_peer.peering_id }}"
    state: "reject"

# Complete example to create and accept a cross account peering connection.
- name: Create cross account EC2 VPC Peering Connection
  amazon.aws.ec2_vpc_peering:
    region: "ap-southeast-2"
    vpc_id: "vpc-12345678"
    peer_vpc_id: "vpc-12345678"
    peer_owner_id: "123456789012"
    state: "present"
    tags:
      Name: "Peering connection for VPC 21 to VPC 22"
      CostCode: "CC1234"
      Project: "phoenix"
  register: vpc_peer

- name: Accept a cross account EC2 VPC Peering Connection request
  amazon.aws.ec2_vpc_peering:
    region: "ap-southeast-2"
    peering_id: "{{ vpc_peer.peering_id }}"
    profile: "bot03_profile_for_cross_account"
    state: "accept"
    tags:
      Name: "Peering connection for VPC 21 to VPC 22"
      CostCode: "CC1234"
      Project: "phoenix"

# Complete example to create and reject a cross account peering connection.
- name: Create cross account EC2 VPC Peering Connection
  amazon.aws.ec2_vpc_peering:
    region: "ap-southeast-2"
    vpc_id: "vpc-12345678"
    peer_vpc_id: "vpc-12345678"
    peer_owner_id: "123456789012"
    state: "present"
    tags:
      Name: "Peering connection for VPC 21 to VPC 22"
      CostCode: "CC1234"
      Project: "phoenix"
  register: vpc_peer

- name: Reject a cross account EC2 VPC Peering Connection
  amazon.aws.ec2_vpc_peeriing:
    region: "ap-southeast-2"
    peering_id: "{{ vpc_peer.peering_id }}"
    profile: "bot03_profile_for_cross_account"
    state: "reject"

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

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

Ключ	Описание
peering_id string	Идентификатор созданного или удалённого соединения пиринга VPC. Возвращается: всегда Пример: `"pcx-034223d7c0aec3cde"`
vpc_peering_connection dictionary	Сведения о соединении пиринга VPC. Возвращается: при успешном выполнении
accepter_vpc_info dictionary	Сведения о VPC, принявшей соединение. Возвращается: при успешном выполнении
cidr_block string	Основной CIDR-блок VPC. Возвращается: когда соединение находится в принятом состоянии Пример: `"10.10.10.0/23"`
cidr_block_set list / elements=dictionary	Список всех CIDR-блоков VPC. Возвращается: когда соединение находится в принятом состоянии
cidr_block string	CIDR-блок, используемый VPC. Возвращается: при успешном выполнении Пример: `"10.10.10.0/23"`
owner_id string	Учётная запись AWS, которой принадлежит VPC. Возвращается: при успешном выполнении Пример: `"123456789012"`
peering_options dictionary	Дополнительная конфигурация пиринга. Возвращается: когда соединение находится в принятом состоянии
allow_dns_resolution_from_remote_vpc boolean	Указывает, может ли VPC преобразовывать общедоступные имена хостов DNS в частные IP-адреса при запросах от экземпляров в одноранговой VPC. Возвращается: при успешном выполнении
allow_egress_from_local_classic_link_to_remote_vpc boolean	Указывает, может ли локальное соединение ClassicLink обмениваться данными с одноранговой VPC через соединение пиринга VPC. Возвращается: при успешном выполнении
allow_egress_from_local_vpc_to_remote_classic_link boolean	Указывает, может ли локальная VPC обмениваться данными с соединением ClassicLink в одноранговой VPC через соединение пиринга VPC. Возвращается: при успешном выполнении
region string	Регион AWS, в котором находится VPC. Возвращается: при успешном выполнении Пример: `"us-east-1"`
vpc_id string	Идентификатор VPC Возвращается: при успешном выполнении Пример: `"vpc-0123456789abcdef0"`
expiration_time string	Время истечения срока действия непринятого соединения пиринга VPC. Возвращается: при успешном выполнении Пример: `"2024-10-01T12:11:12+00:00"`
requester_vpc_info dictionary	Сведения о VPC, запросившей соединение. Возвращается: при успешном выполнении
cidr_block string	Основной CIDR-блок VPC. Возвращается: когда соединение не находится в удалённом состоянии Пример: `"10.10.10.0/23"`
cidr_block_set list / elements=dictionary	Список всех CIDR-блоков VPC. Возвращается: когда соединение не находится в удалённом состоянии
cidr_block string	CIDR-блок, используемый VPC Возвращается: при успешном выполнении Пример: `"10.10.10.0/23"`
owner_id string	Учётная запись AWS, которой принадлежит VPC. Возвращается: при успешном выполнении Пример: `"123456789012"`
peering_options dictionary	Дополнительная конфигурация пиринга. Возвращается: когда соединение не находится в удалённом состоянии
allow_dns_resolution_from_remote_vpc boolean	Указывает, может ли VPC преобразовывать общедоступные имена хостов DNS в частные IP-адреса при запросах от экземпляров в одноранговой VPC. Возвращается: при успешном выполнении
allow_egress_from_local_classic_link_to_remote_vpc boolean	Указывает, может ли локальное соединение ClassicLink обмениваться данными с одноранговой VPC через соединение пиринга VPC. Возвращается: при успешном выполнении
allow_egress_from_local_vpc_to_remote_classic_link boolean	Указывает, может ли локальная VPC обмениваться данными с соединением ClassicLink в одноранговой VPC через соединение пиринга VPC. Возвращается: при успешном выполнении
region string	Регион AWS, в котором находится VPC. Возвращается: при успешном выполнении Пример: `"us-east-1"`
vpc_id string	Идентификатор VPC Возвращается: при успешном выполнении Пример: `"vpc-0123456789abcdef0"`
status complex	Сведения о текущем состоянии соединения. Возвращается: при успешном выполнении
code string	Краткий код, описывающий состояние соединения. Возвращается: при успешном выполнении Пример: `"active"`
message string	Дополнительные сведения о состоянии соединения. Возвращается: при успешном выполнении Пример: `"Pending Acceptance by 123456789012"`
tags dictionary	Теги, назначенные соединению. Возвращается: при успешном выполнении
vpc_peering_connection_id string	Идентификатор соединения пиринга VPC. Возвращается: при успешном выполнении Пример: `"pcx-0123456789abcdef0"`

Авторы

Mike Mochan (@mmochan)
Alina Buzachis (@alinabuzachis)

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

© 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_peering_module.html