Spec-Zone.ru › Ansible 2.5

elasticache_parameter_group - Управление группами параметров кэша в Amazon Elasticache.

Новая версия 2.3.

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

Обзор

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

Требования

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

  • boto
  • boto3
  • botocore
  • 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
description
Описание, заданное пользователем, для группы параметров кэша.
ec2_url По умолчанию:
None
URL для подключения к EC2 или облаку Eucalyptus (по умолчанию модуль использует адреса EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковое имеется.
group_family
    Варианты:
  • memcached1.4
  • redis2.6
  • redis2.8
  • redis3.2
Имя семейства групп параметров кэша, с которым может использоваться группа параметров кэша. Требуется при создании группы параметров кэша.
name
обязательно
Название, заданное пользователем, для группы параметров кэша.
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_token
(добавлено в 1.6)
По умолчанию:
None
Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN.

Псевдонимы: access_token
state
обязательно
    Варианты:
  • present
  • absent
  • reset
Идемпотентные действия, которые будут создавать/изменять, удалять или сбрасывать группу параметров кэша по мере необходимости.
validate_certs
(добавлено в 1.5)
    Варианты:
  • no
  • да ←
Если установлено в "нет", сертификаты SSL не будут проверены для версий boto >= 2.6.0.
values По умолчанию:
None
Словарь параметров, заданных пользователем, для сброса или изменения группы параметров кэша.

Примечания

Примечание

  • Если параметры не заданы в модуле, следующие переменные среды могут быть использованы в порядке убывания приоритета 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.
---
- hosts: localhost
  connection: local
  tasks:
    - name: 'Create a test parameter group'
      elasticache_parameter_group:
        name: 'test-param-group'
        group_family: 'redis3.2'
        description: 'This is a cache parameter group'
        state: 'present'
    - name: 'Modify a test parameter group'
      elasticache_parameter_group:
        name: 'test-param-group'
        values:
          activerehashing: yes
          client-output-buffer-limit-normal-hard-limit: 4
        state: 'present'
    - name: 'Reset all modifiable parameters for the test parameter group'
      elasticache_parameter_group:
        name: 'test-param-group'
        state: reset
    - name: 'Delete a test parameter group'
      elasticache_parameter_group:
        name: 'test-param-group'
        state: 'absent'

Возвращаемые значения

Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:

Ключ Возвращаемое значение Описание
changed
bool
всегда
если группа параметров кэша изменилась

Пример:
{'changed': True}
elasticache
dict
всегда
информация о группе параметров кэша и метаданные ответа

Пример:
{'cache_parameter_group': {'cache_parameter_group_family': 'redis3.2', 'description': 'начальное описание', 'cache_parameter_group_name': 'test-please-delete'}, 'response_metadata': {'retry_attempts': 0, 'http_status_code': 200, 'http_headers': {'date': 'Пн, 06 февр. 2017 22:14:08 GMT', 'x-amzn-requestid': '947291f9-ecb9-11e6-85bd-3baa4eca2cc1', 'content-length': '562', 'content-type': 'text/xml'}, 'request_id': '947291f9-ecb9-11e6-85bd-3baa4eca2cc1'}}


Статус

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

Автор

  • Слоун Хертел (@s-hertel)

Подсказка

Если вы заметите какие-либо проблемы в этом документе, вы можете отредактировать этот документ для его улучшения.

© 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_parameter_group_module.html

Spec-Zone.ru

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