community.aws.ec2_vpc_peer модуль — создание, удаление, принятие и отклонение подключений VPC-соединения между двумя VPC.

Примечание

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

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

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

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

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

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

Обзор

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

Требования

Ниже приведены требования к хосту, на котором выполняется этот модуль.

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_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.
peer_owner_id строка	Номер счета AWS для кросс-аккаунтного подключения.
peer_region строка	Регион принимающей VPC.
peer_vpc_id строка	ID VPC принимающей VPC.
peering_id строка	ID подключения для объединения.
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.
purge_tags логический	Если 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, 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 aliases: aws_secret_access_key, aws_secret_key, ec2_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`, или `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.
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 устарели и будут удалены в релизе после 2024-12-01. Поддержка переменных среды `EC2_SECRET_KEY` и `AWS_SECURITY_TOKEN` устарела и будет удалена в релизе после 2024-12-01.
state string	Создание, удаление, принятие, отклонение подключения peering. Варианты: `"present"` ← (по умолчанию) `"absent"` `"accept"` `"reject"`
tags aliases: resource_tags словарь	Словарь, представляющий теги, которые будут применены к ресурсу. Если параметр tags не задан, теги не будут изменены.
validate_certs boolean	При значении `false`, сертификаты SSL для связи с API AWS не будут проверены. Настройка validate_certs=false настоятельно не рекомендуется. В качестве альтернативы, рассмотрите настройку aws_ca_bundle. Варианты: `false` `true` ← (по умолчанию)
vpc_id строка	Идентификатор VPC запрашивающей VPC.
wait boolean	Ожидать завершения изменений состояния подключения peering. Варианты: `false` ← (по умолчанию) `true`

Примечания

Примечание

Поддержка purge_tags была добавлена в релизе 2.0.0.
Предупреждение: Для модулей переменные среды и конфигурационные файлы читаются из контекста Ansible «хост» а не «контроллера». Поэтому файлы могут потребоваться явно скопировать на «хост». Для плагинов поиска и соединения переменные среды и конфигурационные файлы читаются из контекста Ansible «контроллера» а не «хоста».
AWS SDK (boto3), используемый Ansible, также может считывать значения по умолчанию для учетных данных и других параметров, таких как регион, из своих конфигурационных файлов в контексте 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 VPC peering Connection
  community.aws.ec2_vpc_peer:
    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 VPC peering request
  community.aws.ec2_vpc_peer:
    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 VPC peering Connection
  community.aws.ec2_vpc_peer:
    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 VPC peering Connection
  community.aws.ec2_vpc_peer:
    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 VPC peering Connection
  community.aws.ec2_vpc_peer:
    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 peering connection from remote account
  community.aws.ec2_vpc_peer:
    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 VPC peering Connection
  community.aws.ec2_vpc_peer:
    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 peering connection from peer region
  community.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 VPC peering Connection
  community.aws.ec2_vpc_peer:
    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 VPC peering Connection
  community.aws.ec2_vpc_peer:
    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 VPC peering Connection
  community.aws.ec2_vpc_peer:
    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 VPC peering connection request
  community.aws.ec2_vpc_peer:
    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 VPC peering Connection
  community.aws.ec2_vpc_peer:
    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 VPC peering Connection
  community.aws.ec2_vpc_peer:
    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 complex	Подробная информация о соединении VPC-пиринга, возвращаемая Boto3 (в формате snake_case). Возвращается: при успехе
accepter_vpc_info complex	Информация о VPC, принявшем соединение. Возвращается: при успехе
cidr_block string	Основной CIDR для VPC. Возвращается: когда соединение находится в принятом состоянии. Пример: `"10.10.10.0/23"`
cidr_block_set complex	Список всех 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"`
requester_vpc_info complex	Информация о VPC, запросившем соединение. Возвращается: при успехе
cidr_block string	Основной CIDR для VPC. Возвращается: когда соединение не находится в удалённом состоянии. Пример: `"10.10.10.0/23"`
cidr_block_set complex	Список всех CIDR для VPC. Возвращается: когда соединение не находится в удалённом состоянии.
cidr_block string	CIDR-блок, используемый VPC. Возвращается: при успехе Пример: `"10.10.10.0/23"`

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 peering. Возвращается: успех
allow_egress_from_local_vpc_to_remote_classic_link логическое	Указывает, может ли локальная VPC взаимодействовать с соединением ClassicLink в удалённой VPC через соединение VPC peering. Возвращается: успех
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 peering. Возвращается: успех Пример: `"pcx-0123456789abcdef0"`

Авторы

Mike Mochan (@mmochan)

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

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