amazon.aws.rds_instance 模块 – 管理 RDS 实例

注意

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

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

要安装它，请使用：ansible-galaxy collection install amazon.aws。您需要进一步的要求才能使用此模块，请参阅 要求 以了解详细信息。

要在 playbook 中使用它，请指定：amazon.aws.rds_instance。

amazon.aws 5.0.0 中的新增功能

概要

• 创建、修改和删除 RDS 实例。

• 此模块最初在 1.0.0 版本中添加到 community.aws。

要求

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

• 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_ID、AWS_ACCESS_KEY 或 EC2_ACCESS_KEY 环境变量，优先级依次降低。 aws_access_key 和 profile 选项是互斥的。 为了与 AWS botocore SDK 保持一致，在 5.1.0 版本中添加了 aws_access_key_id 别名。 ec2_access_key 别名已弃用，将在 2024-12-01 之后的版本中删除。 对 EC2_ACCESS_KEY 环境变量的支持已弃用，将在 2024-12-01 之后的版本中删除。
allocated_storage 整数	要为数据库实例分配的存储量（以 GiB 为单位）。
allow_major_version_upgrade 布尔值	是否允许主版本升级。 选择 false true
apply_immediately 布尔值	一个值，指定是否应尽快应用使用 new_db_instance_identifier 和 master_user_password 修改实例，而不管 preferred_maintenance_window 设置如何。如果 false，则更改将在下一个维护窗口期间应用。 选择 false ← (默认) true
auto_minor_version_upgrade 布尔值	在维护窗口期间，是否自动将次要版本升级应用于数据库实例。 选择 false true
availability_zone 别名：az，zone 字符串	可以在其中创建数据库实例的 EC2 可用区列表。可在创建实例或从 S3 或快照还原时使用。与 multi_az 互斥。
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。
backup_retention_period 整数	自动备份保留的天数。 当设置为 0 时，将禁用自动备份。（如果数据库实例是读取副本的源，则不适用） 可在创建新实例、从 S3 还原或修改实例时使用。
ca_certificate_identifier 字符串	数据库实例的 CA 证书标识符。
character_set_name 字符串	要与数据库实例关联的字符集。
copy_tags_to_snapshot 布尔值	是否将所有标签从数据库实例复制到该实例的快照。在首次创建数据库实例时，如果未指定，RDS API 默认设置为 false。 选择 false true
creation_source 字符串	如果从模板（现有实例、S3 存储桶或快照）还原，则使用哪个源。 选择 "snapshot" "s3" "instance"
db_cluster_identifier 别名: cluster_id 字符串	要将 Aurora 数据库实例添加到的数据库集群（小写）标识符。标识符必须包含 1 到 63 个字母、数字或连字符，并且第一个字符必须是字母，不能以连字符结尾或包含连续的连字符。
db_instance_class 别名: class, instance_type 字符串	数据库实例的计算和内存容量，例如 db.t3.micro。
db_instance_identifier 别名: instance_id, id 字符串 / 必需	数据库实例（小写）标识符。标识符必须包含 1 到 63 个字母、数字或连字符，并且第一个字符必须是字母，不能以连字符结尾或包含连续的连字符。
db_name 字符串	您的数据库名称。如果未提供名称，Amazon RDS 将不会创建数据库。
db_parameter_group_name 字符串	要与此数据库实例关联的数据库参数组的名称。在创建数据库实例时，如果省略此参数，则使用指定引擎的默认 DBParameterGroup。
db_security_groups 列表 / 元素=字符串	（EC2-Classic 平台）要与此数据库实例关联的数据库安全组的列表。
db_snapshot_identifier 别名: snapshot_identifier, snapshot_id 字符串	当使用 creation_source=snapshot 时，要从中还原的数据库快照的标识符或 ARN。
db_subnet_group_name 别名: subnet_group 字符串	用于数据库实例的数据库子网组名称。
debug_botocore_endpoint_logs 布尔值	使用 botocore.endpoint 日志记录器来解析任务期间进行的唯一（而不是总计）"resource:action" API 调用，并将该集合输出到任务结果中的 resource_actions 键。使用 aws_resource_action 回调来输出剧本期间制作的总列表。 也可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。 选择 false ← (默认) true
deletion_protection 布尔值 在 community.aws 3.3.0 中添加	一个值，指示是否启用了数据库实例的删除保护。启用删除保护后，无法删除数据库。默认情况下，删除保护处于禁用状态。 选择 false true
domain 字符串	要还原实例的 Active Directory 域。
domain_iam_role_name 字符串	在对目录服务进行 API 调用时要使用的 IAM 角色的名称。
enable_cloudwatch_logs_exports 别名: cloudwatch_log_exports 列表 / 元素=字符串	需要启用以导出到 CloudWatch Logs 的日志类型列表。
enable_iam_database_authentication 布尔值	启用将 AWS Identity and Access Management (IAM) 账户映射到数据库账户。如果在创建实例时省略此选项，Amazon RDS 会将其设置为 false。 选择 false true
enable_performance_insights 布尔值	是否为数据库实例启用 Performance Insights。 选择 false true
endpoint_url 别名: ec2_url, aws_endpoint_url, s3_url 字符串	要连接到的 URL，而不是默认的 AWS 端点。虽然这可以用于连接到其他与 AWS 兼容的服务，但 amazon.aws 和 community.aws 集合仅针对 AWS 进行测试。 也可以使用 AWS_URL 或 EC2_URL 环境变量，优先级依次降低。 ec2_url 和 s3_url 别名已弃用，将在 2024-12-01 之后的版本中删除。 对 EC2_URL 环境变量的支持已弃用，将在 2024-12-01 之后的版本中删除。
engine 字符串	要用于此数据库实例的数据库引擎的名称。这是创建实例所必需的。 选择 "aurora" "aurora-mysql" "aurora-postgresql" "mariadb" "mysql" "oracle-ee" "oracle-ee-cdb" "oracle-se2" "oracle-se2-cdb" "postgres" "sqlserver-ee" "sqlserver-se" "sqlserver-ex" "sqlserver-web"
engine_version 字符串	要使用的数据库引擎的版本号。对于 Aurora MySQL，可能是 5.6.10a, 5.7.12。Aurora PostgreSQL 示例，9.6.3
final_db_snapshot_identifier 别名: final_snapshot_identifier 字符串	当 skip_final_snapshot 为 false 时创建的新数据库实例快照的数据库实例快照标识符。
force_failover 布尔值	设置为 true 以通过 MultiAZ 故障转移进行重启。 选择 false true
force_update_password 布尔值	设置为 true 以使用 master_user_password 更新您的实例密码。由于无法比较密码以确定是否需要更新，因此默认将其设置为 false 以允许幂等性。 选择 false ← (默认) true
iam_roles 列表 / 元素=字典 在 community.aws 3.3.0 中添加	要与数据库实例关联的 Amazon Web Services Identity and Access Management (IAM) 角色列表。
feature_name 字符串 / 必需	与 IAM 角色关联的功能的名称。
role_arn 字符串 / 必需	要与数据库实例关联的 IAM 角色的 ARN。
iops 整数	预配置的 IOPS（每秒 I/O 操作）值。仅当 storage_type 设置为 io1 时才设置。
kms_key_id 字符串	加密数据库实例的 AWS KMS 密钥标识符的 ARN。如果要使用拥有用于加密新数据库实例的 KMS 加密密钥的同一个 AWS 账户创建数据库实例，则可以使用 KMS 密钥别名而不是 KMS 加密密钥的 ARN。 如果 storage_encrypted 为 true 并且未提供此选项，则使用默认加密密钥。
license_model 字符串	数据库实例的许可证模型。 有几个选项是 license-included、bring-your-own-license 和 general-public-license。 也可以省略此选项以默认接受值。
master_user_password 别名: password 字符串	主数据库用户的 8-41 个字符的密码。密码可以包含除 /、" 或 @ 之外的任何可打印 ASCII 字符。要修改密码，请使用 force_update_password。使用 apply_immediately 立即更改密码，否则将在下一个维护窗口期间更新密码。
master_username 别名: username 字符串	数据库实例主用户的名称。必须是 1-16 个字母或数字，并以字母开头。
max_allocated_storage 整数	Amazon RDS 可以自动扩展数据库实例存储的上限。
monitoring_interval 整数	以秒为单位的间隔，当收集数据库实例的增强监控指标时。要禁用收集指标，请指定 0。如果最初创建数据库实例时省略此选项，Amazon RDS 默认设置为 0。
monitoring_role_arn 字符串	允许 RDS 将增强监控指标发送到 Amazon CloudWatch Logs 的 IAM 角色的 ARN。
multi_az 布尔值	指定数据库实例是否为 Multi-AZ 部署。与 availability_zone 互斥。 选择 false true
multi_tenant 布尔值 在 amazon.aws 9.0.0 中添加	指定是使用多租户配置还是单租户配置（默认）。 此参数仅适用于 RDS for Oracle 容器数据库 (CDB) 引擎。 您在请求中指定的数据库引擎必须支持多租户配置。 如果在创建数据库实例期间启用多租户配置，则以后无法修改它。 选择 false true
new_db_instance_identifier 别名: new_instance_id, new_id 字符串	重命名数据库实例时，新的数据库实例（小写）标识符。该标识符必须包含 1 到 63 个字母、数字或连字符，并且第一个字符必须是字母，不能以连字符结尾或包含连续的连字符。使用 apply_immediately 立即重命名，否则将在下一个维护窗口期间更新。
option_group_name 字符串	要与数据库实例关联的选项组。
performance_insights_kms_key_id 字符串	用于加密性能分析数据的 AWS KMS 密钥标识符（ARN、名称或别名）。
performance_insights_retention_period 整数	保留性能分析数据的时间长度（以天为单位）。有效值为 7 或 731。
port 整数	实例接受连接的端口号。
preferred_backup_window 别名: backup_window 字符串	每日时间范围（以 UTC 为单位），至少 30 分钟，在此期间，如果使用 backup_retention_period 启用了自动备份，则会创建自动备份。该选项必须采用 “hh24:mi-hh24:mi” 格式，并且不得与 preferred_maintenance_window 冲突。
preferred_maintenance_window 别名: maintenance_window 字符串	每周时间范围（以 UTC 为单位），至少 30 分钟，在此期间可以进行系统维护。该选项必须采用 “ddd:hh24:mi-ddd:hh24:mi” 格式，其中 ddd 是 Mon、Tue、Wed、Thu、Fri、Sat、Sun 之一。
processor_features 字典	一个包含 Name 和 Value 键值对的字典，用于指示数据库实例的数据库实例类的 CPU 核心数和每个核心的线程数。名称为 threadsPerCore 和 coreCount。将此选项设置为空字典以使用默认的处理器功能。
coreCount 字符串	CPU 核心数
threadsPerCore 字符串	每个核心的线程数
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 和 security_token 选项互斥。
promotion_tier 整数	一个整数，用于指定在现有主实例发生故障后将 Aurora 副本提升为主实例的顺序。
publicly_accessible 布尔值	指定数据库实例的可访问性选项。值 Vtrue) 指定具有可公开解析的 DNS 名称的面向 Internet 的实例，该名称解析为公共 IP 地址。值 false 指定具有解析为私有 IP 地址的 DNS 名称的内部实例。 选择 false true
purge_cloudwatch_logs_exports 布尔值	设置为 false 以保留任务中未指定且与实例关联的任何已启用的 CloudWatch 日志。 将 enable_cloudwatch_logs_exports 设置为空列表以禁用所有日志。 选择 false true ← (默认)
purge_iam_roles 布尔值 在 community.aws 3.3.0 中添加	设置为 true 以删除任务中未指定且与实例关联的任何 IAM 角色。 选择 false ← (默认) true
purge_security_groups 布尔值 在 community.aws 1.5.0 中添加	设置为 false 以保留任务中未指定且与实例关联的任何已启用的安全组。 可以应用于 vpc_security_group_ids 和 db_security_groups 选择 false true ← (默认)
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 ← (默认)
read_replica 布尔值	设置为 false 以提升只读副本实例，或设置为 true 以创建只读副本实例。创建只读副本时，应将 creation_source 设置为 'instance' 或不提供。source_db_instance_identifier 必须与此选项一起提供。 选择 false true
region 别名: aws_region, ec2_region 字符串	要使用的 AWS 区域。 对于 IAM、Route53 和 CloudFront 等全局服务，将忽略 region。 也可以使用 AWS_REGION 或 EC2_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 之后的版本中删除。
restore_time 字符串	如果使用 creation_source=instance，则表示从源实例还原的 UTC 日期和时间。例如，“2009-09-07T23:45:00Z”。 也可以设置 use_latest_restorable_time=true。 只能提供 use_latest_restorable_time 和 restore_time 中的一个。
s3_bucket_name 字符串	包含用于创建 Amazon 数据库实例的数据的 Amazon S3 存储桶的名称。
s3_ingestion_role_arn 字符串	AWS Identity and Access Management (IAM) 角色的 Amazon 资源名称 (ARN)，该角色授权 Amazon RDS 代表您访问 Amazon S3 存储桶。
s3_prefix 字符串	包含用于创建 Amazon 数据库实例的数据的所有文件名的前缀。如果未指定 SourceS3Prefix 值，则通过使用 Amazon S3 存储桶中的所有文件来创建 Amazon 数据库实例。
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_KEY、AWS_SECRET_KEY 或 EC2_SECRET_KEY 环境变量。 secret_key 和 profile 选项互斥。 为了与 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_TOKEN、AWS_SECURITY_TOKEN 或 EC2_SECURITY_TOKEN 环境变量。 security_token 和 profile 选项是互斥的。 别名 aws_session_token 和 session_token 在 3.2.0 版本中添加，参数在 6.0.0 版本中从 security_token 重命名为 session_token。 别名 security_token、aws_security_token 和 access_token 已弃用，将在 2024-12-01 之后的版本中删除。 对 EC2_SECRET_KEY 和 AWS_SECURITY_TOKEN 环境变量的支持已弃用，将在 2024-12-01 之后的版本中删除。
skip_final_snapshot 布尔值	在删除数据库实例之前是否创建最终数据库实例快照。如果此值为 false，则必须提供 final_db_snapshot_identifier。 选择 false ← (默认) true
source_db_instance_identifier 字符串	当使用 creation_source=instance 创建只读副本或启动时间点数据库实例时，从中还原的源数据库实例的标识符或 ARN。如果源数据库不在同一区域，则应使用 ARN。
source_engine 字符串	用于创建存储在 Amazon S3 存储桶中的文件的数据库引擎的标识符。 选择 "mysql"
source_engine_version 字符串	创建备份文件的数据库版本。
source_region 字符串	从中创建副本的数据库实例的区域。
state 字符串	RDS 实例的期望状态。 state=rebooted 不是幂等的，如果数据库实例已停止，则在重新启动之前，它将使数据库实例处于运行状态并启动它。present 将使数据库实例保持当前运行/停止状态（如果是创建数据库实例，则为运行状态）。 state=running 和 state=started 是同义词，state=rebooted 和 state=restarted 也是同义词。 选择 "present" ← （默认） "absent" "terminated" "running" "started" "stopped" "rebooted" "restarted"
storage_encrypted 布尔值	数据库实例是否已加密。 选择 false true
storage_throughput 整数 在 amazon.aws 5.2.0 中添加	当 storage_type 为 gp3 时，存储吞吐量。 当分配的存储空间低于 400 GB 时，存储吞吐量始终为 125 mb/s。 当分配的存储空间大于或等于 400 GB 时，吞吐量从 500 mb/s 开始。
storage_type 字符串	要与数据库实例关联的存储类型。storage_type 不适用于 Aurora 数据库实例。 选择 "standard" "gp2" "gp3" "io1"
tags 别名: resource_tags 字典	表示要应用于资源的标签的字典。 如果未设置 tags 参数，则不会修改标签。
tde_credential_arn 别名: transparent_data_encryption_arn 字符串	用于关联透明数据加密的密钥库中的 ARN。Oracle 或 SQL Server 数据库实例支持此功能，并且可以与 storage_encrypted 结合使用，但这可能会稍微影响数据库的性能。
tde_credential_password 别名: transparent_data_encryption_password 字符串	用于访问设备的密钥库中给定 ARN 的密码。
timezone 字符串	数据库实例的时区。
use_latest_restorable_time 别名: restore_from_latest 布尔值	是否将数据库实例还原到最新的可还原备份时间。 只能提供 use_latest_restorable_time 和 restore_time 中的一个。 选择 false true
validate_certs 布尔值	当设置为 false 时，与 AWS API 通信时将不会验证 SSL 证书。 强烈建议不要设置 validate_certs=false，作为替代方案，请考虑设置 aws_ca_bundle。 选择 false true ← (默认)
vpc_security_group_ids 列表 / 元素=字符串	要与数据库实例关联的 EC2 VPC 安全组列表。
wait 布尔值	是否等待实例变为可用、停止或删除状态。稍后可能会添加 wait_timeout 选项。在每次调用 API 创建/修改/删除实例后，会使用一个等待器，延迟 60 秒，总共等待 30 次，直到实例达到预期状态（可用/停止/删除）。任务的总时间也可能受到 AWSRetry 的影响，如果实例处于无效状态（例如，您尝试停止它时它正在重新启动），则 AWSRetry 可以帮助稳定实例的操作。如果将此项设置为 false，则任务重试和延迟可能会使您的剧本执行更好地处理主要修改的超时。 选择 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: Create minimal aurora instance in default VPC and default subnet group
  amazon.aws.rds_instance:
    engine: aurora
    db_instance_identifier: ansible-test-aurora-db-instance
    instance_type: db.t3.small
    password: "{{ password }}"
    username: "{{ username }}"
    cluster_id: ansible-test-cluster  # This cluster must exist - see rds_cluster to manage it

- name: Create a DB instance using the default AWS KMS encryption key
  amazon.aws.rds_instance:
    id: test-encrypted-db
    state: present
    engine: mariadb
    storage_encrypted: true
    db_instance_class: db.t3.medium
    username: "{{ username }}"
    password: "{{ password }}"
    allocated_storage: "{{ allocated_storage }}"

- name: Remove the DB instance without a final snapshot
  amazon.aws.rds_instance:
    id: "{{ instance_id }}"
    state: absent
    skip_final_snapshot: true

- name: Remove the DB instance with a final snapshot
  amazon.aws.rds_instance:
    id: "{{ instance_id }}"
    state: absent
    final_snapshot_identifier: "{{ snapshot_id }}"

- name: Add a new security group without purge
  amazon.aws.rds_instance:
    id: "{{ instance_id }}"
    state: present
    vpc_security_group_ids:
      - sg-0be17ba10c9286b0b
    purge_security_groups: false
  register: result

# Add IAM role to db instance
- name: Create IAM policy
  amazon.aws.iam_managed_policy:
    policy_name: "my-policy"
    policy: "{{ lookup('file','files/policy.json') }}"
    state: present
  register: iam_policy

- name: Create IAM role
  community.aws.iam_role:
    assume_role_policy_document: "{{ lookup('file','files/assume_policy.json') }}"
    name: "my-role"
    state: present
    managed_policy: "{{ iam_policy.policy.arn }}"
  register: iam_role

- name: Create DB instance with added IAM role
  amazon.aws.rds_instance:
    id: "my-instance-id"
    state: present
    engine: postgres
    engine_version: 14.2
    username: "{{ username }}"
    password: "{{ password }}"
    db_instance_class: db.m6g.large
    allocated_storage: "{{ allocated_storage }}"
    iam_roles:
      - role_arn: "{{ iam_role.arn }}"
        feature_name: 's3Export'

- name: Remove IAM role from DB instance
  amazon.aws.rds_instance:
    id: "my-instance-id"
    state: present
    purge_iam_roles: true

# Modify the DB instance type without waiting for a maintenance window
- name: Modify an RDS Instance
  amazon.aws.rds_instance:
    db_instance_identifier: mydbinstance123
    instance_class: db.t2.small
    apply_immediately: true
  register: rds_instance

# Restore DB instance from snapshot
- name: Create a snapshot and wait until completion
  amazon.aws.rds_instance_snapshot:
    instance_id: 'my-instance-id'
    snapshot_id: 'my-new-snapshot'
    state: present
    wait: true
  register: snapshot

- name: Restore DB from snapshot
  amazon.aws.rds_instance:
    id: 'my-restored-db'
    creation_source: snapshot
    snapshot_identifier: 'my-new-snapshot'
    engine: mariadb
    state: present
  register: restored_db

返回值

通用返回值记录在 此处，以下是此模块独有的字段

allocated_storage	描述
allocated_storage 整数	以千兆字节为单位的已分配存储大小。对于 Aurora 数据库引擎，此值始终为 1。 返回: 始终 示例: 20
associated_roles 列表 / 元素=字符串	当前关联的角色列表。 返回: 始终 示例: []
auto_minor_version_upgrade 布尔值	auto_minor_version_upgrade 返回: 始终 是否在维护窗口期间将次要引擎升级自动应用于数据库实例。
示例: true 字符串	availability_zone 返回: 始终 数据库实例的可用区。
backup_retention_period 整数	自动备份保留的天数。 返回: 始终 示例: 1
ca_certificate_identifier 字符串	数据库实例的 CA 证书标识符。 返回: 始终 示例: "rds-ca-2015"
copy_tags_to_snapshot 布尔值	copy_tags_to_snapshot 返回: 始终 是否将标签从数据库实例复制到数据库实例的快照。
db_instance_arn 字符串	数据库实例的 Amazon 资源名称 (ARN)。 返回: 始终 示例: "arn:aws:rds:us-east-1:123456789012:db:ansible-test"
db_instance_class 字符串	数据库实例的计算和内存容量类的名称。 返回: 始终 示例: "db.m5.large"
db_instance_identifier 字符串	数据库实例的标识符。 返回: 始终 示例: "ansible-test"
db_instance_port 整数	数据库实例侦听的端口。 返回: 始终 示例: 0
db_instance_status 字符串	此数据库的当前状态。 返回: 始终 示例: "stopped"
db_parameter_groups 复杂	应用于此数据库实例的数据库参数组的列表。 返回: 始终
db_parameter_group_name 字符串	DP 参数组的名称。 返回: 始终 示例: "default.mariadb10.0"
parameter_apply_status 字符串	参数更新的状态。 返回: 始终 示例: "in-sync"
db_security_groups 列表 / 元素=字符串	与此数据库实例关联的数据库安全组的列表。 返回: 始终 示例: []
db_subnet_group 复杂	与数据库实例关联的子网组。 返回: 始终
db_subnet_group_description 字符串	数据库子网组的描述。 返回: 始终 示例: "default"
db_subnet_group_name 字符串	数据库子网组的名称。 返回: 始终 示例: "default"
subnet_group_status 字符串	数据库子网组的状态。 返回: 始终 示例: "Complete"
子网 复杂	子网元素的列表。 返回: 始终
subnet_availability_zone 复杂	子网的可用区。 返回: 始终
名称 字符串	可用区的名称。 返回: 始终 示例: "us-east-1c"
subnet_identifier 字符串	子网的 ID。 返回: 始终 示例: "subnet-12345678"
subnet_status 字符串	子网的状态。 返回: 始终 示例: "Active"
vpc_id 字符串	数据库子网组的 VpcId。 返回: 始终 示例: "vpc-12345678"
dbi_resource_id 字符串	数据库实例的 AWS 区域唯一、不可变的标识符。 返回: 始终 示例: "db-UHV3QRNWX4KB6GALCIGRML6QFA"
deletion_protection 布尔值 在 community.aws 3.3.0 中添加	如果数据库实例启用了删除保护，则为true，否则为False。 返回: 始终 是否将标签从数据库实例复制到数据库实例的快照。
domain_memberships 列表 / 元素=字符串	与数据库实例关联的 Active Directory 域成员资格记录。 返回: 始终 示例: []
endpoint 复杂	连接端点。 返回: 始终
address 字符串	数据库实例的 DNS 地址。 返回: 始终 示例: "ansible-test.cvlrtwiennww.us-east-1.rds.amazonaws.com"
hosted_zone_id 字符串	当您创建托管区域时，Amazon Route 53 分配的 ID。 返回: 始终 示例: "ZTR2ITUGPA61AM"
port 整数	数据库引擎正在侦听的端口。 返回: 始终 示例: 3306
engine 字符串	数据库引擎版本。 返回: 始终 示例: "mariadb"
engine_version 字符串	数据库引擎版本。 返回: 始终 示例: "10.0.35"
iam_database_authentication_enabled 布尔值	是否启用了 AWS Identity and Access Management (IAM) 帐户到数据库帐户的映射。 返回: 始终 是否将标签从数据库实例复制到数据库实例的快照。
instance_create_time 字符串	创建数据库实例的日期和时间。 返回: 始终 示例: "2018-07-04T16:48:35.332000+00:00"
kms_key_id 字符串	当 storage_encrypted 为 true 时，加密的数据库实例的 AWS KMS 密钥标识符。 返回值: 当 storage_encrypted 为 true 时 示例: "arn:aws:kms:us-east-1:123456789012:key/70c45553-ad2e-4a85-9f14-cfeb47555c33"
latest_restorable_time 字符串	可以使用时间点还原将数据库还原到的最新时间。 返回: 始终 示例: "2018-07-04T16:50:50.642000+00:00"
license_model 字符串	此数据库实例的许可证模型信息。 返回: 始终 示例: "general-public-license"
master_username 字符串	数据库实例的主用户名。 返回: 始终 示例: "test"
max_allocated_storage 整数	Amazon RDS 可以自动扩展数据库实例存储的上限。 返回值: 当存在最大分配存储时。 示例: 100
monitoring_interval 整数	为数据库实例收集增强监控指标的时间间隔（以秒为单位）。 0 表示禁用收集增强监控指标。 返回: 始终 示例: 0
multi_az 布尔值	数据库实例是否为多可用区部署。 返回: 始终 是否将标签从数据库实例复制到数据库实例的快照。
multi_tenant 布尔值 在 amazon.aws 9.0.0 中添加	指定是使用多租户配置还是单租户配置（默认）。 返回值: 对于 Oracle 容器数据库 (CDB) 引擎和 boto3_version == “1.28.80” 是否将标签从数据库实例复制到数据库实例的快照。
option_group_memberships 复杂	此数据库实例的选项组会员资格列表。 返回: 始终
option_group_name 字符串	实例所属的选项组的名称。 返回: 始终 示例: "default:mariadb-10-0"
status 字符串	数据库实例选项组会员资格的状态。 返回: 始终 示例: "in-sync"
pending_modified_values 复杂	数据库实例的待定更改。 返回: 始终
performance_insights_enabled 布尔值	如果为数据库实例启用了 Performance Insights，则为 true，否则为 false。 返回: 始终 是否将标签从数据库实例复制到数据库实例的快照。
preferred_backup_window 字符串	如果启用了自动备份，则在其中创建自动备份的每日时间范围。 返回: 始终 示例: "07:01-07:31"
preferred_maintenance_window 字符串	可以进行系统维护的每周时间范围（以 UTC 为单位）。 返回: 始终 示例: "sun:09:31-sun:10:01"
publicly_accessible 布尔值	对于具有可公开解析的 DNS 名称的面向 Internet 的实例，为True，对于 DNS 名称解析为私有 IP 地址的内部实例，为 False。 返回: 始终 是否在维护窗口期间将次要引擎升级自动应用于数据库实例。
read_replica_db_instance_identifiers 列表 / 元素=字符串	与此数据库实例关联的只读副本的标识符。 返回: 始终 示例: []
storage_encrypted 布尔值	数据库实例是否已加密。 返回: 始终 是否将标签从数据库实例复制到数据库实例的快照。
storage_type 字符串	要与数据库实例关联的存储类型。 返回: 始终 示例: "standard"
tags 复杂	与数据库实例关联的标签字典。 返回: 始终
vpc_security_groups 复杂	数据库实例所属的 VPC 安全组元素的列表。 返回: 始终
status 字符串	VPC 安全组的状态。 返回: 始终 示例: "active"
vpc_security_group_id 字符串	VPC 安全组的名称。 返回: 始终 示例: "sg-12345678"

作者

• Sloane Hertel (@s-hertel)

集合链接

• 问题跟踪器
• 存储库（源代码）
• 交流