Модуль community.aws.elasticache — управление кластерами кэша в Amazon ElastiCache

Примечание

Этот модуль входит в коллекцию community.aws (версия 10.1.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.aws. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

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

Добавлено в community.aws 1.0.0

Краткое описание
Требования
Параметры
Примечания
Примеры

Краткое описание

Управление кластерами кэша в Amazon ElastiCache.
Возвращает сведения об указанном кластере кэша.

Требования

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

python >= 3.6
boto3 >= 1.34.0
botocore >= 1.34.0

Параметры

Параметр	Комментарии
access_key псевдонимы: aws_access_key_id, aws_access_key строка	Идентификатор ключа доступа AWS. Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные окружения `AWS_ACCESS_KEY_ID` или `AWS_ACCESS_KEY` в порядке убывания приоритета. Параметры aws_access_key и profile являются взаимоисключающими. Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для согласованности с AWS botocore SDK.
aws_ca_bundle путь	Путь к пакету сертификатов CA, используемому для проверки SSL-сертификатов. Также можно использовать переменную окружения `AWS_CA_BUNDLE`.
aws_config словарь	Словарь для изменения конфигурации botocore. Описание параметров приведено в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
cache_engine_version строка	Номер версии механизма кэширования. По умолчанию: `""`
cache_parameter_group псевдонимы: parameter_group строка	Имя группы параметров кэша, связываемой с этим кластером кэша. Если этот аргумент не указан, будет использоваться группа параметров кэша по умолчанию для заданного механизма кэширования. По умолчанию: `""`
cache_port целое число	Номер порта, на котором каждый узел кэша будет принимать подключения.
cache_security_groups список / элементы=строка	Список имен групп безопасности кэша, связываемых с этим кластером кэша. Не используйте, если кэш находится в VPC. В этом случае используйте вместо этого security_group_ids! По умолчанию: `[]`
cache_subnet_group строка	Имя группы подсетей, с которой нужно связать кластер. Используйте только при размещении в VPC. Обязательно, если кластер размещен в VPC. По умолчанию: `""`
debug_botocore_endpoint_logs логическое значение	Используйте регистратор `botocore.endpoint` для разбора уникальных (а не общих) вызовов API `"resource:action"`, выполненных во время задачи, и вывода их списка в ключ resource_actions результатов задачи. Используйте callback `aws_resource_action` для вывода общего списка вызовов, выполненных в плейбуке. Также можно использовать переменную окружения `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
endpoint_url псевдонимы: aws_endpoint_url строка	URL для подключения вместо конечных точек AWS по умолчанию. Этот параметр можно использовать для подключения к другим сервисам, совместимым с AWS, однако коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную окружения `AWS_URL`.
engine строка	Имя используемого механизма кэширования. Поддерживаются значения `redis` и `memcached`. По умолчанию: `"memcached"`
hard_modify логическое значение	Следует ли при необходимости удалить и заново создать существующий кластер кэша для изменения его состояния. По умолчанию установлено значение `false`. Варианты: `false` `true`
name строка / обязательно	Идентификатор кластера кэша.
node_type строка	Вычислительная мощность и объем памяти узлов кластера кэша. По умолчанию: `"cache.t2.small"`
num_nodes целое число	Начальное количество узлов кэша в кластере. Обязательно, если state=present. По умолчанию: `1`
profile псевдонимы: aws_profile строка	Именованный профиль AWS для аутентификации. Дополнительные сведения об именованных профилях см. в документации AWS: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также можно использовать переменную окружения `AWS_PROFILE`. Параметр profile является взаимоисключающим с параметрами aws_access_key, aws_secret_key и session_token.
region псевдонимы: aws_region строка	Регион AWS для использования. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также можно использовать переменную окружения `AWS_REGION`. Дополнительные сведения см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.
secret_key псевдонимы: aws_secret_access_key, aws_secret_key строка	Секретный ключ доступа AWS. Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные окружения `AWS_SECRET_ACCESS_KEY` или `AWS_SECRET_KEY` в порядке убывания приоритета. Параметры secret_key и profile являются взаимоисключающими. Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для согласованности с AWS botocore SDK.
security_group_ids список / элементы=строка	Список идентификаторов групп безопасности VPC, связываемых с этим кластером кэша. Используйте только при размещении в VPC. По умолчанию: `[]`
session_token псевдонимы: aws_session_token строка	Токен сеанса AWS STS для использования с временными учетными данными. Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменную окружения `AWS_SESSION_TOKEN`. Параметры session_token и profile являются взаимоисключающими.
state строка / обязательно	`absent` или `present` — идемпотентные действия, которые при необходимости создают или удаляют кластер кэша. `rebooted` перезагрузит кластер, что приведет к кратковременному простою. Варианты: `"present"` `"absent"` `"rebooted"`
validate_certs логическое значение	Если задано значение `false`, SSL-сертификаты при взаимодействии с API AWS проверяться не будут. Настоятельно не рекомендуется задавать validate_certs=false; вместо этого рассмотрите возможность указать aws_ca_bundle. Варианты: `false` `true` ← (по умолчанию)
wait логическое значение	Дождаться результата операции с кластером кэша перед возвратом. Варианты: `false` `true` ← (по умолчанию)
zone строка	Зона доступности EC2, в которой будет создан кластер кэша.

Примечания

Примечание

Внимание: В модулях переменные окружения и файлы конфигурации считываются из контекста «хоста» Ansible, а не из контекста «контроллера». Поэтому может потребоваться явно скопировать файлы на «хост». В плагинах поиска и подключения переменные окружения и файлы конфигурации считываются из контекста «контроллера» Ansible, а не из контекста «хоста».
Используемый Ansible AWS SDK (boto3) также может считывать значения по умолчанию для учетных данных и других параметров, например региона, из файлов конфигурации в контексте «хоста» Ansible (обычно ~/.aws/credentials). Дополнительные сведения см. по адресу https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.

Примеры

# Note: These examples do not set authentication details, see the AWS Guide for details.

- name: Basic example
  community.aws.elasticache:
    name: "test-please-delete"
    state: present
    engine: memcached
    cache_engine_version: 1.4.14
    node_type: cache.m3.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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/aws/elasticache_module.html