amazon.aws.rds_cluster_info 模块 – 获取一个或多个 RDS 集群信息

注意

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

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

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

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

amazon.aws 5.0.0 中的新增功能

概要

• 获取一个或多个 RDS 集群信息。

• 此模块最初在 3.2.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 保持一致，aws_access_key_id 别名在 5.1.0 版本中添加。 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_cluster_identifier 别名：cluster_id、id、cluster_name 字符串	用户提供的 DB 集群标识符。 如果指定此参数，则仅返回来自特定 DB 集群的信息。
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 字符串	连接到非默认 AWS 端点的 URL。虽然这可用于连接到其他与 AWS 兼容的服务，但 amazon.aws 和 community.aws 集合仅针对 AWS 进行了测试。 也可以按优先级递减的顺序使用 AWS_URL 或 EC2_URL 环境变量。 ec2_url 和 s3_url 别名已被弃用，将在 2024-12-01 之后的一个版本中移除。 EC2_URL 环境变量的支持已被弃用，将在 2024-12-01 之后的一个版本中移除。
filters 字典	指定要描述的一个或多个 DB 集群的筛选器。请参阅 https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBClusters.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 info of all existing DB clusters
  amazon.aws.rds_cluster_info:
  register: _result_cluster_info

- name: Get info on a specific DB cluster
  amazon.aws.rds_cluster_info:
    cluster_id: "{{ cluster_id }}"
  register: _result_cluster_info

- name: Get info all DB clusters with specific engine
  amazon.aws.rds_cluster_info:
    engine: "aurora"
  register: _result_cluster_info

返回值

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

键	描述
clusters 列表 / 元素=字符串	RDS 集群列表。 返回：始终
activity_stream_status 字符串	数据库活动流的状态。 返回：成功 示例："stopped"
allocated_storage 整数	分配的存储大小（以 GB 为单位）。由于 Aurora 存储大小不是固定的，因此对于 Aurora 数据库引擎，此值始终为 1。 返回：成功 示例：1
associated_roles 列表 / 元素=字符串	与 DB 集群关联的 AWS Identity and Access Management (IAM) 角色的字典列表。每个字典包含 role_arn 和角色的状态。 返回：成功 示例：[]
auto_minor_version_upgrade 布尔值	指定在维护期间是否自动将次要引擎升级应用于 DB 集群。 返回：始终 示例：true
availability_zones 列表 / 元素=字符串	DB 集群中可以创建实例的可用区列表。 返回：成功 示例：["us-east-1c", "us-east-1a", "us-east-1e"]
backup_retention_period 整数	保留自动 DB 快照的天数。 返回：成功 示例：1
cluster_create_time 字符串	创建 DB 集群的 UTC 时间。 返回：成功 示例："2018-06-29T14:08:58.491000+00:00"
copy_tags_to_snapshot 布尔值	指定是否将标签从 DB 集群复制到 DB 集群的快照。 返回：成功 示例：false
cross_account_clone 布尔值	指定 DB 集群是否是不同 AWS 账户拥有的 DB 集群的克隆。 返回：成功 示例：false
db_cluster_arn 字符串	DB 集群的 Amazon 资源名称 (ARN)。 返回：成功 示例："arn:aws:rds:us-east-1:123456789012:cluster:rds-cluster-demo"
db_cluster_identifier 字符串	用户提供的 DB 集群标识符（小写）。 返回：成功 示例："rds-cluster-demo"
db_cluster_members 列表 / 元素=字符串	包含有关集群中实例信息的字典列表。每个字典包含 db_instance_identifier、is_cluster_writer（布尔值）、db_cluster_parameter_group_status 和 promotion_tier（整数）。 返回：成功 示例：[]
db_cluster_parameter_group 字符串	与 DB 集群关联的参数组。 返回：成功 示例："default.aurora5.6"
db_cluster_resource_id 字符串	DB 集群的 AWS 区域唯一、不可变的标识符。 返回：成功 示例："cluster-D2MEQDN3BQNXDF74K6DQJTHASU"
db_subnet_group 字符串	与 DB 集群关联的子网组的名称。 返回：成功 示例："default"
deletion_protection 布尔值	指示 DB 集群是否启用了删除保护。启用删除保护后，无法删除数据库。 返回：成功 示例：false
domain_memberships 列表 / 元素=字符串	与 DB 集群关联的 Active Directory 域成员资格记录。 返回：成功 示例：[]
earliest_restorable_time 字符串	可以使用 point-in-time restore 将数据库恢复到的最早时间。 返回：成功 示例："2018-06-29T14:09:34.797000+00:00"
endpoint 字符串	DB 集群主实例的连接端点。 返回：成功 示例："rds-cluster-demo.cluster-cvlrtwiennww.us-east-1.rds.amazonaws.com"
engine 字符串	DB 集群的数据库引擎。 返回：成功 示例："aurora"
engine_mode 字符串	DB 集群的数据库引擎模式。 返回：成功 示例："provisioned"
engine_version 字符串	数据库引擎版本。 返回：成功 示例："5.6.10a"
hosted_zone_id 字符串	创建托管区域时 Amazon Route 53 分配的 ID。 返回：成功 示例："Z2R2ITUGPM61AM"
http_endpoint_enabled 布尔值	指示 Aurora Serverless DB 集群的 HTTP 端点是否启用的值。 返回：成功 示例：false
iam_database_authentication_enabled 布尔值	IAM 账户是否可以映射到数据库账户。 返回：成功 示例：false
latest_restorable_time 字符串	可以使用 point-in-time restore 将数据库恢复到的最新时间。 返回：成功 示例："2018-06-29T14:09:34.797000+00:00"
master_username 字符串	DB 集群的主用户名。 返回：成功 示例："username"
multi_az 布尔值	DB 集群是否在多个可用区中具有实例。 返回：成功 示例：false
port 整数	数据库引擎正在侦听的端口。 返回：成功 示例：3306
preferred_backup_window 字符串	可以进行系统维护的 UTC 每周时间范围。 返回：成功 示例："10:18-10:48"
preferred_maintenance_window 字符串	可以进行系统维护的 UTC 每周时间范围。 返回：成功 示例："tue:03:23-tue:03:53"
read_replica_identifiers 列表 / 元素=字符串	与 DB 集群关联的只读副本 ID 字符串列表。 返回：成功 示例：[]
reader_endpoint 字符串	DB 集群的只读端点。 返回：成功 示例："rds-cluster-demo.cluster-ro-cvlrtwiennww.us-east-1.rds.amazonaws.com"
status 字符串	DB 集群的状态。 返回：成功 示例："available"
storage_encrypted 布尔值	DB 集群是否存储加密。 返回：成功 示例：false
tag_list 列表 / 元素=字典	由键值对组成的标签列表。 返回：成功 示例： [{"key": "Created_By", "value": "Ansible_rds_cluster_integration_test"}]
tags 字典	键值对字典。 返回：成功 示例： {"Name": "rds-cluster-demo"}
vpc_security_groups 复杂类型	数据库集群安全组及其状态的列表。 返回：成功
status 字符串	安全组的状态。 返回：成功 示例： "active"
vpc_security_group_id 字符串	集群的安全组。 返回：成功 示例： "sg-12345678"

作者

• Alina Buzachis (@alinabuzachis)

资源链接

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