amazon.aws.rds_engine_versions_info 模块 – 描述特定数据库引擎版本的属性

注意

此模块是 amazon.aws 集合(版本 9.0.0)的一部分。

如果您正在使用 ansible 包,则可能已安装此集合。它不包含在 ansible-core 中。要检查是否已安装,请运行 ansible-galaxy collection list

要安装它,请使用:ansible-galaxy collection install amazon.aws。您需要更多要求才能使用此模块,请参阅 要求 以获取详细信息。

要在 Playbook 中使用它,请指定:amazon.aws.rds_engine_versions_info

amazon.aws 7.6.0 中的新增功能

概要

  • 获取有关特定数据库引擎版本的信息。

要求

执行此模块的主机需要以下要求。

  • python >= 3.6

  • boto3 >= 1.28.0

  • botocore >= 1.31.0

参数

参数

注释

access_key

别名:aws_access_key_id, aws_access_key, ec2_access_key

字符串

AWS 访问密钥 ID。

有关访问令牌的更多信息,请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys

还可以按优先级顺序使用 AWS_ACCESS_KEY_IDAWS_ACCESS_KEYEC2_ACCESS_KEY 环境变量。

aws_access_keyprofile 选项是互斥的。

aws_access_key_id 别名在 5.1.0 版本中添加,以与 AWS botocore SDK 保持一致。

ec2_access_key 别名已弃用,将在 2024-12-01 之后的版本中删除。

EC2_ACCESS_KEY 环境变量的支持已弃用,将在 2024-12-01 之后的版本中删除。

aws_ca_bundle

路径

用于验证 SSL 证书的 CA 捆绑包的位置。

还可以使用 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 记录器来解析任务期间发出的唯一(而非总计)"resource:action" API 调用,将该集合输出到任务结果中的 resource_actions 键。使用 aws_resource_action 回调输出到 Playbook 期间制作的总列表。

还可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。

选项

  • false ← (默认)

  • true

default_only

布尔值

指定是仅返回指定引擎的默认版本,还是返回引擎和主版本组合。

选项

  • false ← (默认)

  • true

endpoint_url

别名:ec2_url, aws_endpoint_url, s3_url

字符串

连接到默认 AWS 端点而不是连接到默认 AWS 端点的 URL。虽然这可以用于连接到其他与 AWS 兼容的服务,但仅针对 AWS 测试 amazon.aws 和 community.aws 集合。

还可以按优先级顺序使用 AWS_URLEC2_URL 环境变量。

ec2_urls3_url 别名已弃用,将在 2024-12-01 之后的版本中删除。

EC2_URL 环境变量的支持已弃用,将在 2024-12-01 之后的版本中删除。

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_keyaws_secret_keysecurity_token 选项互斥。

region

别名:aws_region, ec2_region

字符串

要使用的 AWS 区域。

对于 IAM、Route53 和 CloudFront 等全局服务,将忽略 region

还可以使用 AWS_REGIONEC2_REGION 环境变量。

有关更多信息,请参阅 Amazon AWS 文档 http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region

ec2_region 别名已弃用,将在 2024-12-01 之后的版本中删除

EC2_REGION 环境变量的支持已弃用,将在 2024-12-01 之后的版本中移除。

secret_key

别名:aws_secret_access_key, aws_secret_key, ec2_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_KEYAWS_SECRET_KEYEC2_SECRET_KEY 环境变量,优先级依次降低。

secret_keyprofile 选项互斥。

为了与 AWS botocore SDK 保持一致,在 5.1.0 版本中添加了 aws_secret_access_key 别名。

ec2_secret_key 别名已弃用,将在 2024-12-01 之后的版本中移除。

EC2_SECRET_KEY 环境变量的支持已弃用,将在 2024-12-01 之后的版本中移除。

session_token

别名:aws_session_token, security_token, aws_security_token, access_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_TOKENAWS_SECURITY_TOKENEC2_SECURITY_TOKEN 环境变量,优先级依次降低。

security_tokenprofile 选项互斥。

别名 aws_session_tokensession_token 在 3.2.0 版本中添加,参数在 6.0.0 版本中从 security_token 重命名为 session_token

security_tokenaws_security_tokenaccess_token 别名已弃用,将在 2024-12-01 之后的版本中移除。

EC2_SECRET_KEYAWS_SECURITY_TOKEN 环境变量的支持已弃用,将在 2024-12-01 之后的版本中移除。

validate_certs

布尔值

当设置为 false 时,与 AWS API 通信时将不验证 SSL 证书。

强烈建议不要设置 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

列表 / 元素=字符串

RDS 引擎版本列表。

返回: 始终

create_time

字符串

数据库引擎版本的创建时间。

返回: 成功

custom_db_engine_version_manifest

字符串

JSON 字符串,列出了 RDS Custom 用于创建自定义引擎版本 (CEV) 的安装文件和参数。

返回: 成功

database_installation_files_s3_bucket_name

字符串

包含数据库安装文件的 Amazon S3 存储桶的名称。

返回: 成功

database_installation_files_s3_prefix

字符串

包含数据库安装文件的 Amazon S3 目录。

返回: 成功

db_engine_description

字符串

数据库引擎的描述。

返回: 成功

db_engine_media_type

字符串

一个值,指示基于使用操作的 AMI 的源媒体提供商。

返回: 成功

db_engine_version_arn

字符串

自定义引擎版本的 ARN。

返回: 成功

db_engine_version_description

字符串

数据库引擎版本的描述。

返回: 成功

db_parameter_group_family

字符串

数据库引擎的数据库参数组系列的名称。

返回: 成功

default_character_set

字典

此引擎版本的新实例的默认字符集。

返回: 成功

示例: {"character_set_description": "Unicode 5.0 UTF-8 通用字符集", "character_set_name": "AL32UTF8"}

engine

字符串

数据库引擎的名称。

返回: 成功

engine_version

字符串

数据库引擎的版本号。

返回: 成功

exportable_log_types

列表 / 元素=字符串

数据库引擎可用于导出到 CloudWatch Logs 的日志类型。

返回: 成功

image

复杂类型

EC2 镜像

返回: 成功

image_id

字符串

一个值,指示 AMI 的 ID。

返回: 成功

status

字符串

一个值,指示自定义引擎版本 (CEV) 的状态。

返回: 成功

kms_key_id

字符串

加密 CEV 的 Amazon Web Services KMS 密钥标识符。

返回: 成功

major_engine_version

字符串

CEV 的主要引擎版本。

返回: 成功

status

字符串

数据库引擎版本的状态,可以是可用或已弃用。

返回: 成功

supported_ca_certificate_identifiers

列表 / 元素=字符串

受支持的 CA 证书标识符列表。

返回: 成功

示例: ["rds-ca-2019", "rds-ca-ecc384-g1", "rds-ca-rsa4096-g1", "rds-ca-rsa2048-g1"]

supported_character_sets

列表 / 元素=字典

此引擎支持的字符集列表,用于 CreateDBInstance 操作的 CharacterSetName 参数。

返回: 成功

character_set_description

字符串

字符集的描述。

返回: 成功

character_set_name

字符串

字符集的名称。

返回: 成功

supported_engine_modes

列表 / 元素=字符串

受支持的数据库引擎模式列表。

返回: 成功

supported_feature_names

列表 / 元素=字符串

数据库引擎支持的功能列表。

返回: 成功

示例: ["Comprehend", "Lambda", "s3Export", "s3Import", "SageMaker"]

supported_nchar_character_sets

列表 / 元素=字典

Oracle 数据库引擎支持的字符集列表。

返回: 成功

character_set_description

字符串

字符集的描述。

返回: 成功

character_set_name

字符串

字符集的名称。

返回: 成功

supported_timezones

列表 / 元素=字典

此引擎支持的时区列表,用于 CreateDBInstance 操作的 Timezone 参数。

返回: 成功

示例: [{"TimezoneName": "xxx"}]

supports_babelfish

布尔值

指示该引擎版本是否支持 Aurora PostgreSQL 的 Babelfish。

返回: 成功

supports_certificate_rotation_without_restart

布尔值

指示该引擎版本是否支持在不重启数据库实例的情况下轮换服务器证书。

返回: 成功

supports_global_databases

布尔值

指示是否可以将 Aurora 全球数据库与特定的数据库引擎版本一起使用。

返回: 成功

supports_integrations

布尔值

指示该数据库引擎版本是否支持与 Amazon Redshift 的零 ETL 集成。

返回: 成功

supports_local_write_forwarding

布尔值

指示该数据库引擎版本是否支持将读取器数据库实例的写入操作转发到数据库群集中的写入器数据库实例。

返回: 成功

supports_log_exports_to_cloudwatchLogs

布尔值

指示该引擎版本是否支持将 ExportableLogTypes 指定的日志类型导出到 CloudWatch Logs。

返回: 成功

supports_parallel_query

布尔值

指示是否可以将 Aurora 并行查询与特定的数据库引擎版本一起使用。

返回: 成功

supports_read_replica

布尔值

指示数据库引擎版本是否支持只读副本。

返回: 成功

tags

字典

键值对的字典。

返回: 成功

示例: {"some": "tag"}

valid_upgrade_target

列表 / 元素=字典

可以升级到此数据库引擎版本的引擎版本列表。

返回: 成功

示例: [{"auto_upgrade": false, "description": "Aurora PostgreSQL (与 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)