Модуль amazon.aws.autoscaling_group — создание или удаление групп AWS Auto Scaling (ASG)

access_key

aliases: 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_ID или AWS_ACCESS_KEY в порядке убывания приоритета.

Параметры aws_access_key и profile являются взаимоисключающими.

Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для согласованности с AWS botocore SDK.

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 для анализа уникальных (а не общего количества) вызовов API "resource:action", выполненных во время задачи, и выводить их набор в ключ resource_actions результатов задачи. Используйте callback aws_resource_action, чтобы вывести общий список вызовов, выполненных в плейбуке.

Также можно использовать переменную окружения ANSIBLE_DEBUG_BOTOCORE_LOGS.

Варианты:

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

decrement_desired_capacity

boolean

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

Поддержка параметров detach_instances и decrement_desired_capacity объявлена устаревшей и будет удалена в выпуске 14.0.0. Для добавления экземпляров в группу Auto Scaling и их отсоединения от нее можно использовать модуль amazon.aws.autoscaling_instance.

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

Варианты:

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

default_cooldown

integer

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

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

desired_capacity

integer

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

detach_instances

list / elements=string

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

Поддержка параметра detach_instances объявлена устаревшей и будет удалена в выпуске 14.0.0. Для добавления экземпляров в группу Auto Scaling и их отсоединения от нее можно использовать модуль amazon.aws.autoscaling_instance.

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

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

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

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

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

endpoint_url

aliases: aws_endpoint_url

string

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

Также можно использовать переменную окружения AWS_URL.

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.

При создании новой группы AutoScaling необходимо указать ровно один из параметров launch_config_name или launch_template.

Примечание Amazon объявила об отказе от поддержки конфигураций запуска AutoScaling в пользу шаблонов запуска EC2. Дополнительные сведения см. по адресу https://docs.aws.amazon.com/autoscaling/ec2/userguide/launch-configurations.html.

launch_template

dictionary

Словарь с описанием используемого шаблона запуска.

При создании новой группы AutoScaling необходимо указать ровно один из параметров launch_config_name или launch_template.

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

Поддержка параметров detach_instances и lc_check объявлена устаревшей и будет удалена в выпуске 14.0.0. Для добавления экземпляров в группу Auto Scaling и их отсоединения от нее можно использовать модуль amazon.aws.autoscaling_instance.

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

Варианты:

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

load_balancers

list / elements=string

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

lt_check

boolean

Поддержка параметров detach_instances и lt_check объявлена устаревшей и будет удалена в выпуске 14.0.0. Для добавления экземпляров в группу Auto Scaling и их отсоединения от нее можно использовать модуль amazon.aws.autoscaling_instance.

Проверяет, чтобы заменяемые с помощью 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

добавлено в 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

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

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

on_demand_base_capacity

integer

добавлено в 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

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

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

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

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

spot_allocation_strategy

string

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

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

spot_instance_pools

integer

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

Количество пулов экземпляров Spot, между которыми распределяются экземпляры Spot. Пулы Spot определяются на основе разных типов экземпляров в массиве Overrides объекта LaunchTemplate. Если параметр не задан, используется значение 2.

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

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

spot_max_price

string

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

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

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

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

name

aliases: group_name

string / обязательный

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

notification_topic

string

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

notification_types

list / elements=string

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

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

placement_group

string

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

profile

aliases: aws_profile

string

Именованный профиль AWS для аутентификации.

Дополнительные сведения об именованных профилях см. в документации AWS: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html.

Также можно использовать переменную окружения AWS_PROFILE.

Параметр profile является взаимоисключающим с параметрами aws_access_key, aws_secret_key и session_token.

protected_from_scale_in

boolean

добавлено в amazon.aws 11.1.0

Если задано true, для новых экземпляров включается защита от уменьшения масштаба при добавлении в AutoScaling Group.

При создании новой AutoScaling Group по умолчанию используется значение false.

Варианты:

• false
• true

purge_tags

boolean

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

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

Если параметр tags не задан, теги не изменяются.

Варианты:

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

region

aliases: aws_region

string

Регион AWS для использования.

Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется.

Также можно использовать переменную окружения AWS_REGION.

Дополнительные сведения см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

replace_all_instances

boolean

Поддержка параметра replace_all_instances объявлена устаревшей и будет удалена в версии 14.0.0. Для автоматической замены экземпляров можно использовать модуль amazon.aws.autoscaling_instance_refresh.

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

Варианты:

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

replace_batch_size

integer

Поддержка параметров replace_all_instances и replace_batch_size объявлена устаревшей и будет удалена в версии 14.0.0. Для автоматической замены экземпляров можно использовать модуль amazon.aws.autoscaling_instance_refresh.

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

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

replace_instances

list / elements=string

Поддержка параметра replace_instances объявлена устаревшей и будет удалена в версии 14.0.0. Для завершения работы экземпляров, подключенных к группе Auto Scaling, можно использовать модуль amazon.aws.autoscaling_instance.

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

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

secret_key

aliases: 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.

Также можно использовать переменные окружения AWS_SECRET_ACCESS_KEY или AWS_SECRET_KEY в порядке убывания предпочтения.

Параметры secret_key и profile являются взаимоисключающими.

Псевдоним aws_secret_access_key добавлен в версии 5.1.0 для соответствия AWS SDK botocore.

session_token

aliases: 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.

Также можно использовать переменную окружения AWS_SESSION_TOKEN.

Параметры session_token и profile являются взаимоисключающими.

state

string

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

Варианты:

• "present" ← (по умолчанию)
• "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

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

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

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

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

target_group_arns

list / elements=string

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

termination_policies

list / elements=string

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

При изменении существующей группы AutoScalingGroup использование 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 ← (по умолчанию)

vpc_zone_identifier

list / elements=string

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

wait_for_instances

boolean

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

Варианты:

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

wait_timeout

integer

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

По умолчанию: 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

Список идентификаторов экземпляров в 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

list / elements=string

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

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

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

min_size

integer

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

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

Пример: 1

mixed_instances_policy

list / elements=string

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

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

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

mixed_instances_policy_full

dictionary

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

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

Пример: {"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

integer

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

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

Пример: 1

tags

list / elements=string

Список тегов 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

list / elements=string

Список ARN целевых групп, в которые 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

list / elements=string

Список имен целевых групп, в которые ASG добавляет экземпляры

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

Пример: ["target-group-host-hello", "target-group-path-world"]

termination_policies

list / elements=string

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

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

Пример: ["Default"]

unhealthy_instances

integer

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

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

Пример: 0

viable_instances

integer

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

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

Пример: 1

vpc_zone_identifier

string

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

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

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