amazon.aws.rds_instance_snapshot 模块 – 管理 Amazon RDS 实例快照

注意

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

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

要安装它，请使用：ansible-galaxy collection install amazon.aws。您需要其他要求才能使用此模块，请参阅 要求 以了解详情。

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

amazon.aws 5.0.0 中的新增功能

摘要

• 创建或删除 RDS 快照。

• 此模块最初添加到 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 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。
copy_tags 布尔值 在 community.aws 3.3.0 中添加	是否将所有标签从 source_db_snapshot_identifier 复制到 db_instance_identifier。 选项 false ← (默认) true
db_instance_identifier 别名：instance_id 字符串	数据库实例标识符。创建快照时必需。
db_snapshot_identifier 别名：id，snapshot_id 字符串 / 必需	要管理的快照。
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 选项互斥。
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 选项互斥。 为了与 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 之后发布的版本中移除。
source_db_snapshot_identifier 别名: source_id, source_snapshot_id 字符串 在 community.aws 3.3.0 中添加	源数据库快照的标识符。 复制快照时需要。 如果源快照与副本位于同一 AWS 区域，请指定快照的标识符。 如果源快照与副本位于不同的 AWS 区域，请指定快照的 ARN。
source_region 字符串 在 community.aws 3.3.0 中添加	包含要复制的快照的区域。
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 整数	等待放弃之前的时长（以秒为单位）。 默认值： 300

注释

注意

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

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

示例

- name: Create snapshot
  amazon.aws.rds_instance_snapshot:
    db_instance_identifier: new-database
    db_snapshot_identifier: new-database-snapshot
  register: snapshot

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

- name: Delete snapshot
  amazon.aws.rds_instance_snapshot:
    db_snapshot_identifier: new-database-snapshot
    state: absent

返回值

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

键	描述
allocated_storage 整数	分配的存储空间（以 GB 为单位）。 返回：始终 示例： 20
availability_zone 字符串	创建快照的数据库的可用区。 返回：始终 示例： "us-west-2a"
db_instance_identifier 字符串	创建快照的数据库。 返回：始终 示例： "ansible-test-16638696"
db_snapshot_arn 字符串	快照的 Amazon 资源名称。 返回：始终 示例： "arn:aws:rds:us-west-2:123456789012:snapshot:ansible-test-16638696-test-snapshot"
db_snapshot_identifier 字符串	快照的名称。 返回：始终 示例： "ansible-test-16638696-test-snapshot"
dbi_resource_id 字符串	源数据库实例的标识符，它不能更改，并且对于 AWS 区域是唯一的。 返回：始终 示例： "db-MM4P2U35RQRAMWD3QDOXWPZP4U"
encrypted 布尔值	快照是否已加密。 返回：始终 示例： false
engine 字符串	创建快照的数据库的引擎。 返回：始终 示例： "mariadb"
engine_version 字符串	创建快照的数据库的版本。 返回：始终 示例： "10.2.21"
iam_database_authentication_enabled 布尔值	IAM 数据库身份验证是否已启用。 返回：始终 示例： false
instance_create_time 字符串	创建快照的实例的创建时间。 返回：始终 示例： "2019-06-15T10:15:56.221000+00:00"
license_model 字符串	数据库的许可证模型。 返回：始终 示例： "general-public-license"
master_username 字符串	数据库的主用户名。 返回：始终 示例： "test"
option_group_name 字符串	数据库的选项组。 返回：始终 示例： "default:mariadb-10-2"
percent_progress 整数	拍摄快照的进度。可用快照将为 100。 返回：始终 示例： 100
port 整数	数据库侦听的端口。 返回：始终 示例： 3306
processor_features 列表 / 元素=字符串	数据库的处理器特性列表。 返回：始终 示例： []
snapshot_create_time 字符串	快照的创建时间。 返回：始终 示例： "2019-06-15T10:46:23.776000+00:00"
snapshot_type 字符串	快照的创建方式（对于此模块始终为手动！）。 返回：始终 示例： "manual"
source_db_snapshot_identifier 字符串 在 community.aws 3.3.0 中添加	数据库快照复制来源的快照 ARN。 返回： 快照为副本时 示例： "arn:aws:rds:us-west-2:123456789012:snapshot:ansible-test-16638696-test-snapshot-source"
状态 字符串	快照的状态。 返回：始终 示例： "available"
存储类型 字符串	数据库的存储类型。 返回：始终 示例： "gp2"
标签 复杂	应用于快照的标签。 返回：始终
VPC ID 字符串	数据库所在的 VPC 的 ID。 返回：始终 示例： "vpc-09ff232e222710ae0"

作者

• Will Thames (@willthames)

• Michael De La Rue (@mikedlr)

• Alina Buzachis (@alinabuzachis)

• Joseph Torcasso (@jatorcasso)

资源链接

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