Модуль amazon.aws.ec2_vpc_subnet — Управление подсетями в виртуальных частных облаках AWS
Примечание
Этот модуль является частью коллекции amazon.aws (версия 8.2.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install amazon.aws. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.
Для использования в плейбуке укажите: amazon.aws.ec2_vpc_subnet.
Добавлена в amazon.aws 1.0.0
Обзор
- Управление подсетями в виртуальных частных облаках 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 для получения дополнительной информации об access-токенах https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также могут быть использованы переменные среды Параметры aws_access_key и profile взаимоисключающие. Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для согласованности с AWS botocore SDK. Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды |
assign_instances_ipv6 логическое значение | Определяет, следует ли по умолчанию автоматически назначать IPv6-адрес экземплярам, запущенным в подсети. Если Варианты:
|
aws_ca_bundle путь | Расположение пакета сертификатов CA для проверки SSL-сертификатов. Также может быть использована переменная среды |
aws_config словарь | Словарь для изменения конфигурации botocore. Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
az строка | Зона доступности для подсети. Требуется, если установлено |
cidr строка / обязательно | Блок CIDR для подсети. Например, |
debug_botocore_endpoint_logs логическое значение | Использовать логгер Также может быть использована переменная среды Варианты:
|
endpoint_url псевдонимы: ec2_url, aws_endpoint_url, s3_url строка | URL для подключения вместо стандартных AWS-endpoinтов. Хотя это можно использовать для подключения к другим совместимым с AWS службам, коллекции amazon.aws и community.aws протестированы только против AWS. Также могут быть использованы переменные среды Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01. Поддержка переменной среды |
ipv6_cidr строка | Блок IPv6 CIDR для подсети. В VPC должен быть назначен блок /56, а это значение должно быть корректным IPv6 /64, который входит в диапазон VPC. Требуется, если По умолчанию: |
map_public логическое значение | Определяет, следует ли по умолчанию назначать общедоступный IP-адрес экземплярам, запущенным в подсети. Варианты:
|
outpost_arn строка | Amazon Resource Name (ARN) Outpost. Если установлено, позволяет создавать подсети в Outpost. Если По умолчанию: |
profile псевдонимы: aws_profile строка | Используемый именованный профиль AWS для аутентификации. См. документацию AWS для получения дополнительной информации об именованных профилях https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также может быть использована переменная среды Параметр profile взаимоисключающий с параметрами aws_access_key, aws_secret_key и security_token. |
purge_tags логическое значение | Если purge_tags=true и tags задано, существующие теги ресурса будут очищены, чтобы точно соответствовать тому, что определено параметром tags. Если параметр tags не задан, теги не будут изменены, даже если purge_tags=True. Ключи тегов, начинающиеся с Варианты:
|
region aliases: aws_region, ec2_region string | Регион AWS для использования. Для глобальных служб, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Переменные окружения См. документацию Amazon AWS для получения дополнительной информации http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. Псевдоним Поддержка переменной окружения |
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. Переменные окружения Параметры secret_key и profile являются взаимоисключающими. Псевдоним aws_secret_access_key был добавлен в релизе 5.1.0 для согласованности с AWS botocore SDK. Псевдоним 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. Переменные окружения Параметры 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. Поддержка переменных окружения |
state string | Создать или удалить подсеть. Варианты:
|
tags aliases: resource_tags dictionary | Словарь, представляющий теги, которые будут применены к ресурсу. Если параметр tags не задан, теги не будут изменены. |
validate_certs boolean | Когда установлено значение Установка validate_certs=false настоятельно не рекомендуется, в качестве альтернативы рассмотрите возможность установки aws_ca_bundle. Варианты:
|
vpc_id string / required | -“ID VPC, в котором нужно создать или удалить подсеть. |
wait boolean | Нужно ли ждать завершения изменений. Варианты:
|
wait_timeout integer |
Примечания
Примечание
- Внимание: Для модулей переменные среды и конфигурационные файлы считываются из контекста Ansible «хост», а не из контекста «контроллер». Таким образом, файлы могут нуждаться в явном копировании на «хост». Для плагинов поиска и подключения переменные среды и конфигурационные файлы считываются из контекста Ansible «контроллер», а не из контекста «хост».
- SDK AWS (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 subnet for database servers
amazon.aws.ec2_vpc_subnet:
state: present
vpc_id: vpc-123456
cidr: 10.0.1.16/28
tags:
Name: Database Subnet
register: database_subnet
- name: Remove subnet for database servers
amazon.aws.ec2_vpc_subnet:
state: absent
vpc_id: vpc-123456
cidr: 10.0.1.16/28
- name: Create subnet with IPv6 block assigned
amazon.aws.ec2_vpc_subnet:
state: present
vpc_id: vpc-123456
cidr: 10.1.100.0/24
ipv6_cidr: 2001:db8:0:102::/64
- name: Remove IPv6 block assigned to subnet
amazon.aws.ec2_vpc_subnet:
state: present
vpc_id: vpc-123456
cidr: 10.1.100.0/24
ipv6_cidr: ''
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
subnet complex | Словарь значений подсети. Возвращается: |
|
assign_ipv6_address_on_creation boolean |
Признак автоматического присвоения IPv6-адреса новым экземплярам. Возвращается: Пример: |
|
availability_zone string | |
|
availability_zone_id string | |
|
available_ip_address_count string | |
|
cidr_block string | |
|
default_for_az boolean |
Указывает, является ли эта подсеть подсеткой по умолчанию для данной зоны доступности. Возвращается: Пример: |
|
enable_dns64 boolean |
Указывает, должны ли DNS-запросы возвращать синтетические IPv6-адреса для назначений только IPv4. Возвращается: success Пример: |
|
id string | |
|
ipv6_association_id string |
Идентификатор ассоциации IPv6 для текущего связанного CIDR. Возвращается: Пример: |
|
ipv6_cidr_block string |
Активно связанный с подсетью блок IPv6 CIDR. Возвращается: Пример: |
|
ipv6_cidr_block_association_set complex |
Массив информации о наборе ассоциаций блоков IPv6 cidr. Возвращается: |
|
association_id string |
Идентификатор ассоциации. Возвращается: всегда |
|
ipv6_cidr_block string |
Блок IPv6 CIDR, связанный с подсетью. Возвращается: всегда |
|
ipv6_cidr_block_state dictionary |
Хэш/словарь, содержащий один элемент. Состояние ассоциации блока cidr. Возвращается: всегда |
|
state string |
Состояние ассоциации блока CIDR. Возвращается: всегда |
|
ipv6_native boolean |
Указывает, является ли это подсетью только IPv6. Возвращается: success Пример: |
|
map_customer_owned_ip_on_launch boolean |
Указывает, получает ли сетевой интерфейс принадлежащий клиенту IPv4-адрес. Возвращается: success Пример: |
|
map_public_ip_on_launch boolean |
Автоматическое назначение публичного IP-адреса новым экземплярам. Возвращаемое значение: Пример: |
|
owner_id string |
Идентификатор учётной записи Amazon Web Services, владеющей подсетью. Возвращаемое значение: success Пример: |
|
private_dns_name_options_on_launch dictionary |
Тип имён хостов, назначаемых экземплярам в подсети при запуске. Имя хоста экземпляра основано на IPv4-адресе или идентификаторе экземпляра. Возвращаемое значение: success Пример: |
|
state string | |
|
subnet_arn string |
Amazon Resource Name (ARN) подсети. Возвращаемое значение: success Пример: |
|
tags dictionary |
Теги, прикреплённые к подсети, включая имя. Возвращаемое значение: Пример: |
|
vpc_id string |
Идентификатор VPC, в котором существует эта подсеть. Возвращаемое значение: Пример: |
Ссылки на коллекцию
© 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_subnet_module.html