Модуль amazon.aws.autoscaling_group – Создание или удаление групп Auto Scaling AWS (ASGs)

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_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.

availability_zones

list / elements=string

Список имен зон доступности, в которых будет создана группа.

По умолчанию используются все зоны доступности в регионе, если vpc_zone_identifier не установлен.

aws_ca_bundle

path

Расположение пакета CA, используемого при проверке сертификатов SSL.

Переменная среды AWS_CA_BUNDLE также может использоваться.

aws_config

dictionary

Словарь для изменения конфигурации botocore.

Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

debug_botocore_endpoint_logs

boolean

Использовать botocore.endpoint регистратор для анализа уникальных (а не общих) "resource:action" вызовов API, сделанных во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода в общий список, сделанный во время playbook.

Переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS также может использоваться.

Варианты:

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

decrement_desired_capacity

boolean

добавлено в community.aws 3.2.0

Указывает, уменьшает ли AutoScalingGroup значение желаемой емкости на количество отключенных экземпляров.

Варианты:

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

default_cooldown

integer

Количество секунд после завершения действия масштабирования, прежде чем можно будет начать другое.

По умолчанию: 300

desired_capacity

integer

Требуемое количество экземпляров в группе, если не указано, будет использоваться текущее значение группы.

detach_instances

list / elements=string

добавлено в community.aws 3.2.0

Удаляет один или несколько экземпляров из указанной группы AutoScalingGroup.

Если флаг decrement_desired_capacity не установлен, запускаются новые экземпляры для замены отсоединенных экземпляров.

Если к AutoScalingGroup подключен классический балансировщик нагрузки, экземпляры также отменяются с балансировщика нагрузки.

Если к AutoScalingGroup подключены целевые группы, экземпляры также отменяются с целевых групп.

По умолчанию: []

endpoint_url

aliases: ec2_url, aws_endpoint_url, s3_url

string

URL для подключения вместо стандартных конечных точек AWS. Хотя это можно использовать для подключения к другим совместимым с AWS службам, коллекции amazon.aws и community.aws тестируются только с AWS.

Переменные среды AWS_URL или EC2_URL также могут использоваться в порядке убывания предпочтения.

Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01.

Поддержка переменной среды EC2_URL устарела и будет удалена в релизе после 2024-12-01.

health_check_period

integer

Продолжительность в секундах после того, как новый экземпляр EC2 вступает в строй, Auto Scaling начинает проверять его работоспособность.

По умолчанию: 300

health_check_type

string

Сервис, от которого вы хотите получить состояние работоспособности, Amazon EC2 или Elastic Load Balancer.

Варианты:

• "EC2" ← (по умолчанию)
• "ELB"

launch_config_name

string

Имя конфигурации запуска, используемой для группы. См. модуль community.aws.autoscaling_launch_config для управления ими.

Если не указано, будет использоваться текущее значение группы. Необходимо указать один из параметров launch_config_name или launch_template.

launch_template

dictionary

Словарь, описывающий используемый шаблон запуска

launch_template_id

string

Идентификатор шаблона запуска. Необходимо указать только один из параметров launch_template.launch_template_name или launch_template.launch_template_id.

launch_template_name

string

Имя шаблона запуска. Требуется только одно из launch_template.launch_template_name или launch_template.launch_template_id.

version

string

Номер версии шаблона запуска для использования.

По умолчанию используется последняя версия, если не указано иначе.

lc_check

boolean

Проверка, чтобы экземпляры, которые заменяются с помощью replace_instances, не имели текущей конфигурации запуска.

Варианты:

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

load_balancers

list / elements=string

Список имен ELB для использования в группе. Используется для классических балансировщиков нагрузки.

lt_check

boolean

Проверка, чтобы экземпляры, которые заменяются с помощью replace_instances, не имели текущего launch_template или launch_template launch_template.version.

Варианты:

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

max_instance_lifetime

integer

Максимальное время (в секундах), в течение которого экземпляр может находиться в службе.

Максимальное время жизни экземпляра должно быть равно 0, между 604800 и 31536000 секундами (включительно) или не определено.

Значение 0 удаляет ограничение по времени жизни.

max_size

integer

Максимальное количество экземпляров в группе. Если не указано, используется текущее значение для группы.

metrics_collection

boolean

Включить сборку метрик ASG.

Варианты:

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

metrics_granularity

string

Если это metrics_collection=true, это определит точность метрик, собираемых CloudWatch.

По умолчанию: "1Minute"

metrics_list

list / elements=string

Список метрик автомасштабирования, которые нужно собирать, если metrics_collection=true.

По умолчанию: ["GroupMinSize", "GroupMaxSize", "GroupDesiredCapacity", "GroupInServiceInstances", "GroupPendingInstances", "GroupStandbyInstances", "GroupTerminatingInstances", "GroupTotalInstances"]

min_size

integer

Минимальное количество экземпляров в группе. Если не указано, используется текущее значение для группы.

mixed_instances_policy

dictionary

Политика смешанных экземпляров для использования в ASG.

Используется только при конфигурировании ASG с использованием шаблона запуска (launch_template).

См. также https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-mixedinstancespolicy.html

instance_types

list / elements=string

Список типов экземпляров.

instances_distribution

dictionary

added in community.aws 1.5.0

Указывает распределение экземпляров On-Demand и Spot, максимальную цену для Spot-экземпляров и то, как группа Auto Scaling распределяет типы экземпляров для выполнения емкости On-Demand и Spot.

См. также https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_InstancesDistribution.html

on_demand_allocation_strategy

string

added in community.aws 1.5.0

Указывает, как распределять типы экземпляров для выполнения емкости On-Demand.

on_demand_base_capacity

integer

added in community.aws 1.5.0

Минимальное количество емкости группы Auto Scaling, которое должно быть обеспечено экземплярами On-Demand. Эта базовая часть предоставляется в первую очередь при масштабировании группы.

По умолчанию, если не задано, 0. Если оставить 0, экземпляры On-Demand запускаются в процентах от желаемой емкости группы Auto Scaling, в соответствии с настройкой mixed_instances_policy.instances_distribution.on_demand_percentage_above_base_capacity.

on_demand_percentage_above_base_capacity

integer

added in community.aws 1.5.0

Управляет процентами экземпляров On-Demand и Spot для дополнительной емкости сверх mixed_instances_policy.instances_distribution.on_demand_base_capacity.

По умолчанию, если не задано, 100. Если оставить 100, проценты составляют 100% для экземпляров On-Demand и 0% для экземпляров Spot.

Допустимый диапазон: от 0 до 100.

spot_allocation_strategy

string

added in community.aws 1.5.0

Указывает, как распределять экземпляры в пулах Spot-экземпляров.

spot_instance_pools

целое число

добавлено в community.aws 1.5.0

Количество пулов Spot Instance, по которым следует распределять ваши Spot-инстансы. Пулы Spot определяются по различным типам экземпляров в массиве Overrides LaunchTemplate. Значение по умолчанию, если параметр не указан, — 2.

Используется только при стратегии распределения Spot — lowest-price.

Допустимый диапазон: минимальное значение 1, максимальное значение 20.

spot_max_price

строка

добавлено в community.aws 1.5.0

Максимальная цена за час использования Spot-инстанса.

Если значение этого параметра не указано (по умолчанию), максимальная цена Spot устанавливается на уровне цены On-Demand.

Чтобы удалить ранее заданное значение, укажите параметр, но оставьте значение пустым.

name

строка / обязательный

Уникальное имя создаваемой или удаляемой группы.

notification_topic

строка

ARN темы SNS для отправки уведомлений о масштабировании.

notification_types

список / элементы=строка

Список событий масштабирования, которые должны вызывать уведомления.

Значение по умолчанию: ["autoscaling:EC2_INSTANCE_LAUNCH", "autoscaling:EC2_INSTANCE_LAUNCH_ERROR", "autoscaling:EC2_INSTANCE_TERMINATE", "autoscaling:EC2_INSTANCE_TERMINATE_ERROR"]

placement_group

строка

Физическое расположение группы размещения вашего кластера, созданной в Amazon EC2.

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.

purge_tags

логическое значение

добавлено в community.aws 3.2.0

Если true, существующие теги будут очищены с ресурса, чтобы полностью соответствовать тому, что определено параметром tags.

Если параметр tags не задан, теги не будут изменены.

Варианты:

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

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.

replace_all_instances

логическое значение

В режиме постепенного обновления замещает все экземпляры, которые использовали старый конфигурационный шаблон, на экземпляры из нового конфигурационного шаблона. Увеличивает размер ASG на replace_batch_size, ожидает, пока новые экземпляры будут запущены и готовы к работе. После этого завершает пакет старых экземпляров, ожидает замены и повторяет, пока все старые экземпляры не будут заменены. После этого размер ASG уменьшается до ожидаемого размера.

Варианты:

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

replace_batch_size

целое число

Количество экземпляров, которые необходимо заменить за один раз. Используется с replace_all_instances.

Значение по умолчанию: 1

replace_instances

список / элементы=строка

Список идентификаторов экземпляров, принадлежащих указанной группе AutoScalingGroup, которые нужно остановить и заменить экземплярами, соответствующими текущему конфигурационному шаблону.

Значение по умолчанию: []

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

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.

Переменные среды 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.

state

string

Зарегистрировать или отменить регистрацию экземпляра.

Варианты:

• "present" ← (default)
• "absent"

suspend_processes

list / elements=string

Список процессов масштабирования для приостановки.

Допустимые значения включают:

Launch, Terminate, HealthCheck, ReplaceUnhealthy, AZRebalance, AlarmNotification, ScheduledActions, AddToLoadBalancer

Полная документация по допустимым значениям находится в документации AWS:

https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html

По умолчанию: []

tags

list / elements=dictionary

Список тегов для добавления в группу автомасштабирования.

Необязательный ключ — propagate_at_launch, по умолчанию — true.

Когда propagate_at_launch равно true, теги будут распространяться на созданные экземпляры.

По умолчанию: []

target_group_arns

list / elements=string

Список ARN целевых групп для использования в группе. Используется для балансировщиков нагрузки приложений.

termination_policies

list / elements=string

Упорядоченный список критериев, используемых для выбора экземпляров, которые будут удалены из группы автомасштабирования при уменьшении емкости.

Использование termination_policies=Default при изменении существующей группы автомасштабирования приведет к сохранению существующей политики вместо изменения на Default.

Допустимые значения включают: Default, OldestInstance, NewestInstance, OldestLaunchConfiguration, ClosestToNextInstanceHour

Полная документация по допустимым значениям находится в документации AWS:

https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#custom-termination-policy

По умолчанию: ["Default"]

validate_certs

boolean

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

Установка validate_certs=false настоятельно не рекомендуется, в качестве альтернативы рассмотрите возможность установки aws_ca_bundle.

Варианты:

• false
• true ← (default)

vpc_zone_identifier

list / elements=string

Список подсетей VPC для использования

wait_for_instances

boolean

Ожидать, пока экземпляры ASG не перейдут в готовое состояние, прежде чем завершать работу. Если экземпляры находятся за ELB, он будет ждать, пока ELB не определит, что у всех экземпляров lifecycle_state равен «InService» и health_status равен «Healthy».

Варианты:

• false
• true ← (default)

wait_timeout

integer

Как долго ждать, пока экземпляры не станут работоспособными при замене. Если вы столкнулись с ошибкой «Waited too long for ELB instances to be healthy», попробуйте увеличить это значение.

По умолчанию: 300

auto_scaling_group_arn

string

Уникальный ARN группы автомасштабирования

Возвращается: успех

Пример: "arn:aws:autoscaling:us-east-1:123456789012:autoScalingGroup:6a09ad6d-eeee-1234-b987-ee123ced01ad:autoScalingGroupName/myasg"

auto_scaling_group_name

string

Уникальное имя группы автомасштабирования

Возвращается: успех

Пример: "myasg"

availability_zones

list / elements=string

Зоны доступности для группы автомасштабирования

Возвращается: успех

Пример: ["us-east-1d"]

created_time

string

Метка времени создания группы автомасштабирования

Возвращается: успех

Пример: "2017-11-08T14:41:48.272000+00:00"

default_cooldown

integer

Время ожидания по умолчанию в секундах.

Возвращается: успех

Пример: 300

desired_capacity

integer

Количество экземпляров EC2, которые должны работать в этой группе.

Возвращается: успех

Пример: 3

healthcheck_period

integer

Продолжительность в секундах после ввода нового экземпляра EC2 в эксплуатацию, когда Auto Scaling начинает проверять его работоспособность.

Возвращается: успех

Пример: 30

healthcheck_type

string

Сервис, из которого вы хотите получить состояние работоспособности, один из «EC2» или «ELB».

Возвращается: успех

Пример: "ELB"

healthy_instances

integer

Количество экземпляров в работоспособном состоянии

Возвращается: успех

Пример: 5

in_service_instances

integer

Количество экземпляров в работе

Возвращается: успех

Пример: 3

instance_facts

dictionary

Словарь экземпляров EC2 и их состояния относительно ASG.

Возвращается: успех

Пример: {"i-0123456789012": {"health_status": "Healthy", "launch_config_name": "public-webapp-production-1", "lifecycle_state": "InService"}}

instances

list / elements=string

Список ID экземпляров в ASG

Возвращается: успех

Пример: ["i-0123456789012"]

launch_config_name

string

Имя конфигурации запуска, связанной с ASG. То же самое, что и launch_configuration_name, предоставлено для совместимости с модулем amazon.aws.autoscaling_group.

Возвращается: успех

Пример: "public-webapp-production-1"

load_balancers

list / elements=string

Список имен балансировщиков нагрузки, прикрепленных к ASG.

Возвращается: успех

Пример: ["elb-webapp-prod"]

max_instance_lifetime

integer

Максимальное время работы экземпляра в секундах.

Возвращается: успех

Пример: 604800

max_size

integer

Максимальный размер группы

Возвращается: успех

Пример: 3

metrics_collection

список / элементы=строка

Список включённых метрик AutosSalingGroup

Возвращаемое значение: успех

Пример: [{"Granularity": "1Minute", "Metric": "GroupInServiceInstances"}]

min_size

целое число

Минимальный размер группы

Возвращаемое значение: успех

Пример: 1

mixed_instances_policy

список / элементы=строка

Возвращает список типов экземпляров, если задана политика смешанных экземпляров.

Возвращаемое значение: успех

Пример: ["t3.micro", "t3a.micro"]

mixed_instances_policy_full

словарь

Возвращает полное представление словаря политики смешанных экземпляров, если она задана.

Возвращаемое значение: успех

Пример: {"instances_distribution": {"on_demand_allocation_strategy": "prioritized", "on_demand_base_capacity": 0, "on_demand_percentage_above_base_capacity": 0, "spot_allocation_strategy": "capacity-optimized"}, "launch_template": {"launch_template_specification": {"launch_template_id": "lt-53c2425cffa544c23", "launch_template_name": "random-LaunchTemplate", "version": "2"}, "overrides": [{"instance_type": "m5.xlarge"}, {"instance_type": "m5a.xlarge"}]}}

pending_instances

целое число

Количество экземпляров в состоянии ожидания

Возвращаемое значение: успех

Пример: 1

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"]

unhealthy_instances

целое число

Количество экземпляров в нездоровом состоянии

Возвращаемое значение: успех

Пример: 0

viable_instances

целое число

Количество экземпляров в жизнеспособном состоянии

Возвращаемое значение: успех

Пример: 1

vpc_zone_identifier

строка

ИД зоны VPC / ID подсети для группы автоматического масштабирования

Возвращаемое значение: успех

Пример: "subnet-a31ef45f"