Модуль amazon.aws.autoscaling_instance — управление экземплярами, связанными с группами AWS Auto Scaling (ASG)

access_key

псевдонимы: aws_access_key_id, aws_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 в порядке убывания приоритета.

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

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

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

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

Варианты:

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

decrement_desired_capacity

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

Если decrement_desired_capacity=True, при отсоединении или завершении работы экземпляров, а также при переводе экземпляров в режим ожидания требуемая емкость группы Auto Scaling будет уменьшена.

Варианты:

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

endpoint_url

псевдонимы: aws_endpoint_url

строка

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

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

group_name

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

Имя группы Auto Scaling, которой нужно управлять.

health

строка

Задает для экземпляра определенное состояние работоспособности.

Варианты:

• "Healthy"
• "Unhealthy"

instance_ids

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

Идентификаторы экземпляров EC2.

Обязателен, если state имеет одно из значений standby, detached, terminated.

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 и session_token.

protection

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

Задает атрибут защиты от уменьшения масштаба.

Варианты:

• false
• true

purge_instances

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

Игнорируется, если не задано state=present или state=attached.

Если задано purge_instances=True, для всех экземпляров, отсутствующих в instance_ids, будет запланировано завершение работы.

Примечание: Завершение работы экземпляров будет запланировано после добавления новых экземпляров в группу Auto Scaling; если задано wait=True, завершение работы произойдет после достижения новыми экземплярами ожидаемого состояния.

Варианты:

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

region

псевдонимы: aws_region

строка

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

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

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

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

respect_grace_period

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

Задайте respect_grace_period=False, чтобы игнорировать период ожидания группы Auto Scaling при изменении health.

Игнорируется, если не задано health.

По умолчанию AWS учитывает период ожидания при изменении состояния работоспособности экземпляра.

Варианты:

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

secret_key

псевдонимы: aws_secret_access_key, aws_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 в порядке убывания приоритета.

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

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

session_token

псевдонимы: aws_session_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.

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

state

строка

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

present — экземпляры должны быть присоединены к группе Auto Scaling и находиться в состоянии обслуживания.

attached — экземпляры должны быть присоединены к группе Auto Scaling. Экземпляры в режиме ожидания останутся в этом режиме.

standby — экземпляры должны быть переведены в режим ожидания. Экземпляры уже должны входить в группу Auto Scaling.

detached — экземпляры будут отсоединены от группы Auto Scaling.

terminated — работа экземпляров будет завершена. По умолчанию завершенные экземпляры заменяются новыми. Чтобы одновременно с завершением работы экземпляров уменьшить требуемую емкость, задайте decrement_desired_capacity=True.

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

Варианты:

• "present" ← (по умолчанию)
• "attached"
• "terminated"
• "detached"
• "standby"

validate_certs

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

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

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

Варианты:

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

wait

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

Если задано wait=True, модуль будет ожидать, пока экземпляры не достигнут запрошенного состояния, прежде чем завершить работу.

Варианты:

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

wait_timeout

целое число

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

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

auto_scaling_instances

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

Описание экземпляров EC2, присоединенных к группе Auto Scaling.

Возвращается: всегда

availability_zone

строка

Зона доступности, в которой находится экземпляр.

Возвращается: всегда

Пример: "us-east-1a"

health_status

строка

Последнее зарегистрированное состояние работоспособности экземпляра.

Возвращается: всегда

Пример: "Healthy"

instance_id

строка

Идентификатор экземпляра.

Возвращается: всегда

Пример: "i-123456789abcdef01"

instance_type

строка

Тип экземпляра.

Возвращается: всегда

Пример: "t3.micro"

launch_configuration_name

строка

Имя конфигурации запуска, использованной при запуске экземпляра.

Возвращается: если экземпляр был запущен с использованием конфигурации запуска Auto Scaling.

Пример: "ansible-test-49630214-mchappel-thinkpadt14gen3-asg-instance-1"

launch_template

словарь

Описание шаблона запуска, использованного при запуске экземпляра.

Возвращается: если экземпляр был запущен с использованием шаблона запуска Auto Scaling.

launch_template_id

строка

Идентификатор шаблона запуска, использованного при запуске экземпляра.

Возвращается: всегда

Пример: "12345678-abcd-ef12-2345-6789abcdef01"

launch_template_name

строка

Имя шаблона запуска, использованного при запуске экземпляра.

Возвращается: всегда

Пример: "example-launch-configuration"

version

строка

Версия шаблона запуска, использованного при запуске экземпляра.

Возвращается: всегда

Пример: "$Default"

lifecycle_state

строка

Состояние жизненного цикла экземпляра.

Возвращается: всегда

Пример: "InService"

protected_from_scale_in

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

Защищен ли экземпляр от завершения работы при уменьшении масштаба группы Auto Scaling.

Возвращается: всегда

Пример: false