Spec-Zone.ru › Ansible

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

Примечание

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

У вас, возможно, эта коллекция уже установлена, если вы используете пакет 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.26.0
  • botocore >= 1.29.0
END_OF_DOCUMENT_MARKER

Параметры

Параметр

Комментарии

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 для согласованности с AWS botocore SDK.

Псевдоним 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.

cidr_block

список / элементы=строка

Основной CIDR VPC.

Первый в списке будет использован как основной CIDR и используется совместно с name, чтобы обеспечить идемпотентность.

Обязательно, когда vpc_id не задан.
...
END_OF_DOCUMENT_MARKER

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

aliases: aws_region, ec2_region

string

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

Состояние VPC. Либо отсутствует, либо присутствует.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

tags

aliases: resource_tags

dictionary

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

Если параметр tags не задан, метки не будут изменены.

tenancy

string

Тип аренды: default или dedicated.

Это значение нельзя изменить после создания VPC.

Варианты:

  • "default" ← (по умолчанию)
  • "dedicated"

validate_certs

boolean

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

Установка validate_certs=false крайне не рекомендуется. В качестве альтернативы, можно установить aws_ca_bundle.

Варианты:

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

vpc_id

string

added in amazon.aws 4.0.0

ID VPC.

Необходимо указать хотя бы один из name и vpc_id.

Необходимо указать хотя бы один из name и cidr_block.

Примечания

Примечание

  • Внимание: Для модулей переменные окружения и конфигурационные файлы считываются из контекста Ansible «хоста», а не «контроллера». Поэтому файлы, возможно, нужно явно скопировать на «хост». Для плагинов поиска и подключения переменные окружения и конфигурационные файлы считываются из контекста Ansible «контроллера», а не «хоста».
  • AWS SDK (boto3), используемый Ansible, может также считывать значения по умолчанию для учетных данных и других настроек, таких как регион, из своих конфигурационных файлов в контексте 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.

Возвращается: всегда

Пример: false

name

строка

добавлен в amazon.aws 4.0.0

Тег Имя VPC.

Возвращается: Когда тег Имя был задан на VPC

Пример: "MyVPC"

owner_id

строка

AWS-аккаунт, которому принадлежит VPC.

Возвращается: всегда

Пример: "123456789012"

state

строка

Состояние VPC.

Возвращается: всегда

Пример: "available"

tags

сложный

Прикрепленные к VPC теги, включая имя.

Возвращается: всегда

Name

строка

Тег Имя для VPC.

Возвращается: всегда

Пример: "pk_vpc4"

Авторы

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

Ссылки на сборки

  • Система отслеживания ошибок
  • Репозиторий (источники)
  • Связь

© 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/amazon/aws/ec2_vpc_net_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API