amazon.aws.rds_cluster_snapshot 模块 – 管理 Amazon RDS 数据库集群快照

注意

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

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

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

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

amazon.aws 5.0.0 中的新增功能

概要

• 创建、修改和删除数据库集群的 RDS 快照。

• 此模块最初是在版本 4.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_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。
copy_tags 布尔值	是否将所有标签从 source_db_cluster_snapshot_identifier 复制到 db_cluster_snapshot_identifier。 选项 false ← (默认) true
db_cluster_identifier 别名：cluster_id, cluster_name 字符串	要为其创建快照的数据库集群的标识符。 当 state=present 时需要。
db_cluster_snapshot_identifier 别名：snapshot_id, id, snapshot_name 字符串 / 必需	数据库集群快照的标识符。
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 字符串	连接到非默认AWS端点的URL。虽然它可以用于连接到其他兼容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选项互斥。
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 ← (默认)
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选项互斥。 在5.1.0版本中添加了aws_secret_access_key别名，以与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选项互斥。 在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之后的一个版本中移除。
source_db_cluster_snapshot_identifier 别名: source_id, source_snapshot_id 字符串	要复制的DB集群快照的标识符。 如果源快照与副本位于相同的AWS区域，请指定快照的标识符。 如果源快照与副本位于不同的AWS区域，请指定快照的ARN。
source_region 字符串	包含要复制的快照的区域。
state 字符串	指定快照所需的狀態。 选项 "present" ← (默认) "absent"
tags 别名: resource_tags 字典	表示要应用于资源的标签的字典。 如果没有设置tags参数，则不会修改标签。
validate_certs 布尔值	设置为false时，将不会验证与AWS API通信的SSL证书。 强烈建议不要设置validate_certs=false，可以考虑改为设置aws_ca_bundle。 选项 false true ← (默认)
wait 布尔值	是否等待快照创建或删除。 选项 false ← (默认) true
wait_timeout 整数	wait放弃之前的等待时间（秒）。 默认值： 300

注释

注意

• 可以使用community.aws.rds_snapshot_info检索有关特定DB集群的信息或列出特定DB集群的DB集群快照。

• 警告：对于模块，环境变量和配置文件是从Ansible的“主机”上下文而不是“控制器”上下文读取的。因此，可能需要将文件显式复制到“主机”。对于查找和连接插件，环境变量和配置文件是从Ansible的“控制器”上下文而不是“主机”上下文读取的。

• Ansible使用的AWS SDK (boto3)也可能从其在Ansible“主机”上下文中的配置文件（通常为~/.aws/credentials）读取凭据和其他设置（例如区域）的默认值。有关更多信息，请参阅 https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html。

示例

- name: Create a DB cluster snapshot
  amazon.aws.rds_cluster_snapshot:
    db_cluster_identifier: "{{ cluster_id }}"
    db_cluster_snapshot_identifier: new-cluster-snapshot

- name: Delete a DB cluster snapshot
  amazon.aws.rds_cluster_snapshot:
    db_cluster_snapshot_identifier: new-cluster-snapshot
    state: absent

- name: Copy snapshot from a different region and copy its tags
  amazon.aws.rds_cluster_snapshot:
    id: new-database-snapshot-copy
    region: us-east-1
    source_id: "{{ snapshot.db_snapshot_arn }}"
    source_region: us-east-2
    copy_tags: true

返回值

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

键	描述
allocated_storage 整数	DB集群快照的已分配存储大小（以GiB为单位）。 返回：始终 示例： 0
availability_zone 字符串	创建快照的数据库的可用区。 返回：始终 示例： "us-west-2a"
cluster_create_time 字符串	创建DB集群的时间（协调世界时 (UTC)）。 返回：始终 示例： "2024-07-01T05:27:53.478000+00:00"
db_cluster_identifier 字符串	指定此DB集群快照创建自的DB集群的DB集群标识符。 返回：始终 示例： "ansible-test-16638696"
db_cluster_snapshot_arn 字符串	快照的Amazon资源名称。 返回：始终 示例： "arn:aws:rds:us-west-2:123456789012:snapshot:ansible-test-16638696-test-snapshot"
db_cluster_snapshot_identifier 字符串	指定DB集群快照的标识符。 返回：始终 示例： "ansible-test-16638696-test-snapshot"
engine 字符串	指定此DB集群快照的数据库引擎的名称。 返回：始终 示例： "aurora"
engine_mode 字符串	提供此DB集群快照的数据库引擎的引擎模式。 返回：始终 示例： "5.6.mysql_aurora.1.22.5"
engine_version 字符串	创建快照的集群的版本。 返回：始终 示例： "5.6.mysql_aurora.1.22.5"
iam_database_authentication_enabled 布尔值	是否启用了IAM数据库身份验证。 返回：始终 示例： false
kms_key_id 字符串	Amazon Web Services KMS密钥标识符是KMS密钥的密钥ARN、密钥ID、别名ARN或别名。 返回：始终
license_model 字符串	提供此DB集群快照的许可证模型信息。 返回：始终 示例： "general-public-license"
master_username 字符串	提供此DB集群快照的主用户名。 返回：始终 示例： "test"
percent_progress 整数	指定已传输的估计数据的百分比。 返回：始终 示例： 100
端口 整数	数据库监听的端口。 返回：始终 示例： 3306
snapshot_create_time 字符串	提供快照拍摄时间，采用协调世界时 (UTC)。 返回：始终 示例： "2019-06-15T10:46:23.776000+00:00"
snapshot_type 字符串	快照的创建方式（此模块始终为手动！）。 返回：始终 示例： "manual"
source_db_cluster_snapshot_arn 字符串	如果数据库集群快照是从源数据库集群快照复制的，则为源数据库集群快照的 ARN，否则为 null。 返回：始终
状态 字符串	指定此数据库集群快照的状态。 返回：始终 示例： "available"
storage_encrypted 布尔值	指定数据库集群快照是否已加密。 返回：始终 示例： false
tag_list 列表 / 元素=字符串	标签列表。 返回：始终 示例： [{"key": "tag_one", "value": "ansible-test-123456789012-rds-cluster-snapshot-b One"}]
标签 字典	应用于快照的标签。 返回：始终 示例： {"Tag Two": "two ansible-test-123456789012-rds-cluster-snapshot-b"}
vpc_id 字符串	数据库所在的 VPC 的 ID。 返回：始终 示例： "vpc-09ff232e222710ae0"

作者

• Alina Buzachis (@alinabuzachis)

资源链接

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