rds_param_group – управление группами параметров RDS
Описание
- Создает, изменяет и удаляет группы параметров RDS. Этот модуль зависит от python-boto >= 2.5.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- 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 | |
| debug_botocore_endpoint_logs логический добавлено в 2.8 |
| Использовать регистрирующий модуль botocore.endpoint для парсинга уникальных (а не общих) API-вызовов «ресурс:действие», производимых во время задачи, выводимых в ключ resource_actions результатов задачи. Используйте обратный вызов aws_resource_action для вывода полного списка, созданного во время выполнения плейбука. Также может быть использована переменная окружения ANSIBLE_DEBUG_BOTOCORE_LOGS. |
| description - | Описание группы параметров базы данных. Устанавливается только при добавлении новой группы. | |
| ec2_url строка | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется в модулях, где требуется регион. Должен быть указан во всех других модулях, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она существует. | |
| engine - | Тип базы данных для этой группы. Требуется для state=present. Пожалуйста, используйте следующую команду для получения списка всех поддерживаемых баз данных и их соответствующих версий. # aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" | |
| immediate логический |
| Применять изменения немедленно или после следующей перезагрузки связанных экземпляров. псевдонимы: apply_immediately |
| name - / обязательно | Идентификатор группы параметров базы данных. | |
| params - | Карта имен и значений параметров. Числовые значения могут быть представлены как K для кило (1024), M для мега (1024^2), G для гига (1024^3) или T для тера (1024^4), и эти значения будут расширены до соответствующего числа перед установкой в группе параметров. псевдонимы: parameters | |
| profile строка | Использует профиль boto. Работает только с boto >= 2.24.0. | |
| purge_tags логический добавлено в 2.4 |
| Удалить теги, отсутствующие в списке теги. |
| region строка | AWS-регион для использования. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если она существует. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
псевдонимы: aws_region, ec2_region | |
| security_token строка | Секретный токен AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. псевдонимы: access_token | |
| state - / обязательно |
| Указывает, должна ли группа существовать или отсутствовать. |
| tags - добавлено в 2.4 | Словарь тегов для прикрепления к группе параметров. | |
| validate_certs логический |
| При значении «нет» сертификаты SSL не будут проверяться для версий boto >= 2.6.0. |
Примечания
Примечание
- Если параметры не установлены в модуле, могут быть использованы следующие переменные окружения в порядке убывания приоритета
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
Примеры
# Add or change a parameter group, in this case setting auto_increment_increment to 42 * 1024
- rds_param_group:
state: present
name: norwegian-blue
description: 'My Fancy Ex Parrot Group'
engine: 'mysql5.6'
params:
auto_increment_increment: "42K"
tags:
Environment: production
Application: parrot
# Remove a parameter group
- rds_param_group:
state: absent
name: norwegian-blue
Возвращаемые значения
Общие возвращаемые значения описаны в здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| db_parameter_group_arn строка | при state=present | ARN группы параметров базы данных |
| db_parameter_group_family строка | при state=present | Семейство группы параметров базы данных, с которым совместима данная группа параметров базы данных. |
| db_parameter_group_name строка | при state=present | Имя группы параметров базы данных |
| description строка | при state=present | Описание группы параметров базы данных |
| errors список | при state=present | список ошибок при попытке изменения не изменяемых параметров |
| tags словарь | при state=present | словарь тегов |
Статус
- Этот модуль гарантированно не будет содержать обратной несовместимости в будущих изменениях. [stableinterface]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Scott Anderson (@tastychutney)
- Will Thames (@willthames)
Подсказка
Если вы обнаружите какие-либо проблемы в данной документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 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/rds_param_group_module.html