amazon.aws.rds_snapshot_info 模块 – 获取一个或多个 RDS 快照的信息

注意

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

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

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

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

amazon.aws 5.0.0 中的新增功能

概要

• 获取一个或多个 RDS 快照的信息。这些可以是非集群快照或集群数据库 (Aurora) 的快照。

• 如果未传递标识符参数，或者传递了其中一个集群参数，则可以获取 Aurora 快照信息。

• 此模块最初添加到 community.aws 的 1.0.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_ID、AWS_ACCESS_KEY 或 EC2_ACCESS_KEY 环境变量。 aws_access_key 和 profile 选项是互斥的。 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_cluster_identifier 字符串	用于查找快照的 RDS 集群名称。 与 db_snapshot_identifier、db_instance_identifier、db_cluster_snapshot_identifier 互斥。
db_cluster_snapshot_identifier 字符串	RDS 集群快照的名称。 与 db_instance_identifier、db_snapshot_identifier、db_cluster_identifier 互斥。
db_instance_identifier 字符串	用于查找快照的 RDS 实例名称。 与 db_snapshot_identifier、db_cluster_identifier、db_cluster_snapshot_identifier 互斥。
db_snapshot_identifier 别名：snapshot_name 字符串	RDS（非集群）快照的名称。 与 db_instance_identifier、db_cluster_identifier、db_cluster_snapshot_identifier 互斥。
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之后的一个版本中移除。
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之后的一个版本中移除。
snapshot_type 字符串	要查找的快照类型。 默认情况下，将返回自动和手动快照。 选项 "automated" "manual" "shared" "public"
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 snapshot
  amazon.aws.rds_snapshot_info:
    db_snapshot_identifier: snapshot_name
  register: new_database_info

- name: Get all RDS snapshots for an RDS instance
  amazon.aws.rds_snapshot_info:
    db_instance_identifier: helloworld-rds-master

返回值

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

键	描述
cluster_snapshots 复杂类型	集群快照列表。 返回：传递集群参数时。
allocated_storage 整数	分配的存储大小（以GiB为单位）。 返回：始终返回 示例： 1
availability_zones 列表 / 元素=字符串	DB集群快照中实例可以恢复到的可用区(AZ)列表。 返回：始终返回 示例： ["ca-central-1a", "ca-central-1b"]
cluster_create_time 字符串	创建DB集群的时间。 返回：始终返回 示例： "2018-05-17T00:13:40.223000+00:00"
db_cluster_identifier 字符串	此DB集群快照创建自的DB集群的DB集群标识符。 返回：始终返回 示例： "test-aurora-cluster"
db_cluster_resource_id 字符串	此DB集群快照创建自的DB集群的资源ID。 返回：始终返回 示例： "cluster-ABCDEFGHIJKLMNOPQRSTUVWXYZ"
db_cluster_snapshot_arn 字符串	DB集群快照的Amazon资源名称(ARN)。6 返回：始终返回 示例： "arn:aws:rds:ca-central-1:123456789012:cluster-snapshot:test-aurora-snapshot"
db_cluster_snapshot_identifier 字符串	DB集群快照的标识符。 返回：始终返回 示例： "test-aurora-snapshot"
engine 字符串	此DB集群快照的数据库引擎名称。 返回：始终返回 示例： "aurora"
engine_mode 字符串	此DB集群快照的数据库引擎的引擎模式。 返回：始终返回 示例： "provisioned"
engine_version 字符串	此DB集群快照的数据库引擎版本。 返回：始终返回 示例： "5.6.10a"
iam_database_authentication_enabled 布尔值	是否启用了Amazon Web Services身份和访问管理(IAM)帐户到数据库帐户的映射。 返回：始终返回 示例： false
kms_key_id 字符串	加密的DB集群快照的Amazon Web Services KMS密钥标识符。 返回：当storage_encrypted为true时 示例： "arn:aws:kms:us-west-2:123456789012:key/abcd1234-1234-aaaa-0000-1234567890ab"
license_model 字符串	此DB集群快照的许可证模型信息。 返回：始终返回 示例： "aurora"
master_username 字符串	此DB集群快照的主用户名。 返回：始终返回 示例： "shertel"
percent_progress 整数	已传输的估计数据的百分比。 返回：始终返回 示例： 0
port 整数	快照拍摄时DB集群侦听的端口。 返回：始终返回 示例： 0
snapshot_create_time 字符串	拍摄快照的时间。 返回：始终返回 示例： "2018-05-17T00:23:23.731000+00:00"
snapshot_type 字符串	DB集群快照的类型。 返回：始终返回 示例： "manual"
status 字符串	此DB集群快照的状态。 返回：始终返回 示例： "creating"
storage_encrypted 布尔值	指示DB集群快照是否已加密。 返回：始终返回 示例： true
tags 复杂类型	快照的标签。 返回：快照未共享时。
vpc_id 字符串	与DB集群快照关联的VPC ID。 返回：始终返回 示例： "vpc-abcd1234"
snapshots 复杂类型	非集群快照列表。 返回：未传递集群参数时。
allocated_storage 整数	分配的存储大小（以GiB为单位）。 返回：始终返回 示例： 10
availability_zone 字符串	DB快照拍摄时DB实例所在的可用区名称。 返回：始终返回 示例： "us-west-2b"
db_instance_identifier 字符串	此DB快照创建自的DB实例的DB实例标识符。 返回：始终返回 示例： "hello-world-rds"
db_snapshot_arn 字符串	DB快照的Amazon资源名称(ARN)。 返回：始终返回 示例： "arn:aws:rds:us-west-2:123456789012:snapshot:rds:hello-world-rds-us1-2018-05-16-04-03"
db_snapshot_identifier 字符串	数据库快照标识符。 返回：始终返回 示例： "rds:hello-world-rds-us1-2018-05-16-04-03"
dbi_resource_id 字符串	源数据库实例的标识符，不可更改，在 Amazon Web Services 区域内唯一。 返回：始终返回 示例： "db-ABCDEFGHIJKLMNOPQRSTUVWXYZ"
dedicated_log_volume 布尔值	数据库实例是否启用了专用日志卷 (DLV)。 返回：始终返回 示例： false
encrypted 布尔值	数据库快照是否已加密。 返回：始终返回 示例： true
engine 字符串	数据库引擎的名称。 返回：始终返回 示例： "postgres"
engine_version 字符串	数据库引擎的版本。 返回：始终返回 示例： "9.5.10"
iam_database_authentication_enabled 布尔值	是否启用了Amazon Web Services身份和访问管理(IAM)帐户到数据库帐户的映射。 返回：始终返回 示例： false
instance_create_time 字符串	创建数据库实例（从中创建快照）的时间。 返回：始终返回 示例： "2017-10-10T04:00:07.434000+00:00"
iops 整数	快照创建时数据库实例的预配 IOPS（每秒 I/O 操作）值。 返回：始终返回 示例： 3000
kms_key_id 字符串	已加密的数据库快照的 Amazon Web Services KMS 密钥标识符。 返回：当 encrypted 为 true 时 示例： "arn:aws:kms:us-west-2:123456789012:key/abcd1234-1234-aaaa-0000-1234567890ab"
license_model 字符串	已恢复数据库实例的许可证模型信息。 返回：始终返回 示例： "postgresql-license"
master_username 字符串	数据库快照的主用户名。 返回：始终返回 示例： "dbadmin"
multi_tenant 布尔值	快照是使用多租户配置 (TRUE) 还是单租户配置 (FALSE) 的数据库实例。 返回：始终返回 示例： false
option_group_name 字符串	数据库快照的选项组名称。 返回：始终返回 示例： "default:postgres-9-5"
original_snapshot_create_time 字符串	CreateDBSnapshot 操作的时间。复制快照时不会更改。 返回：始终返回 示例： "2017-10-10T04:00:07.434000+00:00"
percent_progress 整数	已传输的估计数据的百分比。 返回：始终返回 示例： 100
port 整数	快照创建时数据库引擎正在侦听的端口。 返回：始终返回 示例： 0
snapshot_create_time 字符串	快照创建时间。 返回：始终返回 示例： "2018-05-16T04:03:33.871000+00:00"
snapshot_target 字符串	手动快照的存储位置：Amazon Web Services Outposts 或 Amazon Web Services 区域。 返回：始终返回 示例： "region"
snapshot_type 字符串	数据库快照的类型。 返回：始终返回 示例： "automated"
status 字符串	此数据库快照的状态。 返回：始终返回 示例： "available"
storage_throughput 整数	数据库快照的存储吞吐量。 返回：始终返回 示例： 500
storage_type 字符串	与数据库快照关联的存储类型。 返回：始终返回 示例： "gp2"
tags 复杂类型	快照的标签。 返回：快照未共享时。
vpc_id 字符串	与数据库快照关联的 VPC ID。 返回：始终返回 示例： "vpc-abcd1234"

作者

• Will Thames (@willthames)

集合链接

• 问题追踪器
• 代码库（源码）
• 沟通