Модуль amazon.aws.rds_engine_versions_info – Описывает свойства определённых версий СУБД
Примечание
Этот модуль входит в коллекцию amazon.aws (версия 8.2.1).
Возможно, эта коллекция уже установлена, если вы используете пакет 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.26.0
- botocore >= 1.29.0
Параметры
Параметр | Комментарии |
|---|---|
access_key aliases: aws_access_key_id, aws_access_key, ec2_access_key string | Идентификатор ключа доступа AWS. См. документацию AWS для получения дополнительной информации о токенах доступа https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Переменные среды Параметры aws_access_key и profile являются взаимоисключающими. Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для согласованности с AWS botocore SDK. Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды |
aws_ca_bundle path | Расположение пакета CA, используемого при проверке SSL-сертификатов. Переменная среды |
aws_config dictionary | Словарь для изменения конфигурации botocore. Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
db_parameter_group_family string | Имя семейства групп параметров RDS, для которого нужно вернуть подробные сведения. |
debug_botocore_endpoint_logs boolean | Использовать Переменная среды Варианты:
|
default_only boolean | Указывает, следует ли возвращать только версию по умолчанию указанного движка или комбинацию движка и основной версии. Варианты:
|
endpoint_url aliases: ec2_url, aws_endpoint_url, s3_url string | URL для подключения вместо конечных точек AWS по умолчанию. Хотя это может использоваться для подключения к другим совместимым с AWS службам, коллекции amazon.aws и community.aws тестируются только на AWS. Переменные среды Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01. Поддержка переменной среды |
engine string | Движок базы данных, для которого нужно вернуть сведения о версии. Варианты:
|
engine_version string | Конкретная версия движка базы данных, для которой нужно вернуть подробные сведения. |
filters dictionary | Фильтр, указывающий одну или несколько версий движка DB для описания. См. https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBEngineVersions.html. |
profile aliases: aws_profile string | Именованный профиль AWS для использования при аутентификации. См. документацию AWS для получения дополнительной информации об именованных профилях https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Переменная среды Параметр profile является взаимоисключающим с параметрами aws_access_key, aws_secret_key и security_token. |
region aliases: aws_region, ec2_region string | Регион AWS для использования. Для глобальных служб, таких как IAM, Route53 и CloudFront, region игнорируется. Переменные среды См. документацию Amazon AWS для получения дополнительной информации http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. Псевдоним Поддержка переменной среды |
secret_key aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key string | Секретный ключ доступа AWS. Дополнительную информацию о маркерах доступа см. в документации AWS https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды Параметры secret_key и profile взаимоисключающие. Алиас aws_secret_access_key был добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore. Алиас ec2_secret_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды |
session_token aliases: aws_session_token, security_token, aws_security_token, access_token string | Токен сессии AWS STS для использования с временными учетными данными. Дополнительную информацию о маркерах доступа см. в документации AWS https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды Параметры security_token и profile взаимоисключающие. Алиасы aws_session_token и session_token были добавлены в релизе 3.2.0, а параметр был переименован из security_token в session_token в релизе 6.0.0. Алиасы security_token, aws_security_token и access_token устарели и будут удалены в релизе после 2024-12-01. Поддержка переменных среды |
validate_certs boolean | При установке в Настройка validate_certs=false крайне не рекомендуется, в качестве альтернативы следует установить aws_ca_bundle. Выбор:
|
Примечания
Примечание
- Внимание: Для модулей переменные среды и конфигурационные файлы считываются из контекста хоста Ansible, а не из контекста контроллера. Поэтому файлы могут потребоваться явно скопировать на хост. Для плагинов поиска и подключения переменные среды и конфигурационные файлы считываются из контекста контроллера Ansible, а не из контекста хоста.
- AWS SDK (boto3), используемый Ansible, также может считывать значения по умолчанию для учетных данных и других настроек, таких как регион, из своих конфигурационных файлов в контексте хоста 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 |
Набор символов по умолчанию для новых экземпляров этой версии движка. Возвращается: успех Пример: |
|
engine string |
Имя движка базы данных. Возвращается: успех |
|
engine_version string |
Номер версии движка базы данных. Возвращается: успех |
|
exportable_log_types list / elements=string |
Типы журналов, которые доступны для экспорта в CloudWatch Logs для движка базы данных. Возвращается: успех |
|
image complex |
Образ EC2 Возвращается: успех |
|
image_id string |
Значение, указывающее ID 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. Возвращено: success Пример: |
|
supported_character_sets list / elements=dictionary |
Список кодировок, поддерживаемых этим движком для параметра CharacterSetName операции CreateDBInstance. Возвращено: success |
|
character_set_description string |
Описание кодировки. Возвращено: success |
|
character_set_name string |
Название кодировки. Возвращено: success |
|
supported_engine_modes list / elements=string |
Список поддерживаемых режимов движка DB. Возвращено: success |
|
supported_feature_names list / elements=string |
Список функций, поддерживаемых движком DB. Возвращено: success Пример: |
|
supported_nchar_character_sets list / elements=dictionary |
Список кодировок, поддерживаемых движком Oracle DB. Возвращено: success |
|
character_set_description string |
Описание кодировки. Возвращено: success |
|
character_set_name string |
Название кодировки. Возвращено: success |
|
supported_timezones list / elements=dictionary |
Список часовых поясов, поддерживаемых этим движком для параметра Timezone действия CreateDBInstance. Возвращено: success Пример: |
|
supports_babelfish boolean |
Указывает, поддерживает ли версия движка Babelfish для Aurora PostgreSQL. Возвращено: success |
|
supports_certificate_rotation_without_restart boolean |
Указывает, поддерживает ли версия движка вращение серверного сертификата без перезагрузки экземпляра DB. Возвращено: success |
|
supports_global_databases boolean |
Указывает, можно ли использовать глобальные базы данных Aurora с определенной версией движка DB. Возвращено: success |
|
supports_integrations boolean |
Указывает, поддерживает ли версия движка DB интеграции zero-ETL с Amazon Redshift. Возвращено: success |
|
supports_local_write_forwarding boolean |
Указывает, поддерживает ли версия движка DB переадресацию операций записи с экземпляров DB-ридера на экземпляр DB-райтера в кластере DB. Возвращено: success |
|
supports_log_exports_to_cloudwatchLogs boolean |
Указывает, поддерживает ли версия движка экспорт типов журналов, указанных ExportableLogTypes, в CloudWatch Logs. Возвращено: success |
|
supports_parallel_query boolean |
Указывает, можно ли использовать параллельный запрос Aurora с определенной версией движка DB. Возвращено: success |
|
supports_read_replica boolean |
Указывает, поддерживает ли версия движка базы данных копии для чтения. Возвращено: success |
|
Теги словарь |
Словарь пар ключ-значение. Возвращается: успешно Пример: |
|
Допустимые цели обновления список / элементы=словарь |
Список версий движка, до которых можно обновить данную версию базы данных. Возвращается: успешно Пример: |
Ссылки на коллекции
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/amazon/aws/rds_engine_versions_info_module.html