Spec-Zone.ru › Ansible 2.5

elasticache - Управление кластерами кэша в Amazon Elasticache.

Новое в версии 1.4.

  • Обзор
    • Требования
  • Параметры
  • Примечания
  • Примеры
  • Статус
    • Автор

Обзор

  • Управление кластерами кэша в Amazon Elasticache.
  • Возвращает информацию о заданном кластере кэша.

Требования

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

  • boto
  • boto3
  • python >= 2.6

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
aws_access_key Значение по умолчанию:
None
Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY.

Псевдонимы: ec2_access_key, access_key
aws_secret_key Значение по умолчанию:
None
Секретный ключ 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 Значение по умолчанию:
None
URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она есть.
engine
    Варианты:
  • redis
  • memcached ←
Имя движка кэша, который будет использоваться.
hard_modify
    Варианты:
  • yes
  • no ←
Указать, нужно ли уничтожить и воссоздать существующий кластер кэша при необходимости, чтобы изменить его состояние
name
обязательно
Идентификатор кластера кэша
node_type Значение по умолчанию:
cache.m1.small
Вычислительные и емкостные характеристики узлов в кластере кэша
num_nodes
Начальное количество узлов кэша, которые будет иметь кластер кэша. Требуется, когда состояние=present.
profile
(добавлен в 1.6)
Значение по умолчанию:
None
Использует профиль 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)
Значение по умолчанию:
None
Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN.

Псевдонимы: access_token
state
обязательно
    Варианты:
  • present
  • absent
  • rebooted
absent или present — идемпотентные действия, которые создадут или уничтожат кластер кэша по мере необходимости. rebooted перезагрузит кластер, что приведет к кратковременному перерыву в работе.
validate_certs
(добавлен в 1.5)
    Варианты:
  • no
  • yes ←
В случае значения "no", сертификаты SSL не будут проверены для версий boto >= 2.6.0.
wait
    Варианты:
  • yes ←
  • no
Ожидание результата кластера кэша перед возвратом
zone Значение по умолчанию:
None
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

Статус

Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.

Автор

  • 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.5/modules/elasticache_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API