community.aws.rds_param_group – управление группами параметров RDS

Примечание

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

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

Для использования в книге задач укажите: community.aws.rds_param_group.

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

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

Обзор

Создаёт, изменяет и удаляет группы параметров RDS.

Требования

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

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 для проверки SSL-сертификатов. Используется только для модулей на основе boto3. Примечание: Файл сертификатов CA считывается со стороны модуля и может потребоваться явно скопировать с контроллера, если запуск не происходит локально.
aws_config словарь		Словарь для изменения конфигурации botocore. Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Для модулей boto используется только ключ 'user_agent'. См. http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto для получения дополнительной информации о конфигурации 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
debug_botocore_endpoint_logs булево	Варианты: нет ← да	Используйте логирование botocore.endpoint для анализа уникальных (а не общих) API-вызовов «ресурс:действие» во время выполнения задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода в общий список, созданный во время выполнения книги задач. Также можно использовать переменную среды ANSIBLE_DEBUG_BOTOCORE_LOGS.
description строка		Описание группы параметров базы данных. Задается только при добавлении новой группы.
ec2_url строка		URL для подключения к облаку EC2 или Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она существует. псевдонимы: aws_endpoint_url, endpoint_url
engine строка		Тип базы данных для этой группы. Пожалуйста, используйте следующую команду для получения списка всех поддерживаемых типов баз данных и соответствующих версий. # aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" Требуется для state=present.
immediate булево	Варианты: нет да	Необходимо ли применить изменения немедленно или после следующей перезагрузки связанных экземпляров. псевдонимы: apply_immediately
name строка / обязательно		Идентификатор группы параметров базы данных.
params словарь		Карта имён параметров и их значений. Числовые значения могут быть представлены как K для кило (1024), M для мега (1024^2), G для гига (1024^3) или T для тера (1024^4), и эти значения будут преобразованы в соответствующие числа перед настройкой в группе параметров. псевдонимы: parameters
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
purge_tags булево	Варианты: нет ← да	Удалить теги, которые отсутствуют в списке `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. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Если установлен параметр profile, этот параметр игнорируется. Одновременное использование параметров security_token и profile устарело и будет сделано взаимоисключающими после 2022-06-01. псевдонимы: aws_security_token, access_token
state строка / обязательно	Варианты: present absent	Указывает, должна ли группа присутствовать или отсутствовать.
tags словарь		Словарь тегов для прикрепления к группе параметров.
validate_certs булево	Варианты: нет да ←	При значении "нет" для версий boto >= 2.6.0 валидация SSL-сертификатов не выполняется.

Примечания

Примечание

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

Примеры

- name: Add or change a parameter group, in this case setting auto_increment_increment to 42 * 1024
  community.aws.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

- name: Remove a parameter group
  community.aws.rds_param_group:
      state: absent
      name: norwegian-blue

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

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

Ключ	Возвращаемое значение	Описание
db_parameter_group_arn строка	при состоянии present	ARN группы параметров базы данных
db_parameter_group_family строка	при состоянии present	Семейство групп параметров базы данных, с которым совместима данная группа параметров базы данных.
db_parameter_group_name строка	при состоянии present	Имя группы параметров базы данных
description строка	при состоянии present	Описание группы параметров базы данных
errors список / элементы=строка	при состоянии present	Список ошибок при попытке изменить не изменяемые параметры
tags словарь	при состоянии present	Словарь тегов

Авторы

Scott Anderson (@tastychutney)
Will Thames (@willthames)

© 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/rds_param_group_module.html