amazon.aws.backup_plan 模块 – 管理 AWS 备份计划

注意

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

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

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

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

amazon.aws 6.0.0 中的新增功能

概要

• 创建、更新或删除 AWS 备份计划。

• 有关更多信息，请参阅 AWS 备份计划文档 https://docs.aws.amazon.com/aws-backup/latest/devguide/about-backup-plans.html。

要求

执行此模块的主机需要以下要求。

• 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 之后的一个版本中移除。
advanced_backup_settings 列表 / 元素=字典	为每种资源类型指定高级备份设置列表。 这些设置仅适用于 Windows 卷影复制服务 (VSS) 备份作业。
backup_options 字典	指定所选资源的备份选项。 此选项仅适用于 Windows VSS 备份作业。
WindowsVSS 字符串	启用或禁用 WindowsVSS 备份选项。 选项 "enabled" "disabled"
resource_type 字符串	指定包含资源类型和备份选项的对象。 唯一支持的资源类型是具有 Windows 卷影复制服务 (VSS) 的 Amazon EC2 实例。 选项 "EC2"
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。
backup_plan_name 别名：name 字符串 / 必需	备份计划的显示名称。必须包含 1 到 50 个字母数字字符或“-._”字符。
creator_request_id 字符串	标识请求并允许重试失败的请求，而无需再次运行操作的风险。如果请求包含与现有备份计划匹配的 CreatorRequestId，则返回该计划。
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选项互斥。
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之后的一个版本中移除。
rules 列表 / 元素=字典	BackupRule 对象数组，每个对象都指定一个用于备份所选资源的计划任务。 当state=present时必填。
completion_window_minutes 整数	备份作业成功启动后，必须完成的分钟数，否则Backup将取消该作业。 如果未提供，AWS默认值为10080。 默认值： 10080
copy_actions 列表 / 元素=字典	copy_action 对象数组，其中包含复制操作的详细信息。
destination_backup_vault_arn 字符串 / 必需	唯一标识复制备份的目标备份保管库的Amazon资源名称 (ARN)。
lifecycle 字典	包含Transition 对象数组，指定恢复点转换到冷存储或被删除之前的时长（以天为单位）。 转换到冷存储的备份必须在冷存储中至少存储90天。因此，在控制台中，“保留”设置必须比“转换到冷存储后的天数”设置多90天。“转换到冷存储后的天数”设置在备份已转换到冷存储后无法更改。
delete_after_days 整数	指定恢复点创建后几天删除。必须大于90天加上rules.copy_actions.lifecycle.move_to_cold_storage_after_days。
move_to_cold_storage_after_days 整数	指定恢复点创建后几天移到冷存储。
enable_continuous_backup 布尔值	指定Backup是否创建连续备份。True表示Backup创建能够进行时间点恢复 (PITR) 的连续备份。False（或未指定）表示Backup创建快照备份。 如果未提供，AWS默认值为false。 选项 false ← (默认) true
lifecycle 字典	生命周期定义受保护资源何时转换为冷存储以及何时过期。Backup将根据您定义的生命周期自动转换和过期备份。 转换到冷存储的备份必须在冷存储中至少存储90天。因此，“保留”设置必须比“转换到冷存储后的天数”设置多90天。“转换到冷存储后的天数”设置在备份已转换到冷存储后无法更改。
delete_after_days 整数	指定恢复点创建后几天删除。必须大于90天加上rules.lifecycle.move_to_cold_storage_after_days。
move_to_cold_storage_after_days 整数	指定恢复点创建后几天移到冷存储。
recovery_point_tags 字典	为了帮助您组织资源，您可以为创建的资源分配您自己的元数据。
rule_name 字符串 / 必需	规则名称。
schedule_expression 字符串	指定Backup何时启动备份作业的UTC时间CRON表达式。如果未提供，则使用AWS默认值。 默认值： "cron(0 5 ? * * *)"
schedule_expression_timezone 字符串 在amazon.aws 7.3.0中添加	这是设置计划表达式的时区。 默认情况下，ScheduleExpressions使用UTC。您可以将其修改为指定的时区。 此选项需要botocore >= 1.31.36。 默认值： "Etc/UTC"
start_window_minutes 整数	在备份计划后，作业在未成功启动前将被取消的分钟数。如果包含此值，则必须至少为60分钟才能避免错误。 如果未提供，AWS默认值为480。 默认值： 480
target_backup_vault_name 字符串 / 必需	此规则应定位到的备份保管库的名称。
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选项互斥。 别名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之后的一个版本中移除。
state 字符串	创建/更新或删除备份计划。 选项 "present" ← (默认) "absent"
tags 别名：resource_tags, backup_plan_tags 字典	为了帮助您组织资源，您可以为创建的资源分配您自己的元数据。每个标签都是一个键值对。指定的标签将分配给使用此计划创建的所有备份。
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: Create an AWSbackup plan
  amazon.aws.backup_plan:
    state: present
    backup_plan_name: elastic
    rules:
      - rule_name: daily
        advanced_backup_settings:
          - resource_type: "EC2"
            backup_options:
              WindowsVSS: enabled
        target_backup_vault_name: "{{ backup_vault_name }}"
        schedule_expression: 'cron(0 5 ? * * *)'
        start_window_minutes: 60
        completion_window_minutes: 1440
- name: Delete an AWS Backup plan
  amazon.aws.backup_plan:
    backup_plan_name: elastic
    state: absent

返回值

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

键	描述
backup_plan 字典	备份计划详细信息。 返回： 在创建/更新时
advanced_backup_settings 列表 / 元素=字典	备份计划的高级备份设置。 返回： 当配置时。 示例： [{"backup_options": {"windows_vss": "enabled"}, "resource_type": "EC2"}]
backup_options 字典	高级设置的备份选项。 返回： 成功 示例： {"windows_vss": "enabled"}
resource_type 字符串	高级设置的资源类型。 返回： 成功 示例： "EC2"
backup_plan_name 字符串	备份计划的显示名称。 返回： 始终 示例： "elastic"
rules 列表 / 元素=字典	BackupRule 对象数组，每个对象都指定一个用于备份所选资源的计划任务。 返回： 始终
completion_window_minutes 整数	备份作业成功启动后，必须完成的分钟数，否则Backup将取消该作业。 返回： 始终 示例： 10080
copy_actions 列表 / 元素=字典	CopyAction 对象数组，包含复制操作的详细信息。 返回： 当配置时。 示例： [{"destination_backup_vault_arn": "arn:aws:backup:us-west-2:123456789012:backup-vault:my-test-vault", "lifecycle": {"delete_after_days": 100, "move_to_cold_storage_after_days": 10}}]
enable_continous_backup 布尔值	指定 Backup 是否创建连续备份。 返回： 始终 示例： false
lifecycle 字典	定义受保护资源何时转换为冷存储以及何时过期。 返回： 当配置时。 示例： {"delete_after_days": 100, "move_to_cold_storage_after_days": 10}
recovery_point_tags 字典	从备份还原时分配给与此规则关联的资源的键值对字符串数组。 返回： 当配置时。 示例： {"Tagkey1": "TagValue1", "Tagkey2": "TagValue2"}
rule_id 字符串	唯一标识用于安排对所选资源进行备份的规则。 返回： 始终 示例： "973621ef-d863-41ef-b5c3-9e943a64ad0c"
rule_name 字符串	备份规则的显示名称。 返回： 始终 示例： "daily"
schedule_expression 字符串	指定 Backup 何时启动备份作业的 UTC 时间的 cron 表达式。 返回： 始终 示例： "cron(0 5 ? * * *)"
schedule_expression_timezone 字符串 在amazon.aws 7.3.0中添加	这是设置计划表达式的时区。 此信息适用于 botocore 版本 >= 1.31.36。 返回： 当 botocore >= 1.31.36 时 示例： "Etc/UTC"
start_window_minutes 整数	在备份计划后，作业在未成功启动之前被取消之前的分钟数。 返回： 始终 示例： 480
target_backup_vault_name 字符串	存储备份的逻辑容器的名称。 返回： 始终 示例： "09da67966fd5-backup-vault"
tags 字符串	备份计划的标签。 返回： 在创建/更新时 示例： "{'TagKey1': 'TagValue1', 'TagKey2': 'TagValue2'}"
backup_plan_arn 字符串	备份计划的 ARN。 返回： 始终 示例： "arn:aws:backup:eu-central-1:111122223333:backup-plan:1111f877-1ecf-4d79-9718-a861cd09df3b"
backup_plan_id 字符串	备份计划的 ID。 返回： 始终 示例： "1111f877-1ecf-4d79-9718-a861cd09df3b"
backup_plan_name 字符串	备份计划的名称。 返回： 始终 示例： "elastic"
creation_date 字符串	备份计划的创建日期。 返回： 在创建/更新时 示例： "2023-01-24T10:08:03.193000+01:00"
deletion_date 字符串	备份计划被删除的日期。 返回： 在删除时 示例： "2023-05-05T16:24:51.987000-04:00"
exists 布尔值	资源是否存在。 返回： 始终 示例： true
version_id 字符串	备份计划的版本 ID。 返回： 始终 示例： "ODM3MjVjNjItYWFkOC00NjExLWIwZTYtZDNiNGI5M2I0ZTY1"

作者

• Kristof Imre Szabo (@krisek)

• Alina Buzachis (@alinabuzachis)

• Helen Bailey (@hakbailey)

集合链接

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