Spec-Zone.ru › Ansible

Модуль amazon.aws.rds_engine_versions_info — описывает свойства определённых версий движков БД

Примечание

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

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

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

Чтобы использовать этот модуль в плейбуке, укажите: amazon.aws.rds_engine_versions_info.

Добавлено в amazon.aws 7.6.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 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, сведения о котором нужно получить.

debug_botocore_endpoint_logs

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

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

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

Варианты:

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

default_only

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

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

Варианты:

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

endpoint_url

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

строка

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

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

engine

строка

Движок базы данных, сведения о версиях которого нужно получить.

Варианты:

  • "aurora-mysql"
  • "aurora-postgresql"
  • "custom-oracle-ee"
  • "db2-ae"
  • "db2-se"
  • "mariadb"
  • "mysql"
  • "oracle-ee"
  • "oracle-ee-cdb"
  • "oracle-se2"
  • "oracle-se2-cdb"
  • "postgres"
  • "sqlserver-ee"
  • "sqlserver-se"
  • "sqlserver-ex"
  • "sqlserver-web"

engine_version

строка

Конкретная версия движка базы данных, сведения о которой нужно получить.

filters

словарь

Фильтр, задающий одну или несколько версий движка БД для описания. См. https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBEngineVersions.html.

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

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: List all of the available parameter group families for the Aurora PostgreSQL DB engine
  amazon.aws.rds_engine_versions_info:
    engine: aurora-postgresql

- name: List all of the available parameter group families for the Aurora PostgreSQL DB engine on a specific version
  amazon.aws.rds_engine_versions_info:
    engine: aurora-postgresql
    engine_version: 16.1

- name: Get default engine version for DB parameter group family postgres16
  amazon.aws.rds_engine_versions_info:
    engine: postgres
    default_only: true
    db_parameter_group_family: postgres16

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

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

Ключ

Описание

db_engine_versions

list / elements=string

Список версий движка RDS.

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

create_time

string

Время создания версии движка БД.

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

custom_db_engine_version_manifest

string

Строка JSON со списком установочных файлов и параметров, которые RDS Custom использует для создания пользовательской версии движка (CEV).

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

database_installation_files_s3_bucket_name

string

Имя бакета Amazon S3, содержащего установочные файлы базы данных.

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

database_installation_files_s3_prefix

string

Каталог Amazon S3, содержащий установочные файлы базы данных.

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

db_engine_description

string

Описание движка базы данных.

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

db_engine_media_type

string

Значение, указывающее поставщика исходного носителя AMI на основе операции использования.

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

db_engine_version_arn

string

ARN пользовательской версии движка.

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

db_engine_version_description

string

Описание версии движка базы данных.

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

db_parameter_group_family

string

Имя семейства групп параметров БД для движка базы данных.

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

default_character_set

dictionary

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

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

Пример: {"character_set_description": "Unicode 5.0 UTF-8 Universal character set", "character_set_name": "AL32UTF8"}

engine

string

Имя движка базы данных.

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

engine_version

string

Номер версии движка базы данных.

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

exportable_log_types

list / elements=string

Типы журналов, доступные для экспорта движком базы данных в CloudWatch Logs.

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

image

complex

Образ EC2

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

image_id

string

Значение, указывающее идентификатор AMI.

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

status

string

Значение, указывающее состояние пользовательской версии движка (CEV).

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

kms_key_id

string

Идентификатор ключа Amazon Web Services KMS для зашифрованной CEV.

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

major_engine_version

string

Основная версия движка для CEV.

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

status

string

Состояние версии движка БД: доступна или устарела.

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

supported_ca_certificate_identifiers

list / elements=string

Список идентификаторов поддерживаемых сертификатов CA.

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

Пример: ["rds-ca-2019", "rds-ca-ecc384-g1", "rds-ca-rsa4096-g1", "rds-ca-rsa2048-g1"]

supported_character_sets

list / elements=dictionary

Список наборов символов, поддерживаемых этим движком для параметра CharacterSetName операции CreateDBInstance.

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

character_set_description

string

Описание набора символов.

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

character_set_name

string

Имя набора символов.

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

supported_engine_modes

list / elements=string

Список поддерживаемых режимов движка БД.

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

supported_feature_names

list / elements=string

Список функций, поддерживаемых движком БД.

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

Пример: ["Comprehend", "Lambda", "s3Export", "s3Import", "SageMaker"]

supported_nchar_character_sets

list / elements=dictionary

Список наборов символов, поддерживаемых движком Oracle DB.

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

character_set_description

string

Описание набора символов.

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

character_set_name

string

Имя набора символов.

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

supported_timezones

list / elements=dictionary

Список часовых поясов, поддерживаемых этим движком для параметра Timezone действия CreateDBInstance.

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

Пример: [{"TimezoneName": "xxx"}]

supports_babelfish

boolean

Указывает, поддерживает ли версия движка Babelfish для Aurora PostgreSQL.

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

supports_certificate_rotation_without_restart

boolean

Указывает, поддерживает ли версия движка смену сертификата сервера без перезагрузки экземпляра БД.

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

supports_global_databases

boolean

Указывает, можно ли использовать глобальные базы данных Aurora с определённой версией движка БД.

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

supports_integrations

boolean

Указывает, поддерживает ли версия движка интеграции zero-ETL с Amazon Redshift.

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

supports_local_write_forwarding

boolean

Указывает, поддерживает ли версия движка БД пересылку операций записи от читающих экземпляров БД к записывающему экземпляру БД в кластере БД.

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

supports_log_exports_to_cloudwatchLogs

boolean

Указывает, поддерживает ли версия движка экспорт типов журналов, указанных в ExportableLogTypes, в CloudWatch Logs.

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

supports_parallel_query

boolean

Указывает, можно ли использовать параллельные запросы Aurora с определённой версией движка БД.

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

supports_read_replica

boolean

Указывает, поддерживает ли версия движка базы данных реплики для чтения.

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

tags

dictionary

Словарь пар ключ-значение.

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

Пример: {"some": "tag"}

valid_upgrade_target

list / elements=dictionary

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

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

Пример: [{"auto_upgrade": false, "description": "Aurora PostgreSQL (Compatible with PostgreSQL 15.5)", "engine": "aurora-postgresql", "engine_version": "15.5", "is_major_version_upgrade": false, "supported_engine_modes": ["provisioned"], "supports_babelfish": true, "supports_global_databases": true, "supports_integrations": false, "supports_local_write_forwarding": true, "supports_parallel_query": false}]

Авторы

  • 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_engine_versions_info_module.html

Spec-Zone.ru

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