Spec-Zone.ru › Ansible

Модуль amazon.aws.rds_option_group_info – модуль rds_option_group_info

Примечание

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

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

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

Чтобы использовать модуль в сценарии, укажите: amazon.aws.rds_option_group_info.

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

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

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

  • Собирает сведения о группах параметров RDS.
  • Этот модуль впервые появился в community.aws в выпуске 2.1.0.

Требования

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

  • 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 SDK botocore.

aws_ca_bundle

путь

Путь к пакету сертификатов CA, используемому для проверки SSL-сертификатов.

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

aws_config

словарь

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

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

debug_botocore_endpoint_logs

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

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

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

Варианты:

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

endpoint_url

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

строка

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

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

engine_name

строка

Фильтрует список групп параметров, оставляя только группы, связанные с указанной СУБД.

По умолчанию: ""

major_engine_version

строка

Фильтрует список групп параметров, оставляя только группы, связанные с указанной версией СУБД.

Если этот параметр указан, необходимо также указать engine_name.

По умолчанию: ""

marker

строка

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

Допустимые значения — от 20 до 100.

max_records

целое число

Максимальное количество записей, включаемых в ответ.

По умолчанию: 100

option_group_name

строка

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

Нельзя указывать одновременно с engine_name или major_engine_version.

По умолчанию: ""

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.

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 SDK botocore.

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 являются взаимоисключающими.

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.

Примеры

# Note: These examples do not set authentication details, see the AWS Guide for details.

- name: List an option group
  amazon.aws.rds_option_group_info:
    option_group_name: test-mysql-option-group
  register: option_group

- name: List all the option groups
  amazon.aws.rds_option_group_info:
    region: ap-southeast-2
    profile: production
  register: option_group

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

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

Ключ

Описание

changed

boolean

Значение True, если получение списка групп параметров RDS выполнено успешно.

Возвращается: всегда

Пример: false

result

complex

Доступные группы параметров RDS.

Возвращается: всегда

allows_vpc_and_non_vpc_instance_memberships

boolean

Указывает, можно ли применить эту группу параметров как к экземплярам в VPC, так и к экземплярам вне VPC.

Возвращается: всегда

Пример: false

engine_name

string

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

Возвращается: всегда

Пример: "mysql"

major_engine_version

string

Указывает основную версию движка, связанную с этой группой параметров.

Возвращается: всегда

Пример: "5.6"

option_group_arn

string

Amazon Resource Name (ARN) группы параметров.

Возвращается: всегда

Пример: "arn:aws:rds:ap-southeast-2:123456789012:og:ansible-test-option-group"

option_group_description

string

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

Возвращается: всегда

Пример: "test mysql option group"

option_group_name

string

Указывает название группы параметров.

Возвращается: всегда

Пример: "test-mysql-option-group"

options

complex

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

Возвращается: всегда

db_security_group_memberships

complex

Если для параметра требуется доступ к порту, эта группа безопасности БД разрешает доступ к нему.

Возвращается: всегда

Пример: "list"

db_security_group_name

string

Название группы безопасности БД.

Возвращается: всегда

Пример: "mydbsecuritygroup"

status

string

Статус группы безопасности БД.

Возвращается: всегда

Пример: "available"

option_description

string

Описание параметра.

Возвращается: всегда

Пример: "Innodb Memcached for MySQL"

option_name

string

Название параметра.

Возвращается: всегда

Пример: "MEMCACHED"

option_settings

complex

Название параметра.

Возвращается: всегда

allowed_values

string

Допустимые значения настройки параметра.

Возвращается: всегда

Пример: "1-2048"

apply_type

string

Тип параметра, специфичный для движка БД.

Возвращается: всегда

Пример: "STATIC"

data_type

string

Тип данных настройки параметра.

Возвращается: всегда

Пример: "INTEGER"

default_value

string

Значение настройки параметра по умолчанию.

Возвращается: всегда

Пример: "1024"

description

string

Описание настройки параметра.

Возвращается: всегда

Пример: "Verbose level for memcached."

is_collection

boolean

Указывает, является ли настройка параметра частью коллекции.

Возвращается: всегда

Пример: true

is_modifiable

boolean

Логическое значение, которое при значении true указывает, что настройку параметра можно изменить относительно значения по умолчанию.

Возвращается: всегда

Пример: true

name

string

Название параметра, настройки которого можно задать.

Возвращается: всегда

Пример: "INNODB_API_ENABLE_MDL"

value

string

Текущее значение настройки параметра.

Возвращается: всегда

Пример: "0"

permanent

boolean

Указывает, является ли этот параметр постоянным.

Возвращается: всегда

Пример: true

persistent

boolean

Указывает, является ли этот параметр сохраняемым.

Возвращается: всегда

Пример: true

port

integer

При необходимости — порт, настроенный для использования этим параметром.

Возвращается: всегда

Пример: 11211

vpc_security_group_memberships

list / elements=dictionary

Если для параметра требуется доступ к порту, эта группа безопасности VPC разрешает доступ к нему.

Возвращается: всегда

status

string

Статус группы безопасности VPC.

Возвращается: всегда

Пример: "available"

vpc_security_group_id

string

Название группы безопасности VPC.

Возвращается: всегда

Пример: "sg-0cd636a23ae76e9a4"

tags

dictionary

Теги, связанные с группой параметров RDS.

Возвращается: всегда

Пример: {"Ansible": "Test"}

vpc_id

string

Если это поле задано, группу параметров можно применять только к экземплярам, находящимся в указанной здесь VPC.

Возвращается: всегда

Пример: "vpc-bf07e9d6"

Авторы

  • Alina Buzachis (@alinabuzachis)

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

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

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

Spec-Zone.ru

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