elasticache - Управление кластерами кэша в Amazon Elasticache.
Новое в версии 1.4.
Обзор
- Управление кластерами кэша в Amazon Elasticache.
- Возвращает информацию о заданном кластере кэша.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- boto
- boto3
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| 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 | Версия кэширующего движка | |
| cache_parameter_group (добавлено в 2.0) | Имя группы параметров кэша, которое нужно связать с этим кластером кэша. Если этот аргумент опущен, будет использоваться группа параметров кэша по умолчанию для указанного движка. Псевдонимы: parameter_group | |
| cache_port | Номер порта, на котором каждый из узлов кэша будет принимать подключения | |
| cache_security_groups | Список имён групп безопасности кэша, которые нужно связать с этим кластером кэша. Должен быть пустым списком, если внутри VPC. | |
| cache_subnet_group (добавлено в 2.0) | Имя группы подсетей, которую нужно связать. Используйте только если внутри VPC. Требуется, если внутри VPC | |
| ec2_url | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если не используется регион. Если не задан, используется значение переменной среды EC2_URL, если она существует. | |
| engine |
| Имя кэширующего движка, который нужно использовать. |
| hard_modify bool |
| Указать, нужно ли уничтожить и воссоздать существующий кластер кэша, если необходимо, для изменения его состояния |
| name обязательно | Идентификатор кластера кэша | |
| node_type | По умолчанию: "cache.m1.small" | Вычислительная и объёмная ёмкость узлов в кластере кэша |
| num_nodes | Начальное количество узлов кэша, которые будет иметь кластер кэша. Требуется, когда состояние=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) | Список имён групп безопасности VPC, которые нужно связать с этим кластером кэша. Используйте только если внутри VPC | |
| security_token (добавлено в 1.6) | AWS STS security token. Если не задан, используется значение переменной среды AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Псевдонимы: access_token | |
| state обязательно |
| absent или present - это идемпотентные действия, которые создадут или уничтожат кластер кэша по мере необходимости. rebooted перезапустит кластер, что приведет к кратковременному перерыву в работе. |
| validate_certs bool (добавлено в 1.5) |
| При значении "нет" сертификаты SSL для boto версии >= 2.6.0 не будут проверены. |
| wait bool |
| Ожидать результат кластера кэша перед возвратом |
| zone | EC2 зона доступности, в которой будет создан кластер кэша |
Примечания
Примечание
- Если параметры не заданы в модуле, следующие переменные среды могут быть использованы в порядке убывания приоритета
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
Примеры
# 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
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратной совместимый.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что его поддерживает сообщество Ansible. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.
Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.
Автор
- Jim Dalton (@jsdalton)
Подсказка
Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/elasticache_module.html