amazon.aws.rds_instance_info 模块 – 获取一个或多个 RDS 实例的信息

注意

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

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

要安装它，请使用：ansible-galaxy collection install amazon.aws。您需要其他要求才能使用此模块，请参阅 需求 获取详细信息。

要在剧本中使用它，请指定：amazon.aws.rds_instance_info。

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 之后的一个版本中移除。
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_instance_identifier 别名：id 字符串	RDS 实例的唯一标识符。
debug_botocore_endpoint_logs 布尔值	使用 botocore.endpoint 日志记录器来解析在任务期间进行的唯一（而不是总计）"resource:action" API 调用，并将集合输出到任务结果中的 resource_actions 密钥。使用 aws_resource_action 回调函数将输出到剧本期间进行的总列表。 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量也可使用。 选项 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 之后的一个版本中移除。
filters 字典	指定要描述的一个或多个数据库实例的过滤器。请参见 https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.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 和 security_token 选项互斥。
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 之后的发行版中删除。
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 选项互斥。 在 3.2.0 版本中添加了 aws_session_token 和 session_token 别名，在 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 之后的发行版中删除。
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: Get information about an instance
  amazon.aws.rds_instance_info:
    db_instance_identifier: new-database
  register: new_database_info

- name: Get all RDS instances
  amazon.aws.rds_instance_info:

返回值

常见的返回值已在 此处 记录，以下是此模块特有的字段

键	描述
instances 复杂类型	RDS 实例列表 返回：始终返回
allocated_storage 整数	分配给数据库的存储量（以 GB 为单位）。 返回：始终返回 示例：10
auto_minor_version_upgrade 布尔值	是否自动执行次要版本升级。 返回：始终返回 示例：true
availability_zone 字符串	数据库所在的可用区。 返回：始终返回 示例："us-west-2b"
backup_retention_period 整数	保留备份的天数。 返回：始终返回 示例：7
ca_certificate_identifier 字符串	CA 证书的 ID。 返回：始终返回 示例："rds-ca-2015"
copy_tags_to_snapshot 布尔值	是否应将数据库标签复制到快照。 返回：始终返回 示例：false
db_instance_arn 字符串	数据库实例的 ARN。 返回：始终返回 示例："arn:aws:rds:us-west-2:123456789012:db:helloworld-rds"
db_instance_class 字符串	数据库实例的实例类别。 返回：始终返回 示例："db.t3.small"
db_instance_identifier 字符串	数据库实例标识符。 返回：始终返回 示例："helloworld-rds"
db_instance_port 整数	数据库实例使用的端口。 返回：始终返回 示例：0
db_instance_status 字符串	数据库实例的状态。 返回：始终返回 示例："available"
db_name 字符串	数据库的名称。 返回：始终返回 示例："management"
db_parameter_groups 复杂类型	数据库参数组列表。 返回：始终返回
db_parameter_group_name 字符串	数据库参数组的名称。 返回：始终返回 示例："psql-pg-helloworld"
parameter_apply_status 字符串	是否已应用参数组。 返回：始终返回 示例："in-sync"
db_security_groups 列表 / 元素=字符串	数据库实例使用的安全组列表。 返回：始终返回 示例：[]
db_subnet_group 复杂类型	子网组列表。 返回：始终返回
db_subnet_group_description 字符串	DB 子网组的描述。 返回：始终返回 示例："My database subnet group"
db_subnet_group_name 字符串	数据库子网组的名称。 返回：始终返回 示例："my-subnet-group"
subnet_group_status 字符串	子网组状态。 返回：始终返回 示例："Complete"
subnets 复杂类型	子网组中的子网列表。 返回：始终返回
subnet_availability_zone 复杂类型	子网的可用区。 返回：始终返回
name 字符串	可用区的名称。 返回：始终返回 示例："us-west-2c"
subnet_identifier 字符串	子网 ID。 返回：始终返回 示例："subnet-abcd1234"
subnet_status 字符串	子网状态。 返回：始终返回 示例："Active"
vpc_id 字符串	子网组的 VPC ID。 返回：始终返回 示例："vpc-abcd1234"
dbi_resource_id 字符串	AWS 区域唯一的、不可变的 DB 实例标识符。 返回：始终返回 示例："db-AAAAAAAAAAAAAAAAAAAAAAAAAA"
deletion_protection 布尔值 在 community.aws 3.3.0 中添加	如果 DB 实例启用了删除保护，则为 True，否则为 False。 返回：始终返回 示例：false
domain_memberships 列表 / 元素=字符串	域成员资格列表。 返回：始终返回 示例：[]
endpoint 复杂类型	数据库端点 返回：始终返回
address 字符串	数据库端点地址。 返回：始终返回 示例："helloworld-rds.ctrqpe3so1sf.us-west-2.rds.amazonaws.com"
hosted_zone_id 字符串	Route 53 托管区域 ID。 返回：始终返回 示例："Z1PABCD0000000"
port 整数	数据库端点端口。 返回：始终返回 示例：5432
engine 字符串	数据库引擎。 返回：始终返回 示例："postgres"
engine_version 字符串	数据库引擎版本。 返回：始终返回 示例："9.5.10"
iam_database_authentication_enabled 布尔值	是否启用了通过 IAM 进行数据库身份验证。 返回：始终返回 示例：false
instance_create_time 字符串	创建实例的日期和时间。 返回：始终返回 示例："2017-10-10T04:00:07.434000+00:00"
iops 整数	DB 实例的预配 IOPS 值。 返回：始终返回 示例：1000
kms_key_id 字符串	KMS 密钥 ID。 返回：始终返回 示例："arn:aws:kms:us-west-2:123456789012:key/abcd1234-0000-abcd-1111-0123456789ab"
latest_restorable_time 字符串	数据库可使用时间点恢复还原到的最新时间。 返回：始终返回 示例： "2018-05-17T00:03:56+00:00"
license_model 字符串	许可证模型。 返回：始终返回 示例： "postgresql-license"
master_username 字符串	数据库管理员用户名。 返回：始终返回 示例： "dbadmin"
monitoring_interval 整数	为数据库实例收集增强型监控指标的时间间隔（以秒为单位）。 返回：始终返回 示例：0
multi_az 布尔值	是否启用多可用区。 返回：始终返回 示例：false
option_group_memberships 复杂类型	选项组列表。 返回：始终返回
option_group_name 字符串	选项组名称。 返回：始终返回 示例： "default:postgres-9-5"
status 字符串	选项组的状态。 返回：始终返回 示例："in-sync"
pending_modified_values 复杂类型	待应用的修改值。 返回：始终返回
performance_insights_enabled 布尔值	性能洞察是否启用。 返回：始终返回 示例：false
preferred_backup_window 字符串	首选备份窗口。 返回：始终返回 示例： "04:00-05:00"
preferred_maintenance_window 字符串	首选维护窗口。 返回：始终返回 示例： "mon:05:00-mon:05:30"
publicly_accessible 布尔值	数据库是否公开访问。 返回：始终返回 示例：false
read_replica_db_instance_identifiers 列表 / 元素=字符串	数据库实例只读副本列表。 返回：始终返回 示例：[]
storage_encrypted 布尔值	存储是否已加密。 返回：始终返回 示例：true
storage_type 字符串	数据库实例的存储类型。 返回：始终返回 示例： "gp2"
tags 复杂类型	数据库实例使用的标签。 返回：始终返回
vpc_security_groups 复杂类型	VPC 安全组列表。 返回：始终返回
status 字符串	VPC 安全组的状态。 返回：始终返回 示例： "active"
vpc_security_group_id 字符串	VPC 安全组ID。 返回：始终返回 示例： "sg-abcd1234"

作者

• Will Thames (@willthames)

• Michael De La Rue (@mikedlr)

相关链接

• 问题追踪
• 代码仓库
• 通信