Модуль amazon.aws.autoscaling_group_info — сбор информации о группах автоматического масштабирования EC2 (ASG) в AWS
Примечание
Этот модуль входит в коллекцию amazon.aws (версия 11.3.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install amazon.aws. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать его в плейбуке, укажите: amazon.aws.autoscaling_group_info.
Добавлено в amazon.aws 5.0.0
Краткое описание
- Сбор информации о группах автоматического масштабирования EC2 (ASG) в AWS.
- До выпуска 5.0.0 этот модуль назывался community.aws.ec2_asg_info. Способ использования не изменился.
- Этот модуль впервые появился в
community.awsв выпуске 1.0.0.
Псевдонимы: ec2_asg_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 | Путь к пакету сертификатов центра сертификации, используемому для проверки 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. Также можно использовать переменную окружения |
name псевдонимы: group_name 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. Дополнительные сведения о токенах доступа см. в документации 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 взаимоисключающие. |
tags dictionary | Словарь/хеш тегов в формате { tag1_name: ‘tag1_value’, tag2_name: ‘tag2_value’ } для поиска групп автоматического масштабирования. |
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 all groups
amazon.aws.autoscaling_group_info:
register: asgs
- name: Find a group with matching name/prefix
amazon.aws.autoscaling_group_info:
name: public-webserver-asg
register: asgs
- name: Find a group with matching tags
amazon.aws.autoscaling_group_info:
tags:
project: webapp
env: production
register: asgs
- name: Find a group with matching name/prefix and tags
amazon.aws.autoscaling_group_info:
name: myproject
tags:
env: production
register: asgs
- name: Fail if no groups are found
amazon.aws.autoscaling_group_info:
name: public-webserver-asg
register: asgs
failed_when: "{{ asgs.results | length == 0 }}"
- name: Fail if more than 1 group is found
amazon.aws.autoscaling_group_info:
name: public-webserver-asg
register: asgs
failed_when: "{{ asgs.results | length > 1 }}"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
results list / elements=dictionary | Список групп Auto Scaling. Возвращается: всегда |
|
auto_scaling_group_arn string |
Имя ресурса Amazon для ASG. Возвращается: при успехе Пример: |
|
auto_scaling_group_name string |
Имя группы автоматического масштабирования. Возвращается: при успехе Пример: |
|
availability_zones list / elements=string |
Список зон доступности, включённых для этой ASG. Возвращается: при успехе Пример: |
|
created_time string |
Дата и время создания этой ASG в формате ISO 8601. Возвращается: при успехе Пример: |
|
default_cooldown integer |
Время ожидания по умолчанию в секундах. Возвращается: при успехе Пример: |
|
desired_capacity integer |
Количество экземпляров EC2, которые должны работать в этой группе. Возвращается: при успехе Пример: |
|
enabled_metrics list / elements=dictionary |
Метрики, включённые для группы. Возвращается: при успехе Пример: |
|
granularity string |
Периодичность сбора метрики. Единственное допустимое значение — 1Minute. Возвращается: при успехе Пример: |
|
metric string |
Название метрики. Возвращается: при успехе Пример: |
|
health_check_grace_period integer |
Время в секундах после запуска нового экземпляра EC2, по истечении которого Auto Scaling начинает проверять его работоспособность. Возвращается: при успехе Пример: |
|
health_check_type string |
Служба, от которой требуется получить состояние работоспособности: «EC2» или «ELB». Возвращается: при успехе Пример: |
|
instances list / elements=dictionary |
Список экземпляров EC2, связанных с ASG, и их состояния. Возвращается: при успехе Пример: |
|
availability_zone string |
Зона доступности экземпляра. Возвращается: при успехе Пример: |
|
health_status string |
Последнее зарегистрированное состояние работоспособности экземпляра. Возвращается: при успехе Пример: |
|
instance_id string |
Идентификатор экземпляра. Возвращается: при успехе Пример: |
|
instance_type string |
Тип и размер работающего экземпляра. Возвращается: при успехе Пример: |
|
launch_template dictionary |
Шаблон запуска EC2, используемый в качестве основы для конфигурации экземпляра. Возвращается: при успехе |
|
launch_template_id string |
Идентификатор шаблона запуска. Возвращается: при успехе |
|
launch_template_name string |
Имя шаблона запуска. Возвращается: при успехе |
|
version integer |
Конкретная версия используемого шаблона запуска. Возвращается: при успехе |
|
lifecycle_state string |
Описание текущего состояния жизненного цикла. Возвращается: при успехе |
|
protected_from_scale_in boolean |
Указывает, защищён ли экземпляр от завершения службой Amazon EC2 Auto Scaling при уменьшении масштаба. Возвращается: при успехе |
|
launch_config_name string |
Имя конфигурации запуска, связанной с ASG. Совпадает с launch_configuration_name; поле предоставлено для совместимости с модулем amazon.aws.autoscaling_group. Возвращается: при успехе Пример: |
|
launch_configuration_name string |
Имя конфигурации запуска, связанной с ASG. Возвращается: при успехе Пример: |
|
lifecycle_hooks list / elements=string |
Список хуков жизненного цикла для ASG. Возвращается: при успехе Пример: |
|
load_balancer_names list / elements=string |
Список имён балансировщиков нагрузки, подключённых к ASG. Возвращается: при успехе Пример: |
|
max_size integer |
Максимальный размер группы. Возвращается: при успехе Пример: |
|
min_size integer |
Минимальный размер группы. Возвращается: при успехе Пример: |
|
new_instances_protected_from_scale_in boolean |
Указывает, защищены ли новые экземпляры от автоматического уменьшения масштаба. Возвращается: при успехе Пример: |
|
placement_group string |
Группа размещения, в которую запускаются экземпляры, если она задана. Возвращается: при успехе Пример: |
|
service_linked_role_arn string |
ARN связанной со службой роли, которую группа Auto Scaling использует для вызова других сервисов Amazon Web Services от вашего имени. Возвращается: при успехе Пример: |
|
status string |
Текущее состояние группы во время выполнения операции DeleteAutoScalingGroup. Возвращается: при успехе Пример: |
|
suspended_processes list / elements=dictionary |
Приостановленные процессы, связанные с группой. Возвращается: при успехе Пример: |
|
process_name string |
Имя приостановленного процесса. Возвращается: при успехе |
|
suspension_reason string |
Причина приостановки процесса. Возвращается: при успехе |
|
tags list / elements=string |
Список тегов ASG и указание, распространяется ли каждый тег на экземпляры при запуске. Возвращается: при успехе Пример: |
|
target_group_arns list / elements=string |
Список ARN целевых групп, которые заполняет ASG. Возвращается: при успехе Пример: |
|
target_group_names list / elements=string |
Список имён целевых групп, которые заполняет ASG. Возвращается: при успехе Пример: |
|
termination_policies list / elements=string |
Список политик завершения для группы. Возвращается: при успехе Пример: |
|
traffic_sources list / elements=string |
Источники трафика, связанные с этой группой Auto Scaling. Возвращается: при успехе Пример: |
|
identifier string |
Идентификатор источника трафика. Возвращается: при успехе |
|
type string |
Предоставляет дополнительный контекст для значения Identifier. Возвращается: при успехе |
|
vpc_zone_identifier 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_group_info_module.html