Модуль amazon.aws.autoscaling_instance_info — описание экземпляров, связанных с группами AWS Auto Scaling (ASG)
Примечание
Этот модуль входит в коллекцию amazon.aws (версия 11.3.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install amazon.aws. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: amazon.aws.autoscaling_instance_info.
Добавлено в amazon.aws 9.0.0
Краткое описание
- Описывает экземпляры, связанные с группами AWS Auto Scaling (ASG).
Требования
На хосте, выполняющем этот модуль, должны быть установлены следующие компоненты.
- 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 и profile являются взаимоисключающими. Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для единообразия с AWS botocore SDK. |
aws_ca_bundle путь | Путь к пакету сертификатов ЦС, используемому для проверки SSL-сертификатов. Также можно использовать переменную окружения |
aws_config словарь | Словарь для изменения конфигурации botocore. Параметры описаны в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
debug_botocore_endpoint_logs логическое значение | Использовать регистратор Также можно использовать переменную окружения Варианты:
|
endpoint_url псевдонимы: aws_endpoint_url строка | URL для подключения вместо конечных точек AWS по умолчанию. Его можно использовать для подключения к другим сервисам, совместимым с AWS, однако коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную окружения |
group_name строка | Имя управляемой группы Auto Scaling. Параметры |
instance_ids список / элементы=строка | Идентификаторы экземпляров EC2. Параметры |
profile псевдонимы: aws_profile строка | Именованный профиль AWS для аутентификации. Дополнительные сведения об именованных профилях см. в документации AWS: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также можно использовать переменную окружения Параметр profile является взаимоисключающим с параметрами aws_access_key, aws_secret_key и session_token. |
region псевдонимы: aws_region строка | Регион 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 строка | Секретный ключ доступа 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 строка | Токен сеанса 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 являются взаимоисключающими. |
validate_certs логическое значение | Если задано значение Настоятельно не рекомендуется устанавливать validate_certs=false; в качестве альтернативы используйте aws_ca_bundle. Варианты:
|
Примечания
Примечание
- Внимание: Для модулей переменные окружения и файлы конфигурации считываются из контекста «хоста» Ansible, а не из контекста «контроллера». Поэтому может потребоваться явно скопировать файлы на «хост». Для плагинов поиска и подключения переменные окружения и файлы конфигурации считываются из контекста «контроллера» Ansible, а не из контекста «хоста».
- Используемый Ansible пакет AWS SDK (boto3) также может считывать значения учётных данных и других параметров по умолчанию, например региона, из файлов конфигурации в контексте «хоста» Ansible (обычно
~/.aws/credentials). Дополнительные сведения см. здесь: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.
Примеры
- name: Describe all instances in a region
amazon.aws.autoscaling_instance_info:
register: instances
- name: Describe a specific instance
amazon.aws.autoscaling_instance_info:
instance_ids:
- "i-123456789abcdef01"
register: instances
- name: Describe the instances attached to a specific Auto Scaling Group
amazon.aws.autoscaling_instance_info:
group_name: example-asg
register: instances
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
auto_scaling_instances список / элементы=строка | Описание экземпляров EC2, подключённых к группе Auto Scaling. Возвращается: всегда |
|
availability_zone строка |
Зона доступности, в которой находится экземпляр. Возвращается: всегда Пример: |
|
health_status строка |
Последний зарегистрированный статус работоспособности экземпляра. Возвращается: всегда Пример: |
|
instance_id строка |
Идентификатор экземпляра. Возвращается: всегда Пример: |
|
instance_type строка |
Тип экземпляра. Возвращается: всегда Пример: |
|
launch_configuration_name строка |
Имя конфигурации запуска, использованной при запуске экземпляра. Возвращается: если экземпляр был запущен с использованием конфигурации запуска Auto Scaling. Пример: |
|
launch_template словарь |
Описание шаблона запуска, использованного при запуске экземпляра. Возвращается: если экземпляр был запущен с использованием шаблона запуска Auto Scaling. |
|
launch_template_id строка |
Идентификатор шаблона запуска, использованного при запуске экземпляра. Возвращается: всегда Пример: |
|
launch_template_name строка |
Имя шаблона запуска, использованного при запуске экземпляра. Возвращается: всегда Пример: |
|
version строка |
Версия шаблона запуска, использованного при запуске экземпляра. Возвращается: всегда Пример: |
|
lifecycle_state строка |
Состояние жизненного цикла экземпляра. Возвращается: всегда Пример: |
|
protected_from_scale_in логическое значение |
Защищён ли экземпляр от завершения при уменьшении размера группы Auto Scaling. Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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/autoscaling_instance_info_module.html