Модуль community.aws.autoscaling_scheduled_action – Создание, изменение и удаление запланированных действий масштабирования ASG
Примечание
Этот модуль является частью коллекции community.aws (версия 8.0.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.aws. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.
Для использования в плейбуке укажите: community.aws.autoscaling_scheduled_action.
Новый в community.aws 2.2.0
Описание
- Модуль создаст новое запланированное действие, когда state=present и соответствующее действие не найдено.
- Модуль обновит существующее запланированное действие, когда state=present и соответствующее действие найдено.
- Модуль удалит запланированное действие, когда state=absent и соответствующее действие найдено.
- До версии 5.0.0 этот модуль назывался
community.aws.ec2_asg_scheduled_action. Использование не изменилось.
Псевдонимы: ec2_asg_scheduled_action
Требования
Ниже перечислены требования, которые должны быть выполнены на хосте, выполняющем этот модуль.
- python >= 3.6
- boto3 >= 1.26.0
- botocore >= 1.29.0
Параметры
Параметр | Комментарии |
|---|---|
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 и profile являются взаимоисключающими. Псевдоним aws_access_key_id был добавлен в версии 5.1.0 для согласованности с AWS botocore SDK. Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды |
autoscaling_group_name string / required | Имя группы автомасштабирования, к которой нужно добавить запланированное действие. |
aws_ca_bundle path | Расположение пакета CA, используемого при проверке 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 | Использовать Переменная среды Варианты:
|
desired_capacity integer | Требуемая емкость ASG. |
end_time string | Время окончания действия. |
endpoint_url aliases: ec2_url, aws_endpoint_url, s3_url string | URL для подключения вместо стандартных конечных точек AWS. Хотя это может использоваться для подключения к другим совместимым с AWS сервисам, коллекции amazon.aws и community.aws тестируются только с AWS. Переменные среды Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01. Поддержка переменной среды |
max_size integer | Максимальная емкость ASG. |
min_size integer | Минимальная емкость ASG. |
profile aliases: aws_profile string | Именованный профиль AWS для использования в целях аутентификации. См. документацию AWS для получения дополнительной информации об именованных профилях https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Переменная среды Параметр profile является взаимоисключающим с параметрами aws_access_key, aws_secret_key и security_token. |
recurrence string | Расписание в стиле cron для повторения действия. Требуется, когда state=present. |
region aliases: aws_region, ec2_region string | Регион AWS для использования. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, region игнорируется. Переменные среды См. документацию Amazon AWS для получения дополнительной информации http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. Псевдоним Поддержка переменной среды |
scheduled_action_name string / required | Имя запланированного действия. |
secret_key aliases: aws_secret_access_key, aws_secret_key, ec2_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 для согласованности с SDK AWS botocore. Псевдоним 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. Также можно использовать переменные среды Параметры 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. Поддержка переменных среды |
start_time string | Время начала действия. |
state string | Создание/обновление или удаление запланированного действия. Выбоpы:
|
time_zone string | Временная зона для выполнения. |
validate_certs boolean | При установке в Установка validate_certs=false настоятельно не рекомендуется, как альтернатива, рассмотрите установку aws_ca_bundle вместо этого. Выбоpы:
|
Примечания
Примечание
- Внимание: Для модулей переменные среды и файлы конфигурации считываются из контекста хоста Ansible, а не из контекста контроллера. Поэтому файлы может потребоваться скопировать явно на хост. Для плагинов поиска и подключения переменные среды и файлы конфигурации считываются из контекста контроллера Ansible, а не из контекста хоста.
- AWS SDK (boto3), используемый Ansible, также может считывать значения по умолчанию для учетных данных и других настроек, таких как регион, из своих файлов конфигурации в контексте хоста Ansible (обычно
~/.aws/credentials). См. https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html для получения дополнительной информации.
Примеры
# Create a scheduled action for a autoscaling group.
- name: Create a minimal scheduled action for autoscaling group
community.aws.autoscaling_scheduled_action:
region: eu-west-1
autoscaling_group_name: test_asg
scheduled_action_name: test_scheduled_action
start_time: 2021 October 25 08:00 UTC
recurrence: 40 22 * * 1-5
desired_capacity: 10
state: present
register: scheduled_action
- name: Create a scheduled action for autoscaling group
community.aws.autoscaling_scheduled_action:
region: eu-west-1
autoscaling_group_name: test_asg
scheduled_action_name: test_scheduled_action
start_time: 2021 October 25 08:00 UTC
end_time: 2021 October 25 08:00 UTC
time_zone: Europe/London
recurrence: 40 22 * * 1-5
min_size: 10
max_size: 15
desired_capacity: 10
state: present
register: scheduled_action
- name: Delete scheduled action
community.aws.autoscaling_scheduled_action:
region: eu-west-1
autoscaling_group_name: test_asg
scheduled_action_name: test_scheduled_action
state: absent
Значения возврата
Общие значения возврата документированы здесь, следующие являются полями, уникальными для данного модуля:
Ключ | Описание |
|---|---|
desired_capacity целое число | Желательная емкость ASG. Возвращается: при state=present Пример: |
end_time строка | Время окончания действия. Возвращается: при state=present Пример: |
max_size целое число | Максимальная емкость ASG. Возвращается: при state=present Пример: |
min_size целое число | Минимальная емкость ASG. Возвращается: при state=present Пример: |
recurrence строка | Расписание в формате cron для повторения действия. Возвращается: при state=present Пример: |
scheduled_action_name строка | Имя запланированного действия. Возвращается: при state=present Пример: |
start_time строка | Время начала действия. Возвращается: при state=present Пример: |
time_zone строка | Идентификатор Amazon Machine Image, используемый конфигурацией запуска. Возвращается: при state=present Пример: |
Ссылки на сборку
© 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/community/aws/autoscaling_scheduled_action_module.html