Модуль amazon.aws.autoscaling_group_info — Сбор информации о группах автоматического масштабирования EC2 (ASG) в AWS

Примечание

Этот модуль входит в состав коллекции amazon.aws (версия 8.2.1).

У вас, возможно, уже установлена эта коллекция, если вы используете пакет 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.26.0
botocore >= 1.29.0

Параметры

Параметр	Комментарии
access_key псевдонимы: aws_access_key_id, aws_access_key, ec2_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_ID`, `AWS_ACCESS_KEY` или `EC2_ACCESS_KEY` в порядке убывания приоритета. Опции aws_access_key и profile взаимоисключающие. Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore. Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной окружения `EC2_ACCESS_KEY` устарела и будет удалена в релизе после 2024-12-01.
aws_ca_bundle путь	Расположение файла с сертификатом CA для проверки SSL-сертификатов. Также может быть использована переменная окружения `AWS_CA_BUNDLE`.
aws_config словарь	Словарь для изменения конфигурации botocore. Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
debug_botocore_endpoint_logs логический	Используйте логгер `botocore.endpoint` для анализа уникальных (а не общих) `"resource:action"` вызовов API во время выполнения задачи, выводив набор в ключ resource_actions результатов задачи. Используйте обратный вызов `aws_resource_action` для вывода полного списка, выполненного во время выполнения книги задач. Также может быть использована переменная окружения `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
endpoint_url псевдонимы: ec2_url, aws_endpoint_url, s3_url строка	URL для подключения вместо стандартных конечных точек AWS. Хотя это можно использовать для подключения к другим совместимым с AWS службам, коллекции amazon.aws и community.aws протестированы только с AWS. Также могут быть использованы переменные окружения `AWS_URL` или `EC2_URL` в порядке убывания приоритета. Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01. Поддержка переменной окружения `EC2_URL` устарела и будет удалена в релизе после 2024-12-01.
name строка	Префикс или имя группы автоматического масштабирования, которую вы ищете. Примечание: это соответствует регулярному выражению с неявным соответствием ‘^’ (начало строки). Добавьте ‘$’ для полного соответствия имени.
profile псевдонимы: aws_profile строка	Используемый профиль AWS для аутентификации. Дополнительную информацию о именованных профилях см. в документации AWS https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также может быть использована переменная окружения `AWS_PROFILE`. Опция profile взаимоисключающая с опциями aws_access_key, aws_secret_key и security_token.
region псевдонимы: aws_region, ec2_region строка	Используемый регион AWS. Для глобальных служб, таких как IAM, Route53 и CloudFront, region игнорируется. Также могут быть использованы переменные окружения `AWS_REGION` или `EC2_REGION`. Дополнительную информацию см. в документации Amazon AWS http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. Псевдоним `ec2_region` устарел и будет удален в релизе после 2024-12-01. Поддержка переменной окружения `EC2_REGION` устарела и будет удалена в релизе после 2024-12-01.
secret_key псевдонимы: aws_secret_access_key, aws_secret_key, ec2_secret_key строка	Секретный ключ доступа AWS. Дополнительную информацию об маркерах доступа см. в документации AWS https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также могут быть использованы переменные окружения `AWS_SECRET_ACCESS_KEY`, `AWS_SECRET_KEY`, или `EC2_SECRET_KEY` в порядке убывания приоритета. Опции secret_key и profile взаимоисключающие. Псевдоним aws_secret_access_key был добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore. Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной окружения `EC2_SECRET_KEY` устарела и будет удалена в релизе после 2024-12-01.
session_token псевдонимы: aws_session_token, security_token, aws_security_token, access_token строка	Маркер сеанса AWS STS для использования с временными учетными данными. Дополнительную информацию об маркерах доступа см. в документации AWS https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также могут быть использованы переменные окружения `AWS_SESSION_TOKEN`, `AWS_SECURITY_TOKEN` или `EC2_SECURITY_TOKEN` в порядке убывания приоритета. Опции 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. Поддержка переменных окружения `EC2_SECRET_KEY` и `AWS_SECURITY_TOKEN` устарела и будет удалена в релизе после 2024-12-01.

END_OF_DOCUMENT_MARKER

Теги

словарь

Словарь тегов в формате { имя_тега1: ‘значение_тега1’, имя_тега2: ‘значение_тега2’ } для сопоставления с группой(ами) автоматического масштабирования, которые вы ищете.

validate_certs

логическое

При установке в false, сертификаты SSL не будут проверяться для связи с API AWS.

Устанавливать validate_certs=false крайне не рекомендуется; вместо этого рассмотрите возможность установки aws_ca_bundle.

Возможные значения:

false
true ← (по умолчанию)

Примечания

Примечание

Внимание: Для модулей переменные окружения и конфигурационные файлы считываются из контекста 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 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_group_arn string	Универсальное имя ресурса (ARN) группы автомасштабирования. Возвращается: успешно Пример: `"arn:aws:autoscaling:us-west-2:123456789012:autoScalingGroup:10787c52-0bcb-427d-82ba-c8e4b008ed2e:autoScalingGroupName/dev11"`
auto_scaling_group_name string	Имя группы автомасштабирования. Возвращается: успешно Пример: `"public-webapp-production-1"`
availability_zones list / elements=string	Список зон доступности, включенных для этой группы автомасштабирования. Возвращается: успешно Пример: `["us-west-2a", "us-west-2b", "us-west-2a"]`
created_time string	Дата и время создания этой группы автомасштабирования в формате ISO 8601. Возвращается: успешно Пример: `"2015-11-25T00:05:36.309Z"`
default_cooldown integer	Время ожидания по умолчанию в секундах. Возвращается: успешно Пример: `300`
desired_capacity integer	Количество экземпляров EC2, которые должны работать в этой группе. Возвращается: успешно Пример: `3`
enabled_metrics list / elements=dictionary	Метрики, включенные для группы. Возвращается: успешно Пример: `[{"granularity": "1Minute", "metric": "GroupAndWarmPoolTotalCapacity"}]`
granularity string	Гранулярность метрики. Единственное допустимое значение - 1Minute. Возвращается: успешно Пример: `"1Minute"`
metric string	Имя метрики. Возвращается: успешно Пример: `"GroupAndWarmPoolTotalCapacity"`
health_check_grace_period integer	Продолжительность в секундах после того, как новый экземпляр EC2 вступит в строй, когда Auto Scaling начнет проверять его работоспособность. Возвращается: успешно Пример: `300`
health_check_type string	Сервис, от которого вы хотите получить состояние работоспособности, один из «EC2» или «ELB». Возвращается: успешно Пример: `"ELB"`
instances list / elements=dictionary	Список экземпляров EC2, связанных с группой автомасштабирования, и их состояние. Возвращается: успешно Пример: `[{"availability_zone": "us-west-2a", "health_status": "Healthy", "instance_id": "i-es22ad25", "launch_configuration_name": "public-webapp-production-1", "launch_template": {"launch_template_id": "lt-0b19eb00123456789", "launch_template_name": "test-template", "version": "1"}, "lifecycle_state": "InService", "protected_from_scale_in": "false"}]`
availability_zone string	Зона доступности экземпляра. Возвращается: успешно Пример: `"ap-southeast-2a"`
health_status string	Последнее зарегистрированное состояние работоспособности экземпляра. Возвращается: успешно Пример: `"Healthy"`
instance_id string	Идентификатор экземпляра. Возвращается: успешно Пример: `"i-012345678"`

instance_type string	Размер типа экземпляра запущенного экземпляра. Возвращено: success Пример: `"t2.micro"`
launch_template dictionary	Шаблон запуска EC2 для конфигурации экземпляра. Возвращено: success
launch_template_id string	Идентификатор шаблона запуска. Возвращено: success
launch_template_name string	Имя шаблона запуска. Возвращено: success
version integer	Конкретная версия шаблона запуска для использования. Возвращено: success
lifecycle_state string	Описание текущего состояния жизненного цикла. Возвращено: success
protected_from_scale_in boolean	Указывает, защищен ли экземпляр от завершения работы службой Amazon EC2 Auto Scaling при уменьшении масштаба. Возвращено: success
launch_config_name string	Имя конфигурации запуска, связанной с ASG. То же самое, что и launch_configuration_name, предоставлено для совместимости с модулем amazon.aws.autoscaling_group. Возвращено: success Пример: `"public-webapp-production-1"`
launch_configuration_name string	Имя конфигурации запуска, связанной с ASG. Возвращено: success Пример: `"public-webapp-production-1"`
lifecycle_hooks list / elements=string	Список хуков жизненного цикла для ASG. Возвращено: success Пример: `[{"AutoScalingGroupName": "public-webapp-production-1", "DefaultResult": "ABANDON", "GlobalTimeout": 172800, "HeartbeatTimeout": 3600, "LifecycleHookName": "instance-launch", "LifecycleTransition": "autoscaling:EC2_INSTANCE_LAUNCHING"}, {"AutoScalingGroupName": "public-webapp-production-1", "DefaultResult": "ABANDON", "GlobalTimeout": 172800, "HeartbeatTimeout": 3600, "LifecycleHookName": "instance-terminate", "LifecycleTransition": "autoscaling:EC2_INSTANCE_TERMINATING"}]`
load_balancer_names list / elements=string	Список имен балансировщиков нагрузки, подключенных к ASG. Возвращено: success Пример: `["elb-webapp-prod"]`
max_size integer	Максимальный размер группы. Возвращено: success Пример: `3`
min_size integer	Минимальный размер группы. Возвращено: success Пример: `1`
new_instances_protected_from_scale_in boolean	Защищены ли новые экземпляры от автоматического уменьшения масштаба. Возвращено: success Пример: `false`
placement_group string	Группа размещения, в которую запускаются экземпляры, если таковая имеется. Возвращено: success Пример: `"None"`
service_linked_role_arn string	ARN связанной со службой роли, которую группа автомасштабирования использует для вызова других служб Amazon Web Services от вашего имени. Возвращено: success Пример: `"arn:aws:iam::721234567890:role/aws-service-role/autoscaling.amazonaws.com/AWSServiceRoleForAutoScaling"`
status string	Текущее состояние группы, когда DeleteAutoScalingGroup находится в процессе выполнения. Возвращено: success Пример: `"None"`

suspended_processes список / элементы=словарь	Приостановленные процессы, связанные с группой. Возвращаемое значение: успех Пример: `[{"process_name": "AddToLoadBalancer", "suspension_reason": "User suspended at 2018-08-30T14:11:58Z"}]`
process_name строка	Название приостановленного процесса. Возвращаемое значение: успех
suspension_reason строка	Причина приостановки процесса. Возвращаемое значение: успех
tags список / элементы=строка	Список тегов для ASG и информация о том, распространяются ли они на экземпляры при запуске. Возвращаемое значение: успех Пример: `[{"key": "Name", "propagate_at_launch": "true", "resource_id": "public-webapp-production-1", "resource_type": "auto-scaling-group", "value": "public-webapp-production-1"}, {"key": "env", "propagate_at_launch": "true", "resource_id": "public-webapp-production-1", "resource_type": "auto-scaling-group", "value": "production"}]`
target_group_arns список / элементы=строка	Список ARNs целевых групп, которые заполняет ASG. Возвращаемое значение: успех Пример: `["arn:aws:elasticloadbalancing:ap-southeast-2:123456789012:targetgroup/target-group-host-hello/1a2b3c4d5e6f1a2b", "arn:aws:elasticloadbalancing:ap-southeast-2:123456789012:targetgroup/target-group-path-world/abcd1234abcd1234"]`
target_group_names список / элементы=строка	Список имён целевых групп, которые заполняет ASG. Возвращаемое значение: успех Пример: `["target-group-host-hello", "target-group-path-world"]`
termination_policies список / элементы=строка	Список политик завершения для группы. Возвращаемое значение: успех Пример: `["Default"]`
traffic_sources список / элементы=строка	Источники трафика, связанные с этой группой Auto Scaling. Возвращаемое значение: успех Пример: `[{"identifier": "arn:aws:elasticloadbalancing:us-west-2:721234567890:targetgroup/Check-Exter-A4XXXXXXXXXX/8aXXXXXXXXXXXXXX", "type": "elbv2"}]`
identifier строка	Идентификатор источника трафика. Возвращаемое значение: успех
type строка	Предоставляет дополнительный контекст для значения Идентификатора. Возвращаемое значение: успех
vpc_zone_identifier строка	Один или несколько идентификаторов подсетей (если применимо), разделенных запятыми. Возвращаемое значение: успех Пример: `"subnet-0352db1247ae60b40,subnet-01f266bb9928ddaee"`

Авторы

Rob White (@wimnat)

Ссылки на коллекцию

© 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/amazon/aws/autoscaling_group_info_module.html