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:action" во время выполнения задачи, выводить набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action, чтобы вывести полный список, созданный во время выполнения playbook. |
| 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 |
| Удалить теги, отсутствующие в списке tags. |
| 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 security token. Если не задан, используется значение переменной окружения 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.9/modules/rds_param_group_module.html
