Модуль amazon.aws.autoscaling_instance_refresh_info — сбор информации об обновлениях экземпляров групп Auto Scaling (ASG) EC2 в AWS
Примечание
Этот модуль входит в коллекцию amazon.aws (версия 11.3.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install amazon.aws. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: amazon.aws.autoscaling_instance_refresh_info.
Добавлено в community.aws 3.2.0
Краткое описание
- Описывает одно или несколько обновлений экземпляров.
- Определить состояние запроса можно по возвращаемому значению
instance_refreshes.status. - До выпуска версии 5.0.0 этот модуль назывался community.aws.ec2_asg_instance_refresh_info. Способ использования не изменился.
Псевдонимы: ec2_asg_instance_refresh_info
Требования
На узле, который выполняет этот модуль, должны быть установлены следующие компоненты.
- 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 SDK botocore. |
aws_ca_bundle path | Путь к набору сертификатов CA, используемому для проверки SSL-сертификатов. Также можно использовать переменную среды |
aws_config dictionary | Словарь для изменения конфигурации botocore. Параметры описаны в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
debug_botocore_endpoint_logs boolean | Использовать регистратор Также можно использовать переменную среды Варианты:
|
endpoint_url псевдонимы: aws_endpoint_url string | URL для подключения вместо конечных точек AWS по умолчанию. Хотя этот параметр можно использовать для подключения к другим службам, совместимым с AWS, коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную среды |
ids list / элементы=string | Один или несколько идентификаторов обновлений экземпляров. По умолчанию: |
max_records integer | Максимальное число элементов, возвращаемых этим вызовом. Значение по умолчанию — |
name псевдонимы: group_name string / обязательный | Имя группы Auto Scaling. |
next_token string | Токен для получения следующего набора элементов. (Этот токен возвращается предыдущим вызовом.) |
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. |
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: 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 SDK botocore. |
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 являются взаимоисключающими. |
validate_certs boolean | Если задано значение Настоятельно не рекомендуется задавать 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.
Примеры
# Note: These examples do not set authentication details, see the AWS Guide for details.
- name: Find an refresh by ASG name
amazon.aws.autoscaling_instance_refresh_info:
name: somename-asg
- name: Find an refresh by ASG name and one or more refresh-IDs
amazon.aws.autoscaling_instance_refresh_info:
name: somename-asg
ids: ['some-id-123']
register: asgs
- name: Find an refresh by ASG name and set max_records
amazon.aws.autoscaling_instance_refresh_info:
name: somename-asg
max_records: 4
register: asgs
- name: Find an refresh by ASG name and NextToken, if received from a previous call
amazon.aws.autoscaling_instance_refresh_info:
name: somename-asg
next_token: 'some-token-123'
register: asgs
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
instance_refreshes complex | Список обновлений экземпляров. Возвращается: всегда |
|
auto_scaling_group_name string |
Имя группы Auto Scaling. Возвращается: при успехе Пример: |
|
end_time string |
Дата и время создания этой группы ASG в формате ISO 8601. Возвращается: при успехе Пример: |
|
instance_refresh_id string |
Идентификатор обновления экземпляров. Возвращается: при успехе Пример: |
|
instances_to_update integer |
Число экземпляров, подлежащих обновлению. Возвращается: при успехе Пример: |
|
percentage_complete integer |
Процент выполнения Возвращается: при успехе Пример: |
|
preferences dictionary |
Параметры обновления экземпляров. Возвращается: всегда Пример: |
|
start_time string |
Дата и время создания этой группы ASG в формате ISO 8601. Возвращается: при успехе Пример: |
|
status string |
Текущее состояние группы во время выполнения DeleteAutoScalingGroup. Возможны следующие состояния: Pending — запрос создан, но операция еще не началась. InProgress — операция выполняется. Successful — операция успешно завершена. Failed — не удалось завершить операцию. Для устранения неполадок используйте причину состояния и сведения об операциях масштабирования. Cancelling — выполняется отмена операции. Отмена не отменяет замену экземпляров, которая уже завершилась, но предотвращает начало новых замен. Cancelled — операция отменена. Возвращается: при успехе Пример: |
next_token string | Строка, указывающая, что ответ содержит больше элементов, чем можно вернуть за один раз. Возвращается: всегда |
Ссылки на коллекцию
© 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_refresh_info_module.html