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 快照信息。
此模块最初在 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_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` 回调输出 playbook 期间的总列表。也可以使用 `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_secret_access_key 别名在 5.1.0 版本中添加，与 AWS botocore SDK 保持一致。 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 之后的版本中删除。
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 列表 / 元素=字符串	可以在其中还原数据库集群快照中的实例的可用区 (AZ) 列表。返回: 始终示例: `["ca-central-1a", "ca-central-1b"]`
cluster_create_time 字符串	创建数据库集群的时间。返回: 始终示例: `"2018-05-17T00:13:40.223000+00:00"`
db_cluster_identifier 字符串	此数据库集群快照从中创建的数据库集群的数据库集群标识符。返回: 始终示例: `"test-aurora-cluster"`
db_cluster_resource_id 字符串	此数据库集群快照从中创建的数据库集群的资源 ID。返回: 始终示例: `"cluster-ABCDEFGHIJKLMNOPQRSTUVWXYZ"`
db_cluster_snapshot_arn 字符串	数据库集群快照的 Amazon 资源名称 (ARN)。6 返回: 始终示例: `"arn:aws:rds:ca-central-1:123456789012:cluster-snapshot:test-aurora-snapshot"`
db_cluster_snapshot_identifier 字符串	数据库集群快照的标识符。返回: 始终示例: `"test-aurora-snapshot"`
engine 字符串	此数据库集群快照的数据库引擎的名称。返回: 始终示例: `"aurora"`
engine_mode 字符串	此数据库集群快照的数据库引擎的引擎模式。返回: 始终示例: `"provisioned"`
engine_version 字符串	此数据库集群快照的数据库引擎的版本。返回: 始终示例: `"5.6.10a"`
iam_database_authentication_enabled 布尔值	是否启用了将 Amazon Web Services Identity and Access Management (IAM) 账户映射到数据库账户。返回: 始终示例: `false`
kms_key_id 字符串	加密的数据库集群快照的 Amazon Web Services KMS 密钥标识符。返回: 当 storage_encrypted 为 true 时示例: `"arn:aws:kms:us-west-2:123456789012:key/abcd1234-1234-aaaa-0000-1234567890ab"`
license_model 字符串	此数据库集群快照的许可模式信息。返回: 始终示例: `"aurora"`
master_username 字符串	此数据库集群快照的主用户名。返回: 始终示例: `"shertel"`
percent_progress 整数	已传输的估计数据的百分比。返回: 始终示例: `0`
port 整数	快照时数据库集群正在监听的端口。返回: 始终示例: `0`
snapshot_create_time 字符串	拍摄快照的时间。返回: 始终示例: `"2018-05-17T00:23:23.731000+00:00"`
snapshot_type 字符串	数据库集群快照的类型。返回: 始终示例: `"manual"`
status 字符串	此数据库集群快照的状态。返回: 始终示例: `"creating"`
storage_encrypted 布尔值	指示数据库集群快照是否已加密。返回: 始终示例: `true`
tags 复杂	快照的标签。返回: 当快照未共享时。
vpc_id 字符串	与数据库集群快照关联的 VPC ID。返回: 始终示例: `"vpc-abcd1234"`
snapshots 复杂	非集群快照的列表。返回: 当未传递集群参数时。
allocated_storage 整数	以吉比字节 (GiB) 为单位的分配存储大小。返回: 始终示例: `10`
availability_zone 字符串	数据库快照创建时，数据库实例所在的可用区名称。返回: 始终示例: `"us-west-2b"`
db_instance_identifier 字符串	创建此数据库快照的数据库实例的数据库实例标识符。返回: 始终示例: `"hello-world-rds"`
db_snapshot_arn 字符串	数据库快照的 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 Identity and Access Management (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)