community.aws.autoscaling_instance_refresh_info модуль — Сбор информации об обновлениях экземпляров группы автоматического масштабирования EC2 (ASG) в AWS
Примечание
Этот модуль входит в коллекцию community.aws (версия 8.0.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.aws. Вам потребуются дополнительные зависимости для использования этого модуля, см. Требования для получения подробной информации.
Для использования в плейбуке укажите: community.aws.autoscaling_instance_refresh_info.
Новая в community.aws 3.2.0
Обзор
- Описывает одно или несколько обновлений экземпляров.
- Вы можете определить состояние запроса, посмотрев параметр status.
- До версии 5.0.0 этот модуль назывался
community.aws.ec2_asg_instance_refresh_info. Способ использования не изменился.
Псевдонимы: ec2_asg_instance_refresh_info
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 3.6
- boto3 >= 1.26.0
- botocore >= 1.29.0
Параметры
Параметр | Комментарии |
|---|---|
access_key aliases: aws_access_key_id, aws_access_key, ec2_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. Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды |
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 aliases: ec2_url, aws_endpoint_url, s3_url string | URL для подключения вместо стандартных конечных точек AWS. Хотя это может использоваться для подключения к другим совместимым с AWS сервисам, коллекции amazon.aws и community.aws тестируются только с AWS. Переменные среды Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01. Поддержка переменной среды |
ids list / elements=string | Один или несколько идентификаторов обновления экземпляров. По умолчанию: |
max_records integer | Максимальное количество элементов, которые будут возвращены этим вызовом. Значение по умолчанию равно 50, а максимальное значение равно 100. |
name string / required | Имя группы автомасштабирования. |
next_token string | Токен для следующего набора элементов, которые нужно вернуть. (Вы получили этот токен от предыдущего вызова). |
profile aliases: aws_profile string | Именованный профиль AWS для использования для аутентификации. См. документацию AWS для получения дополнительной информации об именованных профилях https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Переменная среды Параметр profile является взаимоисключающим с параметрами aws_access_key, aws_secret_key и security_token. |
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. Поддержка переменных среды |
validate_certs boolean | При установке в Настройка validate_certs=false категорически не рекомендуется. В качестве альтернативы, рассмотрите настройку aws_ca_bundle вместо этого. Возможные значения:
|
Примечания
Примечание
- Внимание: Для модулей переменные среды и конфигурационные файлы читаются из контекста хоста 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: Find an refresh by ASG name
community.aws.autoscaling_instance_refresh_info:
name: somename-asg
- name: Find an refresh by ASG name and one or more refresh-IDs
community.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
community.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
community.aws.autoscaling_instance_refresh_info:
name: somename-asg
next_token: 'some-token-123'
register: asgs
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
auto_scaling_group_name string | Имя группы автоматического масштабирования Возвращается: success Пример: |
end_time string | Дата и время создания этой группы ASG в формате ISO 8601. Возвращается: success Пример: |
instance_refresh_id string | Идентификатор обновления экземпляров Возвращается: success Пример: |
instances_to_update integer | Количество экземпляров для обновления Возвращается: success Пример: |
percentage_complete integer | Процент завершения Возвращается: success Пример: |
start_time string | Дата и время создания этой группы ASG в формате ISO 8601. Возвращается: success Пример: |
status string | Текущее состояние группы во время выполнения операции DeleteAutoScalingGroup. Возможные состояния:
Возвращается: success Пример: |
Ссылки на коллекцию
© 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/community/aws/autoscaling_instance_refresh_info_module.html
