Модуль amazon.aws.ec2_vpc_net — настройка виртуальных частных облаков AWS

Примечание

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

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

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

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

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

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Создание, изменение и удаление виртуальных частных облаков AWS (VPC).

Требования

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

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

Параметры

Параметр	Комментарии
access_key псевдонимы: aws_access_key_id, aws_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` (в порядке убывания приоритета). Параметры aws_access_key и profile являются взаимоисключающими. Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для единообразия с SDK AWS botocore.
aws_ca_bundle путь	Путь к пакету сертификатов центра сертификации, используемому для проверки SSL-сертификатов. Также можно использовать переменную среды `AWS_CA_BUNDLE`.
aws_config словарь	Словарь для изменения конфигурации botocore. Параметры описаны в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
cidr_block список / элементы=строка	Основной CIDR VPC. Первый элемент списка будет использоваться как основной CIDR и совместно с `name` обеспечит идемпотентность. Обязателен, если не задан `vpc_id`.
debug_botocore_endpoint_logs логическое значение	Использовать регистратор `botocore.endpoint` для анализа уникальных (а не всех) вызовов API `"resource:action"`, выполненных во время задачи, и выводить их набор в ключ resource_actions результатов задачи. Используйте обработчик обратного вызова `aws_resource_action`, чтобы вывести общий список вызовов, выполненных в ходе плейбука. Также можно использовать переменную среды `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
dhcp_opts_id строка	Идентификатор параметров DHCP, используемых для этого VPC.
dns_hostnames логическое значение	Включить ли поддержку имен хостов AWS. При создании нового VPC значение по умолчанию — `true`. Варианты: `false` `true`
dns_support логическое значение	Включить ли поддержку DNS AWS. При создании нового VPC значение по умолчанию — `true`. Варианты: `false` `true`
endpoint_url псевдонимы: aws_endpoint_url строка	URL для подключения вместо конечных точек AWS по умолчанию. Хотя его можно использовать для подключения к другим совместимым с AWS сервисам, коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную среды `AWS_URL`.
ipv6_cidr логическое значение	Запросить предоставляемый Amazon блок IPv6 CIDR с длиной префикса /56. Указать диапазон IPv6-адресов или размер блока CIDR нельзя. При создании нового VPC значение по умолчанию — `false`. Варианты: `false` `true`
multi_ok логическое значение	По умолчанию модуль не создаст еще один VPC, если уже существует VPC с тем же именем и блоком CIDR. Укажите `multi_ok=true`, если нужно создать дубликаты VPC. Варианты: `false` ← (по умолчанию) `true`
name строка	Имя VPC. Используется совместно с `cidr_block` для определения того, существует ли VPC. Значение `name` имеет приоритет над любым значением, заданным для `Name` в параметре `tags`. Необходимо указать хотя бы один из параметров `name` и `vpc_id`. При создании нового VPC необходимо указать `name`.
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 и session_token.
purge_cidrs логическое значение	Удалять CIDR, связанные с VPC, но не указанные в `cidr_block`. Варианты: `false` ← (по умолчанию) `true`
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 строка	Используемый регион 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 строка	Секретный ключ доступа 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 для единообразия с SDK AWS botocore.
session_token псевдонимы: aws_session_token строка	Токен сеанса 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 строка	Состояние VPC: absent или present. Варианты: `"present"` ← (по умолчанию) `"absent"`
tags псевдонимы: resource_tags словарь	Словарь тегов, применяемых к ресурсу. Если параметр `tags` не задан, теги не будут изменены.
tenancy строка	Использовать `default` или `dedicated` тип размещения. Это значение нельзя изменить после создания VPC. Варианты: `"default"` ← (по умолчанию) `"dedicated"`
validate_certs логическое значение	Если задано `false`, SSL-сертификаты при обмене данными с API AWS проверяться не будут. Настоятельно не рекомендуется задавать validate_certs=false; вместо этого рассмотрите возможность указать aws_ca_bundle. Варианты: `false` `true` ← (по умолчанию)
vpc_id строка добавлено в amazon.aws 4.0.0	Идентификатор VPC. Необходимо указать хотя бы один из параметров `name` и `vpc_id`. Необходимо указать хотя бы один из параметров `name` и `cidr_block`.

Примечания

Примечание

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

Примеры

# Note: These examples do not set authentication details, see the AWS Guide for details.

- name: create a VPC with dedicated tenancy and a couple of tags
  amazon.aws.ec2_vpc_net:
    name: Module_dev2
    cidr_block: 10.10.0.0/16
    region: us-east-1
    tags:
      module: ec2_vpc_net
      this: works
    tenancy: dedicated

- name: create a VPC with dedicated tenancy and request an IPv6 CIDR
  amazon.aws.ec2_vpc_net:
    name: Module_dev2
    cidr_block: 10.10.0.0/16
    ipv6_cidr: true
    region: us-east-1
    tenancy: dedicated

- name: Delete an existing VPC
  amazon.aws.ec2_vpc_net:
    vpc_id: vpc-0123456789abcdef0
    state: absent

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

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

Ключ	Описание
vpc сложный тип	Информация о созданном или удаленном VPC. Возвращается: всегда
cidr_block строка	CIDR VPC. Возвращается: всегда Пример: `"10.0.0.0/16"`
cidr_block_association_set список / элементы=строка	Блоки IPv4 CIDR, связанные с VPC. Возвращается: при успешном выполнении Пример: `{"cidr_block_association_set": [{"association_id": "vpc-cidr-assoc-97aeeefd", "cidr_block": "10.0.0.0/24", "cidr_block_state": {"state": "associated"}}]}`
dhcp_options_id строка	Идентификатор параметров DHCP, связанных с этим VPC. Возвращается: всегда Пример: `"dopt-12345678"`
id строка	Идентификатор ресурса VPC. Возвращается: всегда Пример: `"vpc-12345678"`
instance_tenancy строка	Указывает, использует ли VPC тип размещения по умолчанию или выделенный тип размещения. Возвращается: всегда Пример: `"default"`
ipv6_cidr_block_association_set список / элементы=строка	Блоки IPv6 CIDR, связанные с VPC. Возвращается: при успешном выполнении Пример: `{"ipv6_cidr_block_association_set": [{"association_id": "vpc-cidr-assoc-97aeeefd", "ipv6_cidr_block": "2001:db8::/56", "ipv6_cidr_block_state": {"state": "associated"}}]}`
is_default логическое значение	Указывает, является ли этот VPC VPC по умолчанию. Возвращается: всегда Пример: `false`
name строка добавлено в amazon.aws 4.0.0	Тег Name для VPC. Возвращается: если для VPC задан тег Name Пример: `"MyVPC"`
owner_id строка	Учетная запись AWS, которой принадлежит VPC. Возвращается: всегда Пример: `"123456789012"`
state строка	Состояние VPC. Возвращается: всегда Пример: `"available"`
tags сложный тип	Теги VPC, включая имя. Возвращается: всегда
Name строка	Тег Name для VPC. Возвращается: всегда Пример: `"pk_vpc4"`

Авторы

Jonathan Davila (@defionscode)
Sloane Hertel (@s-hertel)

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

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