community.aws.elasticache – Управление кластерами кэша в Amazon ElastiCache

Примечание

Этот плагин входит в коллекцию community.aws (версия 1.3.0).

Для его установки используйте: ansible-galaxy collection install community.aws.

Чтобы использовать его в книге задач, укажите: community.aws.elasticache.

Новое в версии 1.0.0: из community.aws

Обзор
Требования
Параметры
Примечания
Примеры

Обзор

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

Требования

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

boto
boto3
python >= 2.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
aws_access_key строка		Ключ доступа AWS. Если не задан, используется значение переменной среды AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Если задан параметр profile, этот параметр игнорируется. Передача параметров aws_access_key и profile одновременно устарела и параметры будут сделаны взаимоисключающими после 2022-06-01. псевдонимы: ec2_access_key, access_key
aws_ca_bundle путь		Расположение файла с сертификатами доверенных центров сертификации (CA Bundle), используемого при валидации SSL-сертификатов. Используется только для модулей, основанных на boto3. Примечание: CA Bundle читается на стороне модуля и может потребоваться явное копирование с контроллера, если модуль не запускается локально.
aws_config словарь		Словарь для изменения конфигурации botocore. Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Для модулей boto используется только ключ 'user_agent'. Подробнее о конфигурации boto см. по адресу http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto.
aws_secret_key строка		Секретный ключ AWS. Если не задан, используется значение переменной среды AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Если задан параметр profile, этот параметр игнорируется. Передача параметров aws_secret_key и profile одновременно устарела и параметры будут сделаны взаимоисключающими после 2022-06-01. псевдонимы: ec2_secret_key, secret_key
cache_engine_version строка		Номер версии движка кэша.
cache_parameter_group строка		Имя группы параметров кэша, которое следует связать с этим кластером кэша. Если этот аргумент опущен, используется группа параметров кэша по умолчанию для указанного движка. псевдонимы: parameter_group
cache_port целое число		Номер порта, на котором каждый из узлов кэша будет принимать подключения.
cache_security_groups список / элементы=строка		Список имен групп безопасности кэша, которые следует связать с этим кластером кэша. Должен быть пустым списком, если внутри VPC.
cache_subnet_group строка		Имя группы подсетей, которое следует связать. Используйте только если внутри VPC. Требуется, если внутри VPC.
debug_botocore_endpoint_logs логический тип	Варианты: нет ← да	Использовать логирование botocore.endpoint для анализа уникальных (а не общих) API-вызовов «ресурс:действие», выполненных во время задачи, выводить набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action, чтобы выводить общий список, сделанный во время книги задач. Переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS также может быть использована.
ec2_url строка		URL, который нужно использовать для подключения к EC2 или облаку Eucalyptus (по умолчанию модуль будет использовать адреса EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не указан, используется значение переменной среды EC2_URL, если она задана. псевдонимы: aws_endpoint_url, endpoint_url
engine строка	По умолчанию: "memcached"	Имя движка кэша, который следует использовать. Поддерживаемые значения `redis` и `memcached`.
hard_modify логический тип	Варианты: нет да	Определяет, необходимо ли уничтожить и воссоздать существующий кластер кэша, если это необходимо, чтобы изменить его состояние. По умолчанию `false`.
name строка / обязательно		Идентификатор кластера кэша.
node_type строка	По умолчанию: "cache.t2.small"	Вычислительная и емкостная мощность узлов в кластере кэша.
num_nodes целое число	По умолчанию: 1	Начальное количество узлов кэша, которые будет иметь кластер кэша. Требуется, когда state=present.
profile строка		Использует профиль boto. Работает только с boto >= 2.24.0. Использование profile переопределит aws_access_key, aws_secret_key и security_token, и поддержка их одновременной передачи с profile устарела. aws_access_key, aws_secret_key и security_token будут сделаны взаимоисключающими с profile после 2022-06-01. псевдонимы: aws_profile
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. Если задан параметр profile, этот параметр игнорируется. Передача параметров security_token и profile одновременно устарела и параметры будут сделаны взаимоисключающими после 2022-06-01. псевдонимы: aws_security_token, access_token
state строка / обязательно	Варианты: present absent rebooted	`absent` или `present` — идемпотентные действия, которые будут создавать или уничтожать кластер кэша по мере необходимости. `rebooted` перезапустит кластер, что приведет к кратковременному перерыву в работе.
validate_certs логический тип	Варианты: нет да ←	При значении «нет» SSL-сертификаты для версий boto >= 2.6.0 не будут проверяться.
wait логический тип	Варианты: нет да ←	Ожидать результата кластера кэша перед возвращением.
zone строка		Зона доступности EC2, в которой будет создан кластер кэша.

Примечания

Примечание

Если параметры не заданы в модуле, можно использовать следующие переменные среды в порядке убывания приоритета AWS_URL или EC2_URL, AWS_PROFILE или AWS_DEFAULT_PROFILE, 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, AWS_CA_BUNDLE
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.

- name: Basic example
  community.aws.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


- name: Ensure cache cluster is gone
  community.aws.elasticache:
    name: "test-please-delete"
    state: absent

- name: Reboot cache cluster
  community.aws.elasticache:
    name: "test-please-delete"
    state: rebooted

Авторы

Jim Dalton (@jsdalton)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/aws/elasticache_module.html