elasticache – Управление кластерами кэша в Amazon Elasticache
Обзор
- Управление кластерами кэша в 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 | |
| debug_botocore_endpoint_logs логический тип добавлено в 2.8 |
| Используйте обработчик логов botocore.endpoint для анализа уникальных (а не общих) вызовов API «ресурс:действие», выполненных во время задачи, выводив набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода в общий список, выполненный во время выполнения сценария. Также может быть использована переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS. |
| ec2_url строка | URL, используемый для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задано, используется значение переменной окружения EC2_URL, если таковое имеется. | |
| engine - |
| Имя движка кэша, который будет использоваться. |
| hard_modify логический тип |
| Определяет, следует ли уничтожить и воссоздать существующий кластер кэша при необходимости для изменения его состояния |
| name - / обязательно | Идентификатор кластера кэша | |
| node_type - | По умолчанию: "cache.m1.small" | Вычислительная и емкостная мощность узлов в кластере кэша |
| num_nodes - | Начальное количество узлов кэша, которые будет иметь кластер кэша. Требуется при state=present. | |
| profile строка | Использует профиль 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 - | Список идентификаторов групп безопасности VPC, которые следует связать с этим кластером кэша. Используется только если внутри VPC | |
| security_token строка | Токен безопасности AWS STS. Если не задано, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. псевдонимы: access_token | |
| state - / обязательно |
| absent или present — это идемпотентные действия, которые создадут или уничтожат кластер кэша по мере необходимости. rebooted перезапустит кластер, что приведет к кратковременному перерыву в работе. |
| validate_certs логический тип |
| Если установлено значение «нет», сертификаты SSL не будут проверяться для версий boto >= 2.6.0. |
| wait логический тип |
| Ожидание результата кластера кэша перед возвратом |
| 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), если данные учетных данных не предоставлены. См. https://boto.readthedocs.io/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. [community]
Авторы
- 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.8/modules/elasticache_module.html
