elasticache - Управление кластерами кэша в Amazon Elasticache.
Новая версия 1.4.
Обзор
- Управление кластерами кэша в Amazon Elasticache.
- Возвращает информацию о заданном кластере кэша.
Требования (к хосту, на котором выполняется модуль)
- python >= 2.6
- boto
Параметры
| параметр | обязательный | значение по умолчанию | варианты | примечания |
|---|---|---|---|---|
| aws_access_key | нет | Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. псевдонимы: ec2_access_key, access_key | ||
| aws_secret_key | нет | Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. псевдонимы: ec2_secret_key, secret_key | ||
| cache_engine_version | нет | None | Номер версии движка кэша | |
| cache_parameter_group (добавлен в 2.0)
| нет | None | Имя группы параметров кэша, которое нужно ассоциировать с этим кластером кэша. Если этот аргумент опущен, будет использоваться группа параметров кэша по умолчанию для указанного движка. псевдонимы: parameter_group | |
| cache_port | нет | None | Номер порта, на котором каждый из узлов кэша будет принимать подключения | |
| cache_security_groups | нет | None | Список имен групп безопасности кэша, которые нужно ассоциировать с этим кластером кэша. Должен быть пустым списком, если внутри VPC | |
| cache_subnet_group (добавлен в 2.0)
| нет | None | Имя подсети группы, которая должна быть ассоциирована. Использовать только если внутри VPC. Требуется, если внутри VPC | |
| ec2_url | нет | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковое есть. | ||
| engine | нет | memcached |
| Имя движка кэша, который будет использоваться. |
| hard_modify | нет |
| Нужно ли уничтожить и воссоздать существующий кластер кэша при необходимости, чтобы изменить его состояние | |
| name | да | Идентификатор кластера кэша | ||
| node_type | нет | cache.m1.small | Вычислительные и емкостные характеристики узлов в кластере кэша | |
| num_nodes | нет | Начальное количество узлов кэша, которые будет иметь кластер кэша. Требуется, когда state=present. | ||
| profile (добавлен в 1.6)
| нет | Использует профиль boto. Работает только с boto >= 2.24.0. | ||
| region | нет | Регион AWS, который нужно использовать. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если таковое есть. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
псевдонимы: aws_region, ec2_region | ||
| security_group_ids (добавлен в 1.6)
| нет | None | Список имен групп безопасности VPC, которые нужно ассоциировать с этим кластером кэша. Использовать только если внутри VPC | |
| security_token (добавлен в 1.6)
| нет | Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. псевдонимы: access_token | ||
| state | да |
| absent или present — идемпотентные действия, которые будут создавать или удалять кластер кэша по мере необходимости. rebooted перезапустит кластер, что приведет к кратковременному простою. | |
| validate_certs (добавлен в 1.5)
| нет | да |
| При значении "нет" сертификаты SSL не будут проверены для версий boto >= 2.6.0. |
| wait | нет | True |
| Ожидание результата кластера кэша перед возвратом |
| zone | нет | None | Зона доступности EC2, в которой будет создан кластер кэша |
Примеры
# Note: None of these examples set aws_access_key, aws_secret_key, or region.
# It is assumed that their matching environment variables are set.
# Basic example
- elasticache:
name: "test-please-delete"
state: present
engine: memcached
cache_engine_version: 1.4.14
node_type: cache.m1.small
num_nodes: 1
cache_port: 11211
cache_security_groups:
- default
zone: us-east-1d
# Ensure cache cluster is gone
- elasticache:
name: "test-please-delete"
state: absent
# Reboot cache cluster
- elasticache:
name: "test-please-delete"
state: rebooted
Примечания
Примечание
- Если параметры не заданы в модуле, можно использовать следующие переменные окружения в порядке убывания приоритета
AWS_URLилиEC2_URL,AWS_ACCESS_KEY_IDилиAWS_ACCESS_KEYилиEC2_ACCESS_KEY,AWS_SECRET_ACCESS_KEYилиAWS_SECRET_KEYилиEC2_SECRET_KEY,AWS_SECURITY_TOKENилиEC2_SECURITY_TOKEN,AWS_REGIONилиEC2_REGION - Ansible использует конфигурационный файл boto (обычно ~/.boto), если учетные данные не предоставлены. См. http://boto.readthedocs.org/en/latest/boto_config_tut.html
-
AWS_REGIONилиEC2_REGIONможно использовать для указания региона AWS, когда это требуется, но это также можно настроить в конфигурационном файле boto
Статус
Этот модуль помечен как экспериментальный, что означает, что он не гарантирует обратную совместимость интерфейса.
Для помощи в разработке модулей, если вы этого желаете, пожалуйста, прочитайте Информацию о сообществе и вклад, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/elasticache_module.html