Модуль amazon.aws.ec2_dedicated_host — создание, обновление или удаление (освобождение) выделенного хоста EC2
Примечание
Этот модуль входит в коллекцию amazon.aws (версия 11.3.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install amazon.aws. Для работы с этим модулем требуются дополнительные зависимости; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: amazon.aws.ec2_dedicated_host.
Добавлено в amazon.aws 9.3.0
Краткое описание
- Создание, обновление или удаление (освобождение) выделенного хоста EC2.
Требования
Следующие требования необходимы на узле, который выполняет этот модуль.
- 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 и profile являются взаимоисключающими. Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для соответствия AWS botocore SDK. |
asset_ids list / элементы=string | Идентификаторы аппаратных ресурсов Outpost, на которых следует разместить выделенные хосты. Выбор конкретных аппаратных ресурсов Outpost может помочь свести к минимуму задержку между рабочими нагрузками. Этот параметр поддерживается только при указании При указании этого параметра Если указаны и |
auto_placement string | Указывает, принимает ли хост запуск любых нетаргетированных экземпляров, соответствующих его конфигурации типа экземпляра, или принимает только запуски экземпляров с арендой Host, в которых указан уникальный идентификатор хоста. Варианты:
|
availability_zone string | Зона доступности, в которой следует разместить выделенный хост. Обязателен, если указано |
aws_ca_bundle path | Путь к пакету сертификатов центра сертификации, используемому при проверке сертификатов SSL. Также можно использовать переменную среды |
aws_config dictionary | Словарь для изменения конфигурации botocore. Параметры описаны в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
client_token string | Идентификатор с учетом регистра, предоставляемый вами для обеспечения идемпотентности запроса. |
debug_botocore_endpoint_logs boolean | Используйте регистратор Также можно использовать переменную среды Варианты:
|
endpoint_url псевдонимы: aws_endpoint_url string | URL для подключения вместо конечных точек AWS по умолчанию. Хотя этот параметр можно использовать для подключения к другим службам, совместимым с AWS, коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную среды |
host_id string | Идентификаторы выделенных хостов для освобождения или изменения. |
host_maintenance string | Указывает, следует ли включить или отключить обслуживание выделенного хоста. Варианты:
|
host_recovery string | Указывает, следует ли включить или отключить восстановление выделенного хоста. По умолчанию восстановление хоста отключено. Варианты:
|
instance_family string | Указывает семейство экземпляров, которое будет поддерживаться выделенными хостами. Если указать семейство экземпляров, выделенные хосты будут поддерживать несколько типов экземпляров из этого семейства. При размещении выделенного хоста необходимо указать как минимум один из параметров Несовместим с параметром |
instance_type string | Указывает тип экземпляра, который будет поддерживаться выделенными хостами. Если указать тип экземпляра, выделенные хосты будут поддерживать только экземпляры указанного типа. При размещении выделенного хоста необходимо указать как минимум один из параметров Несовместим с параметром |
lookup string | Поиск выделенного хоста EC2 по Если При использовании Чтобы изменить теги выделенного хоста, используйте Варианты:
|
outpost_arn string | Имя ресурса Amazon (ARN) Outpost Amazon Web Services, на котором следует разместить выделенный хост. |
profile псевдонимы: aws_profile string | Именованный профиль AWS, используемый для аутентификации. Дополнительные сведения об именованных профилях см. в документации AWS: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также можно использовать переменную среды Параметр profile взаимоисключающий с параметрами aws_access_key, aws_secret_key и session_token. |
purge_tags boolean | Если указано Если параметр Ключи тегов, начинающиеся с Варианты:
|
quantity integer | Количество выделенных хостов, размещаемых в вашей учетной записи с указанными параметрами. Обязателен, если указано Если выделенные хосты размещаются на Outpost и указан параметр Если указаны и |
region псевдонимы: aws_region string | Регион AWS, который следует использовать. Для глобальных служб, таких как IAM, Route53 и CloudFront, параметр 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. Также можно использовать переменные среды Параметры 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. Также можно использовать переменную среды Параметры session_token и profile являются взаимоисключающими. |
state string | Создать или удалить выделенный хост. Варианты:
|
tags псевдонимы: resource_tags dictionary | Словарь с тегами, применяемыми к ресурсу. Если параметр |
validate_certs boolean | Если задано значение Настоятельно не рекомендуется задавать validate_certs=false; вместо этого рассмотрите возможность указать aws_ca_bundle. Варианты:
|
Примечания
Примечание
- Внимание: Для модулей переменные среды и файлы конфигурации считываются из контекста «узла» Ansible, а не из контекста «контроллера». Поэтому файлы может потребоваться явно скопировать на «узел». Для плагинов поиска и подключения переменные среды и файлы конфигурации считываются из контекста «контроллера» Ansible, а не из контекста «узла».
- Используемый Ansible SDK AWS (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.
# Release dedicated hosts
- name: Release dedicated host
amazon.aws.ec2_dedicated_host:
host_id: "h-0123456789abcdef0"
# Allocate dedicated host using instance type
- name: Allocate dedicated host using instance_type
amazon.aws.ec2_dedicated_host:
availability_zone: us-east-1a
quantity: 1
instance_type: mac2.metal
tags:
Scope: Mac
Возвращаемые значения
Общие возвращаемые значения описаны здесь, ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
host complex | Информация о созданном или обновлённом выделенном хосте. Возвращается: когда |
|
allocation_time string |
Время выделения выделенного хоста. Возвращается: всегда Пример: |
|
allows_multiple_instance_types string |
Указывает, поддерживает ли выделенный хост несколько типов экземпляров одного семейства экземпляров. Возвращается: всегда Пример: |
|
asset_id string |
Идентификатор аппаратного ресурса Outpost, на котором выделен выделенный хост. Возвращается: всегда Пример: |
|
auto_placement string |
Включено или отключено автоматическое размещение. Возвращается: всегда Пример: |
|
availability_zone string |
Зона доступности выделенного хоста. Возвращается: всегда Пример: |
|
availability_zone_id string |
Идентификатор зоны доступности, в которой выделен выделенный хост. Возвращается: всегда Пример: |
|
available_capacity dictionary |
Информация об экземплярах, работающих на выделенном хосте. Возвращается: всегда |
|
available_instance_capacity complex |
Количество экземпляров, которые можно запустить на выделенном хосте. Возвращается: всегда |
|
available_capacity integer |
Количество экземпляров, которые можно запустить на выделенном хосте. Возвращается: всегда Пример: |
|
instance_type string |
Тип экземпляра, поддерживаемый выделенным хостом. Возвращается: всегда Пример: |
|
total_capacity dictionary |
Общее количество экземпляров, которые можно запустить на выделенном хосте, если на нём не запущено ни одного экземпляра. Возвращается: всегда Пример: |
|
available_v_cpus integer |
Количество виртуальных ЦП, доступных для запуска экземпляров на выделенном хосте. Возвращается: всегда Пример: |
|
client_token string |
Уникальный идентификатор с учётом регистра, который вы указываете для обеспечения идемпотентности запроса. Возвращается: всегда Пример: |
|
host_id string |
Идентификатор выделенного хоста. Возвращается: всегда Пример: |
|
host_maintenance string |
Указывает, включено или отключено обслуживание хоста для выделенного хоста. Возвращается: всегда Пример: |
|
host_properties dictionary |
Аппаратные характеристики выделенного хоста. Возвращается: всегда |
|
cores integer |
Количество ядер на выделенном хосте. Возвращается: всегда Пример: |
|
instance_family string |
Семейство экземпляров, поддерживаемое выделенным хостом. Возвращается: если определено Пример: |
|
instance_type string |
Тип экземпляра, поддерживаемый выделенным хостом. Возвращается: всегда Пример: |
|
sockets integer |
Количество сокетов на выделенном хосте. Возвращается: всегда Пример: |
|
total_v_cpus integer |
Общее количество виртуальных ЦП на выделенном хосте. Возвращается: всегда Пример: |
|
host_recovery string |
Указывает, включено или отключено восстановление хоста для выделенного хоста. Возвращается: всегда Пример: |
|
host_reservation_id string |
Идентификатор резервирования выделенного хоста. Возвращается: всегда |
|
instances complex |
Идентификаторы и типы экземпляров, которые сейчас работают на выделенном хосте. Возвращается: всегда |
|
instance_id string |
Идентификатор экземпляра, работающего на выделенном хосте. Возвращается: всегда Пример: |
|
instance_type string |
Тип работающего экземпляра. Возвращается: всегда Пример: |
|
owner_id string |
Идентификатор аккаунта Amazon Web Services, которому принадлежит экземпляр. Возвращается: всегда Пример: |
|
member_of_service_linked_resource_group boolean |
Указывает, входит ли выделенный хост в группу ресурсов хостов. Возвращается: всегда Пример: |
|
outpost_arn string |
Amazon Resource Name (ARN) Amazon Web Services Outpost, на котором выделен выделенный хост. Возвращается: всегда Пример: |
|
owner_id string |
Идентификатор аккаунта Amazon Web Services, которому принадлежит выделенный хост. Возвращается: всегда Пример: |
|
release_time string |
Время освобождения выделенного хоста. Возвращается: всегда Пример: |
|
state string |
Состояние выделенного хоста. Возвращается: всегда Пример: |
|
tags dictionary |
Словарь тегов, добавленных к выделенному хосту. Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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_dedicated_host_module.html