Spec-Zone.ru › Ansible

Модуль amazon.aws.rds_cluster_param_group — управление группами параметров кластера RDS

Примечание

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

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

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

Чтобы использовать его в плейбуке, укажите: amazon.aws.rds_cluster_param_group.

Добавлено в amazon.aws 7.6.0

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

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

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

Требования

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

  • python >= 3.6
  • boto3 >= 1.35.0
  • botocore >= 1.35.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

путь

Путь к пакету центров сертификации, который используется для проверки SSL-сертификатов.

Также можно использовать переменную окружения AWS_CA_BUNDLE.

aws_config

словарь

Словарь для изменения конфигурации botocore.

Параметры описаны в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

db_parameter_group_family

строка

Имя семейства групп параметров кластера RDS.

Группа параметров кластера RDS может быть связана только с одним семейством групп параметров кластера RDS и применяться только к кластеру RDS, работающему с ядром СУБД и его версией, совместимыми с этим семейством групп параметров кластера RDS.

Чтобы перечислить все доступные семейства групп параметров для ядра СУБД, используйте модуль amazon.aws.rds_engine_versions_info.

Семейство групп параметров кластера RDS является неизменяемым и не может быть изменено при обновлении группы параметров кластера RDS. См. https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html

Обязательно для state=present.

debug_botocore_endpoint_logs

логическое значение

Используйте регистратор botocore.endpoint для анализа уникальных (а не общего количества) вызовов API "resource:action", выполненных во время задачи, и вывода набора в ключ resource_actions в результатах задачи. Используйте обработчик обратного вызова aws_resource_action для вывода общего списка вызовов, выполненных во время плейбука.

Также можно использовать переменную окружения ANSIBLE_DEBUG_BOTOCORE_LOGS.

Варианты:

  • false ← (по умолчанию)
  • true

description

строка

Описание группы параметров кластера RDS.

Обязательно для state=present.

endpoint_url

псевдонимы: aws_endpoint_url

строка

URL для подключения вместо конечных точек AWS по умолчанию. Его можно использовать для подключения к другим сервисам, совместимым с AWS, однако коллекции amazon.aws и community.aws тестируются только с AWS.

Также можно использовать переменную окружения AWS_URL.

name

строка / обязательный

Имя группы параметров кластера RDS, которую нужно создать, изменить или удалить.

parameters

список / элементы=словарь

Список параметров для обновления.

apply_method

строка / обязательный

Указывает, когда применять обновления параметров.

Варианты:

  • "immediate"
  • "pending-reboot"

parameter_name

строка / обязательный

Указывает имя параметра.

parameter_value

строка / обязательный

Указывает значение параметра.

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.

purge_tags

логическое значение

Если задано значение purge_tags=true и задан параметр tags, существующие теги ресурса будут удалены, чтобы их набор точно соответствовал указанному в параметре tags.

Если параметр tags не задан, теги не будут изменены, даже если purge_tags=True.

Ключи тегов, начинающиеся с aws:, зарезервированы Amazon и не могут быть изменены. Поэтому они игнорируются при обработке параметра purge_tags. Дополнительную информацию см. в документации Amazon: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions.

Варианты:

  • false
  • true ← (по умолчанию)

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.

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

строка

Указывает, должна ли группа параметров кластера RDS существовать или отсутствовать.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

tags

псевдонимы: resource_tags

словарь

Словарь с тегами, которые нужно применить к ресурсу.

Если параметр tags не задан, теги не будут изменены.

validate_certs

логическое значение

Если установлено значение false, SSL-сертификаты не будут проверяться при обмене данными с API AWS.

Настоятельно не рекомендуется устанавливать validate_certs=false; вместо этого рассмотрите возможность указать aws_ca_bundle.

Варианты:

  • false
  • true ← (по умолчанию)

Примечания

Примечание

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

Примеры

- name: Add or change a parameter group, in this case setting authentication_timeout to 200
  amazon.aws.rds_cluster_param_group:
      state: present
      name: test-cluster-group
      description: 'My test RDS cluster group'
      db_parameter_group_family: 'mysql5.6'
      parameters:
          - parameter_name: authentication_timeout
            parameter_value: "200"
            apply_method: immediate
      tags:
          Environment: production
          Application: parrot

- name: Remove a parameter group
  amazon.aws.rds_cluster_param_group:
      state: absent
      name: test-cluster-group

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

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

Ключ

Описание

db_cluster_parameter_group

сложный тип

Словарь со всей информацией о группе параметров кластера RDS.

Возвращается: при успехе

db_cluster_parameter_group_arn

строка

Имя ресурса Amazon (ARN) группы параметров кластера RDS.

Возвращается: при условии state=present

Пример: "arn:aws:rds:us-west-2:123456789012:cluster-pg:ansible-test-123456789012-redhat-cluster-param-group"

db_cluster_parameter_group_name

строка

Имя группы параметров кластера RDS.

Возвращается: при условии state=present

Пример: "ansible-test-123456789012-redhat-cluster-param-group"

db_parameter_group_family

строка

Имя семейства групп параметров RDS, с которым совместима эта группа параметров кластера RDS.

Возвращается: при условии state=present

Пример: "postgres16"

description

строка

Описание этой группы параметров кластера RDS, заданное пользователем.

Возвращается: при условии state=present

Пример: "RDS cluster param group"

tags

словарь

Словарь тегов.

Возвращается: при условии state=present

Пример: {"another": "tag", "resource_prefix": "ansible-test-53268383-redhat", "some": "tag"}

Авторы

  • Aubin Bikouo (@abikouo)

Ссылки на коллекцию

  • Отслеживание проблем
  • Репозиторий (исходный код)
  • Связь

© 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/amazon/aws/rds_cluster_param_group_module.html

Spec-Zone.ru

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